Citrix ADM NITRO API Reference

ns_ns_mode

June 20, 2023

Contributed by:

Configuration for Citrix ADC Mode resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
rise_rhi		Read-write	true, if rise_rhi feature is enabled.
sradv		Read-write	true, if sradv feature is enabled.
pmtud		Read-write	true, if pmtud feature is enabled.
ns_ip_address		Read-write	Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
dradv		Read-write	true, if dradv feature is enabled.
tcpb		Read-write	true, if tcpb feature is enabled.
fr		Read-write	true, if fr feature is enabled.
dradv6		Read-write	true, if dradv6 feature is enabled.
edge		Read-write	true, if edge feature is enabled.
usnip		Read-write	true, if usnip feature is enabled.
bridgebpdus		Read-write	true, if bridgebpdus feature is enabled.
cka		Read-write	true, if cka feature is enabled.
ulfd		Read-write	true, if ulfd feature is enabled.
rise_apbr		Read-write	true, if rise_apbr feature is enabled.
sradv6		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		Read-write	true, if mbf feature is enabled.
l3		Read-write	true, if l3 feature is enabled.
l2		Read-write	true, if l2 feature is enabled.
mediaclassification		Read-write	true, if mediaclassification feature is enabled.
iradv		Read-write	true, if iradv feature is enabled.
usip		Read-write	true, if usip feature is enabled.

Operations

(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>

*Note:* 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 Query-parameters:

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.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: 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:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ns_mode":[{
"rise_rhi":<Boolean_value>,
"sradv":<Boolean_value>,
"pmtud":<Boolean_value>,
"ns_ip_address":<String_value>,
"dradv":<Boolean_value>,
"tcpb":<Boolean_value>,
"fr":<Boolean_value>,
"dradv6":<Boolean_value>,
"edge":<Boolean_value>,
"usnip":<Boolean_value>,
"bridgebpdus":<Boolean_value>,
"cka":<Boolean_value>,
"ulfd":<Boolean_value>,
"rise_apbr":<Boolean_value>,
"sradv6":<Boolean_value>,
"ns_ip_address_arr":<String_value>,
"mbf":<Boolean_value>,
"l3":<Boolean_value>,
"l2":<Boolean_value>,
"mediaclassification":<Boolean_value>,
"iradv":<Boolean_value>,
"usip":<Boolean_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns_ns_mode

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ns_ns_mode

Properties

Operations

get (all)

In this article