apm resource remote-desktop rdp

apm resource remote-desktop rdp(1)		  BIG-IP TMSH Manual		   apm resource remote-desktop rdp(1)

NAME
       rdp - Configures a Microsoft Remote Desktop Protocol (MSRDP) configuration object.

MODULE
       apm resource remote-desktop

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

   CREATE/MODIFY
	create rdp [name]
	modify rdp [name]
	  options:
	    app-service [[string] | none]
	    auto-logon [enabled | disabled]
	    customization-group [add | delete | modify | replace-all-with] {
	      [name] {
		options:
		  app-service [[string] | none]
		  caption [[string] | none]
		  detailed-description [[string] | none]
	       }
	    }
	    description [[string] | none]
	    domain-source [session.logon.last.domain | none]
	    host [fqdn]
	    ip [ip address]
	    location-specific [true | false]
	    password-source [session.logon.last.password | none]
	    port [[integer] | none]
	    username-source [session.logon.last.username | none]
	edit rdp [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

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

	show rdp
	show rdp [name]

   DELETE
	delete rdp [name]

DESCRIPTION
       You can use the rdp component to configure an MSRDP resource.

EXAMPLES
       create rdp myrdp { host 172.29.67.130 }
	    Creates a MSRDP remote desktop resource named myrdp with an MSRDP server with an IP address of
	    172.29.67.130.

       create rdp myrdp { host 172.29.67.130 rdp-cache-bitmaps true }
	    Creates a MSRDP remote desktop resource named myrdp with an MSRDP server with an IP address of
	    172.29.67.130 where bitmaps are cached on the client PC.

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
	    Specifies if automatic log on to the Microsoft RDP server is used. 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 remote desktop. You can add, modify, delete, or
	    replace all customization-groups. The default is none.

       description
	    Specifies a description of an MSRDP resource. 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.

       host Specifies the hostname of your Microsoft RDP server. Either the host or ip option is required; however,
	    you cannot specify both options.

       ip   Specifies the IP address of your Microsoft RDP server. Either the host or ip option is required; however,
	    you cannot specify both options.

       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 used as a source for the auto-logon password. The default is
	    session.logon.last.password.

       port Specify port 3389 for your Microsoft RDP server. The default is 0 (zero).

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

SEE ALSO
       citrix, citrix-client-bundle, citrix-client-package-file, 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						      2019-08-19		   apm resource remote-desktop rdp(1)