Skip to content


Configuration for NS Mode resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
rise_rhi<Boolean>Read-writetrue, if rise_rhi feature is enabled.
sradv<Boolean>Read-writetrue, if sradv feature is enabled.
pmtud<Boolean>Read-writetrue, if pmtud feature is enabled.
ns_ip_address<String>Read-writeNetScaler IP Address.
Minimum length = 1
Maximum length = 64
dradv<Boolean>Read-writetrue, if dradv feature is enabled.
tcpb<Boolean>Read-writetrue, if tcpb feature is enabled.
fr<Boolean>Read-writetrue, if fr feature is enabled.
dradv6<Boolean>Read-writetrue, if dradv6 feature is enabled.
edge<Boolean>Read-writetrue, if edge feature is enabled.
usnip<Boolean>Read-writetrue, if usnip feature is enabled.
bridgebpdus<Boolean>Read-writetrue, if bridgebpdus feature is enabled.
cka<Boolean>Read-writetrue, if cka feature is enabled.
ulfd<Boolean>Read-writetrue, if ulfd feature is enabled.
rise_apbr<Boolean>Read-writetrue, if rise_apbr feature is enabled.
sradv6<Boolean>Read-writetrue, if sradv6 feature is enabled.
ns_ip_address_arr<String[]>Read-writeList of NS IP Addresses.
Minimum length = 1
Maximum length = 64
mbf<Boolean>Read-writetrue, if mbf feature is enabled.
l3<Boolean>Read-writetrue, if l3 feature is enabled.
l2<Boolean>Read-writetrue, if l2 feature is enabled.
mediaclassification<Boolean>Read-writetrue, if mediaclassification feature is enabled.
iradv<Boolean>Read-writetrue, if iradv feature is enabled.
usip<Boolean>Read-writetrue, if usip feature is enabled.


(click to see Properties)

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:


    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:



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



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