nsmode¶

Configuration for ns mode resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
mode	<String[]>	Read-write	Mode to be enabled. Multiple modes can be specified by providing a blank space between each mode. Possible values = FR, FastRamp, L2, L2mode, L3, L3mode, USIP, UseSourceIP, CKA, ClientKeepAlive, TCPB, TCPBuffering, MBF, MACbasedforwarding, Edge, USNIP, SRADV, DRADV, IRADV, SRADV6, DRADV6, PMTUD, RISE_APBR, RISE_RHI, BridgeBPDUs, ULFD
fr	<Boolean>	Read-only	Fast Ramp.
l2	<Boolean>	Read-only	Layer 2 mode.
usip	<Boolean>	Read-only	Use Source IP.
cka	<Boolean>	Read-only	Client Keep-alive.
tcpb	<Boolean>	Read-only	TCP Buffering.
mbf	<Boolean>	Read-only	MAC-based forwarding.
edge	<Boolean>	Read-only	Edge configuration.
usnip	<Boolean>	Read-only	Use Subnet IP.
l3	<Boolean>	Read-only	Layer 3 mode (ip forwarding).
pmtud	<Boolean>	Read-only	Path MTU Discovery.
mediaclassification	<Boolean>	Read-only	mediaclassification.
sradv	<Boolean>	Read-only	Static Route Advertisement.
dradv	<Boolean>	Read-only	Direct Route Advertisement.
iradv	<Boolean>	Read-only	Intranet Route Advertisement.
sradv6	<Boolean>	Read-only	Ipv6 Static Route Advertisement.
dradv6	<Boolean>	Read-only	Ipv6 Direct Route Advertisement.
bridgebpdus	<Boolean>	Read-only	BPDU Bridging Mode.
ulfd	<Boolean>	Read-only	Unified Logging Framework Mode for adding/removing ULF services.

Operations¶

(click to see Properties )

ENABLE
DISABLE
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

enable¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmode? action=enable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsmode":{
      "mode":<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

disable¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmode? action=disable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsmode":{
      "mode":<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

get (all)¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsmode

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:

{ "nsmode": [ {
      "mode":<String[]_value>,
      "fr":<Boolean_value>,
      "l2":<Boolean_value>,
      "usip":<Boolean_value>,
      "cka":<Boolean_value>,
      "tcpb":<Boolean_value>,
      "mbf":<Boolean_value>,
      "edge":<Boolean_value>,
      "usnip":<Boolean_value>,
      "l3":<Boolean_value>,
      "pmtud":<Boolean_value>,
      "mediaclassification":<Boolean_value>,
      "sradv":<Boolean_value>,
      "dradv":<Boolean_value>,
      "iradv":<Boolean_value>,
      "sradv6":<Boolean_value>,
      "dradv6":<Boolean_value>,
      "bridgebpdus":<Boolean_value>,
      "ulfd":<Boolean_value>
}]}