Skip to content

rdpclientprofile

Configuration for RDP clientprofile resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeThe name of the rdp profile.
Minimum length = 1
rdpurloverride<String>Read-writeThis setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.
Default value: ENABLE
Possible values = ENABLE, DISABLE
redirectclipboard<String>Read-writeThis setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.
Default value: ENABLE
Possible values = ENABLE, DISABLE
redirectdrives<String>Read-writeThis setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.
Default value: DISABLE
Possible values = ENABLE, DISABLE
redirectprinters<String>Read-writeThis setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.
Default value: ENABLE
Possible values = ENABLE, DISABLE
redirectcomports<String>Read-writeThis setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.
Default value: DISABLE
Possible values = ENABLE, DISABLE
redirectpnpdevices<String>Read-writeThis setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.
Default value: DISABLE
Possible values = ENABLE, DISABLE
keyboardhook<String>Read-writeThis setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.
Default value: InFullScreenMode
Possible values = OnLocal, OnRemote, InFullScreenMode
audiocapturemode<String>Read-writeThis setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.
Default value: DISABLE
Possible values = ENABLE, DISABLE
videoplaybackmode<String>Read-writeThis setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.
Default value: ENABLE
Possible values = ENABLE, DISABLE
multimonitorsupport<String>Read-writeEnable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).
Default value: ENABLE
Possible values = ENABLE, DISABLE
rdpcookievalidity<Double>Read-writeRDP 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<String>Read-writeAdd username in rdp file.
Default value: NO
Possible values = YES, NO
rdpfilename<String>Read-writeRDP file name to be sent to End User.
Minimum length = 1
rdphost<String>Read-writeFully-qualified domain name (FQDN) of the RDP Listener.
Maximum length = 252
rdplistener<String>Read-writeIP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port.
Maximum length = 255
rdpcustomparams<String>Read-writeOption for RDP custom parameters settings (if any). Custom params needs to be separated by ';'.
Default value: 0
Minimum length = 1
psk<String>Read-writePre shared key value.
Default value: 0
randomizerdpfilename<String>Read-writeWill 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.
Default value: NO
Possible values = YES, NO
rdplinkattribute<String>Read-writeCitrix 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.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| UPDATE| UNSET| DELETE| GET (ALL)| GET| COUNT

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the Citrix ADC appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note:In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"rdpclientprofile":{
<b>"name":<String_value>,
</b>"rdpurloverride":<String_value>,
"redirectclipboard":<String_value>,
"redirectdrives":<String_value>,
"redirectprinters":<String_value>,
"redirectcomports":<String_value>,
"redirectpnpdevices":<String_value>,
"keyboardhook":<String_value>,
"audiocapturemode":<String_value>,
"videoplaybackmode":<String_value>,
"multimonitorsupport":<String_value>,
"rdpcookievalidity":<Double_value>,
"addusernameinrdpfile":<String_value>,
"rdpfilename":<String_value>,
"rdphost":<String_value>,
"rdplistener":<String_value>,
"rdpcustomparams":<String_value>,
"psk":<String_value>,
"randomizerdpfilename":<String_value>,
"rdplinkattribute":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"rdpclientprofile":{
<b>"name":<String_value>,
</b>"rdpurloverride":<String_value>,
"redirectclipboard":<String_value>,
"redirectdrives":<String_value>,
"redirectprinters":<String_value>,
"redirectcomports":<String_value>,
"redirectpnpdevices":<String_value>,
"keyboardhook":<String_value>,
"audiocapturemode":<String_value>,
"videoplaybackmode":<String_value>,
"multimonitorsupport":<String_value>,
"rdpcookievalidity":<Double_value>,
"addusernameinrdpfile":<String_value>,
"rdpfilename":<String_value>,
"rdphost":<String_value>,
"rdplistener":<String_value>,
"rdpcustomparams":<String_value>,
"psk":<String_value>,
"randomizerdpfilename":<String_value>,
"rdplinkattribute":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"rdpclientprofile":{
<b>"name":<String_value>,
</b>"rdpurloverride":true,
"redirectclipboard":true,
"redirectdrives":true,
"redirectprinters":true,
"redirectcomports":true,
"redirectpnpdevices":true,
"keyboardhook":true,
"audiocapturemode":true,
"videoplaybackmode":true,
"multimonitorsupport":true,
"rdpcookievalidity":true,
"addusernameinrdpfile":true,
"rdpfilename":true,
"rdphost":true,
"rdplistener":true,
"rdpcustomparams":true,
"psk":true,
"randomizerdpfilename":true,
"rdplinkattribute":true
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile/name_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of rdpclientprofile resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?pagesize=#no;pageno=#no

Use this query-parameter to get the rdpclientprofile resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "rdpclientprofile": [ {
"name":<String_value>,
"rdpurloverride":<String_value>,
"redirectclipboard":<String_value>,
"redirectdrives":<String_value>,
"redirectprinters":<String_value>,
"redirectcomports":<String_value>,
"redirectpnpdevices":<String_value>,
"keyboardhook":<String_value>,
"audiocapturemode":<String_value>,
"videoplaybackmode":<String_value>,
"multimonitorsupport":<String_value>,
"rdpcookievalidity":<Double_value>,
"addusernameinrdpfile":<String_value>,
"rdpfilename":<String_value>,
"rdphost":<String_value>,
"rdplistener":<String_value>,
"rdpcustomparams":<String_value>,
"psk":<String_value>,
"randomizerdpfilename":<String_value>,
"rdplinkattribute":<String_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile/name_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile/name_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "rdpclientprofile": [ {
"name":<String_value>,
"rdpurloverride":<String_value>,
"redirectclipboard":<String_value>,
"redirectdrives":<String_value>,
"redirectprinters":<String_value>,
"redirectcomports":<String_value>,
"redirectpnpdevices":<String_value>,
"keyboardhook":<String_value>,
"audiocapturemode":<String_value>,
"videoplaybackmode":<String_value>,
"multimonitorsupport":<String_value>,
"rdpcookievalidity":<Double_value>,
"addusernameinrdpfile":<String_value>,
"rdpfilename":<String_value>,
"rdphost":<String_value>,
"rdplistener":<String_value>,
"rdpcustomparams":<String_value>,
"psk":<String_value>,
"randomizerdpfilename":<String_value>,
"rdplinkattribute":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rdpclientprofile?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "rdpclientprofile": [ { "__count": "#no"} ] }