ns_ns_ip
Configuration for IP on Citrix ADC resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| save_config |
|
Read-write | true, if save config is required. |
| type |
|
Read-write | Type of IP Address, Possible Values: SNIP.
Minimum length = 1 Maximum length = 64 |
| netmask |
|
Read-write | netmask.
Minimum length = 1 Maximum length = 64 |
| ipaddress |
|
Read-write | Citrix ADC ipaddress that needs to be created.
Minimum length = 1 Maximum length = 64 |
| ns_ip_address |
|
Read-write | Citrix ADC IP Address where IP 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
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
add
URL: https://<MGMT-IP>/nitro/v2/config/ns_ns_ip?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
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>}}
<!--NeedCopy-->
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 Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ns_ip":[{
"save_config":<Boolean_value>,
"type":<String_value>,
"netmask":<String_value>,
"ipaddress":<String_value>,
"ns_ip_address":<String_value>}]}
<!--NeedCopy-->