apm resource remote-desktop citrix

apm resource remote-desktop ciBIG-IP)TMSHapmnresource remote-desktop citrix(1)



NAME
       citrix - Configures a Citrix remote desktop resource configuration
       object.

MODULE
       apm resource remote-desktop

SYNTAX
       Configure the citrix component within the resource remote desktop
       module using the syntax shown in the following sections.

   CREATE/MODIFY
	create citrix [name]
	modify citrix [name]
	  options:
	    app-service [[string] | none]
	    auto-logon [enabled | disabled]
	    customization-group [add | delete | modify | replace-all-with] {
	      [name] {
		options:
		  caption [[string] | none]
		  detailed-description [[string] | none]
	       }
	    }
	    description [[string] | none]
	    domain-source [session.logon.last.domain | none]
	    enable-serverside-ssl [enabled | disabled]
	    pool [pool name]
	    host [fqdn]
	    ip [ip address]
	    location-specific [true | false]
	    password-source [session.logon.last.password | none]
	    port [[string] | none]
	    username-source [session.logon.last.username | none]

	edit citrix [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list citrix
	list citrix [ [ [name] | [glob] | [regex] ] ... ]
	show running-config citrix
	show running-config citrix [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

	show citrix
	show citrix [name]

   DELETE
	delete citrix [name]

DESCRIPTION
	You can use the B component to configure a Citrix remote desktop resource.

EXAMPLES
       create citrix mycitrix { ip 172.29.67.130 }
	    Creates a Citrix remote desktop resource named mycitrix with
	    Citrix XML Broker server specified as IP address 172.29.67.130.

       create citrix mycitrix { host mycitrix.mycompany.com auto-logon enabled
       }
	    Creates a Citrix resource with Citrix XML Broker server specified
	    as hostname mycitrix.mycompany.com and auto-logon enabled with APM
	    credentials (that user types on Logon Page).

       create citrix mycitrix { pool /Common/mycitrix-pool enable-serverside-
       ssl enabled }
	    Creates a Citrix resource with Citrix XML Broker server(s)
	    specified in pool named /Common/mycitrix-pool and SSL
	    communication enabled to the server(s) (SSL should also be enabled
	    on the servers and APM virtual should have serverssl profile).

OPTIONS
       app-service
	    Specifies the name of the application service to which the object
	    belongs. The default value is none. Note: If the strict-updates
	    option is enabled on the application service that owns the object,
	    you cannot modify or delete the object. Only the application
	    service can modify or delete the object.

       auto-logon
	    Enables or disables automatic log on to the Citrix server. If you
	    enable this option, you must also provide values for the username-
	    source, password-source, and domain-source options. The default is
	    disabled.

       customization-group
	    Specifies whether customization groups are applied to the Citrix
	    remote desktop. You can add, modify, or delete customization
	    groups. You can also replace all current customization groups with
	    new customization groups. The default is none.

       description
	    Specifies a description for your Citrix remote desktop. The
	    default is none.

       domain-source
	    Specifies the Session variable used as a source for the auto-logon
	    user password. The default is session.logon.last.domain.

       enable-serverside-ssl
	    Enables or disables SSL capabilities between the BIG-IP system and
	    the Citrix server. When enabled, the port number automatically
	    changes to 443. The default is disabled.

       pool Specifies the pool name that contains your Citrix XML Broker
	    server(s). You must use one of these options to specify the server
	    address: pool, host, or ip.

       host Specifies the hostname of your Citrix XML Broker server. You must
	    use one of these options to specify the server address: pool,
	    host, or ip.

       ip   Specifies the IP address of your Citrix XML Broker server. You
	    must use one of these options to specify the server address: pool,
	    host, or ip.

       location-specific
	    Specifies whether or not this object contains one or more
	    attributes with values that are specific to the location where the
	    BIG-IP device resides. The location-specific attribute is either
	    true or false. When using policy sync, mark an object as location-
	    specific to prevent errors that can occur when policies reference
	    objects, such as authentication servers, that are specific to a
	    certain location.

       [name]
	    Specifies an object name. This option is required; however, the
	    parameter name is implicit and must not be typed in the syntax.

       password-source
	    Specifies the session variable that is used as a source for the
	    auto-logon password. The default is session.logon.last.password.

       port Specifies the port for your Citrix server. The default is 80.

       username-source
	    Specifies the session variable that is used as a source for the
	    auto-logon user name. The default is session.logon.last.username.

SEE ALSO
       citrix-client-bundle, citrix-client-package-file, rdp, vmware-view,
       quest

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or
       by any means, electronic or mechanical, including photocopying,
       recording, or information storage and retrieval systems, for any
       purpose other than the purchaser's personal use, without the express
       written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2011-2013. All rights reserved.



BIG-IP				  2013-06apm resource remote-desktop citrix(1)