Skip to content
Was this article helpful?


Configuration for Citrix ADC Mode resource.


(click to see Operations )

Name Data Type Permissions Description
rise_rhi <Boolean> Read-write true, if rise_rhi feature is enabled.
sradv <Boolean> Read-write true, if sradv feature is enabled.
pmtud <Boolean> Read-write true, if pmtud feature is enabled.
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
dradv <Boolean> Read-write true, if dradv feature is enabled.
tcpb <Boolean> Read-write true, if tcpb feature is enabled.
fr <Boolean> Read-write true, if fr feature is enabled.
dradv6 <Boolean> Read-write true, if dradv6 feature is enabled.
edge <Boolean> Read-write true, if edge feature is enabled.
usnip <Boolean> Read-write true, if usnip feature is enabled.
bridgebpdus <Boolean> Read-write true, if bridgebpdus feature is enabled.
cka <Boolean> Read-write true, if cka feature is enabled.
ulfd <Boolean> Read-write true, if ulfd feature is enabled.
rise_apbr <Boolean> Read-write true, if rise_apbr feature is enabled.
sradv6 <Boolean> Read-write true, if sradv6 feature is enabled.
ns_ip_address_arr <String[]> Read-write List of Citrix ADC IP Addresses.

Minimum length = 1

Maximum length = 64
mbf <Boolean> Read-write true, if mbf feature is enabled.
l3 <Boolean> Read-write true, if l3 feature is enabled.
l2 <Boolean> Read-write true, if l2 feature is enabled.
mediaclassification <Boolean> Read-write true, if mediaclassification feature is enabled.
iradv <Boolean> Read-write true, if iradv feature is enabled.
usip <Boolean> Read-write true, if usip feature is enabled.


(click to see Properties )

  • GET (ALL)

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>


Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_ns_mode


filter https://<MGMT-IP>/nitro/v2/config/ns_ns_mode ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_ns_mode resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_ns_mode ?pagesize=#no;pageno=#no

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

count https://<MGMT-IP>/nitro/v2/config/ns_ns_mode ?count=yes

Use this query-parameter to get the count of ns_ns_mode resources.


Request Headers:

Accept: application/json






HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:


Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ns_mode":[{
Was this article helpful?