apm resource remote-desktop rdp
apm resource remote-desktop rdBIG-IP TMSH Maapmlresource 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:
acl-order [[integer] | none]
application [[string] | none]
app-service [[string] | none]
auto-logon [enabled | disabled]
color-depth [4 | 8 | 16 | 24]
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]
java-client [enabled | disabled]
native-client [enabled | disabled]
location-specific [true | false]
log [config | none | packet | summary | verbose]
password-source [session.logon.last.password | none]
port [[integer] | none]
rdp-cache-bitmaps [true | false]
rdp-show-contents-while-dragging [true | false]
rdp-show-desktop-wallpaper [true | false]
rdp-show-themes [true | false]
rdp-window-animations [true | false]
redirect-com-parts [true | false]
redirect-drives [true | false]
redirect-keyboard-commands [true | false]
redirect-printers [true | false]
redirect-sound [true | false]
username-source [session.logon.last.username | none]
window-height [[integer] | none]
window-percent-of-desktop [[integer] | none]
window-size [custom-size | full-screen | percent-of-desktop | seamless]
window-width [[integer] | none]
work-dir [[string] | 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
acl-order
Specifies the order in which you want the RDP server to appear in
the ACL Order list. The default is 0 (zero).
application
Specifies the executable name of the application, for example
notepad.exe. You can include the full path to the application, for
example "C:\my\mybinary.exe".
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.
color-depth
Specifies the requested remote session color depth. The default is
32. The options are:
24-bit
16-bit
8-bit
4-bit
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.
java-client
Specifies whether to use Java RDP client to launch this resource.
The default is disabled.
native-client
Specifies whether to use native RDP client to launch this
resource. The default is disabled. java-client and native-client
can't be enabled at the same time. When both java-client and
native-client are disabled, RDP resource is launched using ActiveX
control.
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.
log Specifies the log format. The default is none. The options are:
config
none The system does not log packets sent to and from the
Microsoft RDP server.
packet
The system logs packets sent to and from the Microsoft DP
server.
summary
The system provides a short summary of the communications
between the BIG-IP system and the Microsoft RDP server.
verbose
The system provides an extensive summary of the
communications between the BIG-IP system and the Microsoft
RDP server.
[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).
rdp-cache-bitmaps
Specifies whether to cache bitmap files on the client. The default
is true.
rdp-show-contents-while-dragging
Specifies whether to show the contents of a window when the user
is dragging the window. The default is false.
rdp-show-desktop-wallpaper
Specifies whether to display the desktop background. The default
is false.
rdp-show-themes
Specifies whether to display the desktop theme. The default is
false.
rdp-window-animations
Specifies whether to display Window animations. The default is
false.
redirect-com-ports
Specifies whether to connect to your communication ports. The
default is false.
redirect-drives
Specifies whether to connect to your local drives. The default is
false.
redirect-keyboard-commands
Specifies when to redirect keyboard commands to a remote session.
When enabled, commands such as Alt-tab and Ctrl-Alt-Del are
available in remote sessions. The default is in-full-screen. The
options are:
enable
The keyboard commands for the remote desktop are available to
the user.
disable
The keyboard commands for the remote desktop are not
available to the user.
in-full-screen
The keyboard commands for the remote desktop are available to
the user only when the value of the window-size option is
full-screen.
redirect-printers
Enables or disables connection to a local printer. The default is
disabled.
redirect-sound
Enables or disables sounds playing in a remote session. The
default is disabled.
username-source
Specifies the session variable used as a source for the auto-logon
user name. The default is session.logon.last.username.
window-height
Specifies the height, in pixels, of the remote desktop window. Set
this option only when you set the value of the window-size option
to custom. The default is 600 pixels.
window-percent-of-desktop
Specifies the width and height of the remote session window as a
percentage of the user's desktop.
window-size
Specifies the type of window sizing to use on the client desktop.
The default is custom-size.
The options are:
full-screen
The remote desktop window fills the entire screen.
percent-of-desktop
The value you configure represents a percentage of the screen
that the remote desktop fills.
custom
When you use this option, you must also set the window-height
and window-width options.
seamless
window-width
Specifies the width, in pixels, of the remote desktop window. The
default is 800 pixels.
workdir
Specifies the directory you want the user to access on the target
server. The default is none.
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 2015-08-10apm resource remote-desktop rdp(1)