Skip to content

ns_ns_ip

Configuration for NS IP on NetScaler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
save_config<Boolean>Read-writetrue, if save config is required.
type<String>Read-writeType of IP Address, Possible Values: SNIP.
Minimum length = 1
Maximum length = 64
netmask<String>Read-writenetmask.
Minimum length = 1
Maximum length = 64
ipaddress<String>Read-writeNS ipaddress that needs to be created.
Minimum length = 1
Maximum length = 64
ns_ip_address<String>Read-writeNetScaler IP Address where NSIP needs to be created.
Minimum length = 1
Maximum length = 64

Operations

(click to see Properties)

ADD

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: https://<MGMT-IP>/nitro/v1/config/ns_ns_ip?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_ns_ip: {
<b>"type":<String_value></b>,
<b>"netmask":<String_value></b>,
<b>"ipaddress":<String_value></b>,
<b>"ns_ip_address":<String_value></b>,
"save_config":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ns_ip":[{
"save_config":<Boolean_value>,
"type":<String_value>,
"netmask":<String_value>,
"ipaddress":<String_value>,
"ns_ip_address":<String_value>}]}