rdpserverprofile

Last published : Oct 30, 2026
Configuration for RDP serverprofile resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
name <String> Read-write The name of the rdp server profile.
Minimum length = 1
Maximum length = 32
rdpip <String> Read-write IPv4 or IPv6 address of RDP listener. This terminates client RDP connections.
Minimum length = 1
rdpport <Integer> Read-write TCP port on which the RDP connection is established.
Default value: 3389
Minimum value = 1
Maximum value = 65535
psk <String> Read-write Pre shared key value.
rdpredirection <String> Read-write Enable/Disable RDP redirection support. This needs to be enabled in presence of connection broker or session directory with IP cookie(msts cookie) based redirection support.
Default value: DISABLE
Possible values = ENABLE, DISABLE
builtin <String[]> Read-only Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT
  • DELETE
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 NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /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 NetScaler 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 red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"rdpserverprofile":{
<b>"name":<String_value>,
</b>"rdpip":<String_value>,
"rdpport":<Integer_value>,
<b>"psk":<String_value>,
</b>"rdpredirection":<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 NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"rdpserverprofile":{
<b>"name":<String_value>,
</b>"rdpip":<String_value>,
"rdpport":<Integer_value>,
"psk":<String_value>,
"rdpredirection":<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 NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"rdpserverprofile":{
<b>"name":<String_value>,
</b>"rdpip":true,
"rdpport":true,
"psk":true,
"rdpredirection":true
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile/ 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 NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of rdpserverprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? view=summary
Use this query-parameter to get the summary output of rdpserverprofile resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the rdpserverprofile 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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "rdpserverprofile": [ {
"name":<String_value>,
"rdpip":<String_value>,
"rdpport":<Integer_value>,
"psk":<String_value>,
"rdpredirection":<String_value>,
"builtin":<String[]_value>,
"feature":<String_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of rdpserverprofile resources configured on NetScaler.
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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{  "rdpserverprofile": [ {
"name":<String_value>,
"rdpip":<String_value>,
"rdpport":<Integer_value>,
"psk":<String_value>,
"rdpredirection":<String_value>,
"builtin":<String[]_value>,
"feature":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/rdpserverprofile? 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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "rdpserverprofile": [ { "__count": "#no"} ] }