ns_server
Configuration for NS Server Information resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| svr_ip_address | <String> | Read-write | Server IP Address. Minimum length = 1 Maximum length = 64 |
| name | <String> | Read-write | Server Name. Minimum length = 1 Maximum length = 100 |
| hostname | <String> | Read-write | Hostname of the managed device. Minimum length = 1 Maximum length = 256 |
| ns_ip_address | <String> | Read-write | Server IP Address. Minimum length = 1 Maximum length = 64 |
| id | <String> | Read-write | Id is system generated key. |
| save_config | <Boolean> | Read-write | Save configuration after enable/disable. |
| poll_time | <Integer> | Read-only | Last Polling Time. |
| display_name | <String> | Read-only | Display Name. |
| state | <String> | Read-only | Server state. |
| partition_name | <String> | Read-only | Partition Name. |
Operations
(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:
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: https://<MGMT-IP>/nitro/v1/config/ns_server?action=enable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_server: {
<b>"id":<String_value></b>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"svr_ip_address":<String_value>,
"name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_server":[{
"svr_ip_address":<String_value>,
"name":<String_value>,
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>}]}
poll
URL: https://<MGMT-IP>/nitro/v1/config/ns_server?action=poll;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_server: {
<b>"id":<String_value></b>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"svr_ip_address":<String_value>,
"name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_server":[{
"svr_ip_address":<String_value>,
"name":<String_value>,
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/ns_server
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_server":[{
"svr_ip_address":<String_value>,
"name":<String_value>,
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>}]}
disable
URL: https://<MGMT-IP>/nitro/v1/config/ns_server?action=disable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_server: {
<b>"id":<String_value></b>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"svr_ip_address":<String_value>,
"name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_server":[{
"svr_ip_address":<String_value>,
"name":<String_value>,
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>}]}