Skip to content

ns_service

Configuration for NS Services Information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
svc_port<Integer>Read-writeService Port.
Minimum value = 1
Maximum value =
hostname<String>Read-writeHostname of the managed device.
Minimum length = 1
Maximum length = 256
ns_ip_address<String>Read-writeNS IP Address.
Minimum length = 1
Maximum length = 64
svc_ip_address<String>Read-writeService IP Address.
Minimum length = 1
Maximum length = 64
svc_name<String>Read-writeService Name.
Minimum length = 1
Maximum length = 100
id<String>Read-writeId is system generated key.
save_config<Boolean>Read-writeSave configuration after enable/disable.
lb_id<String>Read-writeLB ID.
vsvr_name<String>Read-writeVserver Name.
Minimum length = 1
Maximum length = 100
delay<Double>Read-writeTime, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service.
svr_id<String>Read-writeServer ID.
graceful<Boolean>Read-writeGraceful shutdown of Service..
svr_name<String>Read-onlyServer Name.
svc_state<String>Read-onlyService State.
svc_type<String>Read-onlyService Type.
poll_time<Integer>Read-onlyLast Polling Time.
display_name<String>Read-onlyDisplay Name.
partition_name<String>Read-onlyPartition Name.
svc_state_timestamp<Double>Read-onlyService Last Statechange Time Stamp.

Operations

(click to see Properties)

ENABLE| POLL| GET| DISABLE

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_service?action=enable;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_service: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_port":<Integer_value>,
"svc_ip_address":<String_value>,
"svc_name":<String_value>,
"graceful":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_service":[{
"svr_name":<String_value>,
"svc_state":<String_value>,
"svc_port":<Integer_value>,
"hostname":<String_value>,
"svc_type":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"svc_ip_address":<String_value>,
"partition_name":<String_value>,
"svc_state_timestamp":<Double_value>,
"svc_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

poll

URL: https://<MGMT-IP>/nitro/v1/config/ns_service?action=poll;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_service: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_port":<Integer_value>,
"svc_ip_address":<String_value>,
"svc_name":<String_value>,
"graceful":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_service":[{
"svr_name":<String_value>,
"svc_state":<String_value>,
"svc_port":<Integer_value>,
"hostname":<String_value>,
"svc_type":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"svc_ip_address":<String_value>,
"partition_name":<String_value>,
"svc_state_timestamp":<Double_value>,
"svc_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_service

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_service":[{
"svr_name":<String_value>,
"svc_state":<String_value>,
"svc_port":<Integer_value>,
"hostname":<String_value>,
"svc_type":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"svc_ip_address":<String_value>,
"partition_name":<String_value>,
"svc_state_timestamp":<Double_value>,
"svc_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

disable

URL: https://<MGMT-IP>/nitro/v1/config/ns_service?action=disable;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_service: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_port":<Integer_value>,
"svc_ip_address":<String_value>,
"svc_name":<String_value>,
"graceful":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_service":[{
"svr_name":<String_value>,
"svc_state":<String_value>,
"svc_port":<Integer_value>,
"hostname":<String_value>,
"svc_type":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"svc_ip_address":<String_value>,
"partition_name":<String_value>,
"svc_state_timestamp":<Double_value>,
"svc_name":<String_value>,
"id":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}