rdp-clientprofile¶
The following operations can be performed on "rdp-clientprofile":
add rdp clientprofile¶
Add an rdp profile.
Synopsis¶
add rdp clientprofile <name> [-rdpUrlOverride ( ENABLE | DISABLE )] [-redirectClipboard ( ENABLE | DISABLE )] [-redirectDrives ( ENABLE | DISABLE )] [-redirectPrinters ( ENABLE | DISABLE )] [-redirectComPorts ( ENABLE | DISABLE )] [-redirectPnpDevices ( ENABLE | DISABLE )] [-keyboardHook <keyboardHook>] [-audioCaptureMode ( ENABLE | DISABLE )] [-videoPlaybackMode ( ENABLE | DISABLE )] [-multiMonitorSupport ( ENABLE | DISABLE )] [-rdpCookieValidity <positive_integer>] [-addUserNameInRdpFile ( YES | NO )] [-rdpFileName <string>] [-rdpHost <string>] [-rdpListener <string>] [-rdpCustomParams <string>] [-psk ] [-randomizeRDPFilename ( YES | NO )] [-rdpLinkAttribute <string>]
Arguments¶
name
The name of the rdp profile
rdpUrlOverride
This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectClipboard
This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectDrives
This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
redirectPrinters
This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectComPorts
This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
redirectPnpDevices
This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
keyboardHook
This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.
Possible values: OnLocal, OnRemote, InFullScreenMode Default value: InFullScreenMode
audioCaptureMode
This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
videoPlaybackMode
This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.
Possible values: ENABLE, DISABLE Default value: ENABLE
multiMonitorSupport
Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).
Possible values: ENABLE, DISABLE Default value: ENABLE
rdpCookieValidity
RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over. Default value: 60 Minimum value: 1 Maximum value: 86400
addUserNameInRdpFile
Add username in rdp file.
Possible values: YES, NO Default value: NO
rdpFileName
RDP file name to be sent to End User
rdpHost
Fully-qualified domain name (FQDN) of the RDP Listener.
rdpListener
IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port
rdpCustomParams
Option for RDP custom parameters settings (if any). Custom params needs to be separated by '&' Default value: 0
psk
Pre shared key value Default value: 0
randomizeRDPFilename
Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format <rdpfileName>_<time>.rdp. This tries to avoid the pop-up for replacement of existing rdp file during each rdp connection launch, hence providing better end-user experience.
Possible values: YES, NO Default value: NO
rdpLinkAttribute
Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user. Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.
set rdp clientprofile¶
Modifies the specified parameters for RDP profile.
Synopsis¶
set rdp clientprofile <name> [-rdpUrlOverride ( ENABLE | DISABLE )] [-redirectClipboard ( ENABLE | DISABLE )] [-redirectDrives ( ENABLE | DISABLE )] [-redirectPrinters ( ENABLE | DISABLE )] [-redirectComPorts ( ENABLE | DISABLE )] [-redirectPnpDevices ( ENABLE | DISABLE )] [-keyboardHook <keyboardHook>] [-audioCaptureMode ( ENABLE | DISABLE )] [-videoPlaybackMode ( ENABLE | DISABLE )] [-multiMonitorSupport ( ENABLE | DISABLE )] [-rdpCookieValidity <positive_integer>] [-addUserNameInRdpFile ( YES | NO )] [-rdpFileName <string>] [-rdpHost <string>] [-rdpListener <string>] [-rdpCustomParams <string>] [-psk ] [-randomizeRDPFilename ( YES | NO )] [-rdpLinkAttribute <string>]
Arguments¶
name
The name of the rdp profile
rdpUrlOverride
This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectClipboard
This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectDrives
This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
redirectPrinters
This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: ENABLE
redirectComPorts
This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
redirectPnpDevices
This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
keyboardHook
This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.
Possible values: OnLocal, OnRemote, InFullScreenMode Default value: InFullScreenMode
audioCaptureMode
This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.
Possible values: ENABLE, DISABLE Default value: DISABLE
videoPlaybackMode
This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.
Possible values: ENABLE, DISABLE Default value: ENABLE
multiMonitorSupport
Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).
Possible values: ENABLE, DISABLE Default value: ENABLE
rdpCookieValidity
RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over. Default value: 60 Minimum value: 1 Maximum value: 86400
addUserNameInRdpFile
Add username in rdp file.
Possible values: YES, NO Default value: NO
rdpFileName
RDP file name to be sent to End User
rdpHost
Fully-qualified domain name (FQDN) of the RDP Listener.
rdpListener
IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port
rdpCustomParams
Option for RDP custom parameters settings (if any). Custom params needs to be separated by '&' Default value: 0
psk
Pre shared key value Default value: 0
randomizeRDPFilename
Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format <rdpfileName>_<time>.rdp. This tries to avoid the pop-up for replacement of existing rdp file during each rdp connection launch, hence providing better end-user experience.
Possible values: YES, NO Default value: NO
rdpLinkAttribute
Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user. Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.
unset rdp clientprofile¶
Use this command to remove rdp clientprofile settings.Refer to the set rdp clientprofile command for meanings of the arguments.
Synopsis¶
unset rdp clientprofile <name> [-rdpUrlOverride] [-redirectClipboard] [-redirectDrives] [-redirectPrinters] [-redirectComPorts] [-redirectPnpDevices] [-keyboardHook] [-audioCaptureMode] [-videoPlaybackMode] [-multiMonitorSupport] [-rdpCookieValidity] [-addUserNameInRdpFile] [-rdpFileName] [-rdpHost] [-rdpListener] [-rdpCustomParams] [-psk] [-randomizeRDPFilename] [-rdpLinkAttribute]
show rdp clientprofile¶
Display all rdp profiles
Synopsis¶
show rdp clientprofile [<name>]
Arguments¶
name
The name of the rdp profile
Output¶
rdpUrlOverride
This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.
redirectClipboard
This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.
redirectDrives
This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.
redirectPrinters
This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.
redirectComPorts
This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.
redirectPnpDevices
This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.
keyboardHook
This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.
audioCaptureMode
This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.
videoPlaybackMode
This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.
multiMonitorSupport
Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).
rdpCookieValidity
RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over.
addUserNameInRdpFile
Add username in rdp file.
rdpFileName
RDP file name to be sent to End User
rdpHost
Fully-qualified domain name (FQDN) of the RDP Listener.
rdpListener
IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port
rdpCustomParams
Option for RDP custom parameters settings (if any). Custom params needs to be separated by '&'
psk
Pre shared key value
randomizeRDPFilename
Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format <rdpfileName>_<time>.rdp. This tries to avoid the pop-up for replacement of existing rdp file during each rdp connection launch, hence providing better end-user experience.
rdpLinkAttribute
Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user. Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.
builtin
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
feature
The feature to be checked while applying this config
devno
count
stateflag
Example¶
show rdp profile
rm rdp clientprofile¶
Remove an rdp profile
Synopsis¶
rm rdp clientprofile <name>
Arguments¶
name
The name of the rdp profile.
Example¶
rm rdp profile