Skip to content

ns_service

Configuration for Citrix ADC Services Information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
svc_ip_address <String> Read-write Service IP Address.

Minimum length = 1

Maximum length = 64
id <String> Read-write Id is system generated key.
hostname <String> Read-write Hostname of the managed device.

Minimum length = 1

Maximum length = 256
svc_name <String> Read-write Service Name.

Minimum length = 1

Maximum length = 100
appflowlog <String> Read-write AppFlow is enabled at service of LBVServer.
vsvr_name <String> Read-write Vserver Name.

Minimum length = 1

Maximum length = 100
delay <Double> Read-write Time, in seconds, allocated to the Citrix ADC appliance for a graceful shutdown of the service.
svr_id <String> Read-write Server ID.
save_config <Boolean> Read-write Save configuration after enable/disable.
lb_id <String> Read-write LB ID.
graceful <Boolean> Read-write Graceful shutdown of Service..
site_name <String> Read-only Site Name.
svr_name <String> Read-only Server Name associated with service.
svc_port <Integer> Read-only Service Port.
svc_type <String> Read-only Service Protocol (HTTP|FTP).
poll_time <Integer> Read-only Last Polling Time.
svc_state <String> Read-only Service State.
display_name <String> Read-only Display Name.
partition_name <String> Read-only Partition Name.

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

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

enable

URL: https://<MGMT-IP>/nitro/v2/config/ns_service?action=enable;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_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>,
      "appflowlog":<String_value>,
      "svc_ip_address":<String_value>,
      "svc_name":<String_value>,
      "graceful":<Boolean_value>}}

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_service":[{
      "ns_ip_address":<String_value>,
      "svc_ip_address":<String_value>,
      "site_name":<String_value>,
      "svr_name":<String_value>,
      "id":<String_value>,
      "svc_port":<Integer_value>,
      "hostname":<String_value>,
      "svc_name":<String_value>,
      "svc_type":<String_value>,
      "poll_time":<Integer_value>,
      "svc_state_timestamp":<Double_value>,
      "type_svc":<String_value>,
      "appflowlog":<String_value>,
      "svc_state":<String_value>,
      "display_name":<String_value>,
      "partition_name":<String_value>,
      "vsvr_name":<String_value>,
      "delay":<Double_value>,
      "svr_id":<String_value>,
      "save_config":<Boolean_value>,
      "lb_id":<String_value>,
      "graceful":<Boolean_value>}]}

poll

URL: https://<MGMT-IP>/nitro/v2/config/ns_service?action=poll;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_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>,
      "appflowlog":<String_value>,
      "svc_ip_address":<String_value>,
      "svc_name":<String_value>,
      "graceful":<Boolean_value>}}

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_service":[{
      "ns_ip_address":<String_value>,
      "svc_ip_address":<String_value>,
      "site_name":<String_value>,
      "svr_name":<String_value>,
      "id":<String_value>,
      "svc_port":<Integer_value>,
      "hostname":<String_value>,
      "svc_name":<String_value>,
      "svc_type":<String_value>,
      "poll_time":<Integer_value>,
      "svc_state_timestamp":<Double_value>,
      "type_svc":<String_value>,
      "appflowlog":<String_value>,
      "svc_state":<String_value>,
      "display_name":<String_value>,
      "partition_name":<String_value>,
      "vsvr_name":<String_value>,
      "delay":<Double_value>,
      "svr_id":<String_value>,
      "save_config":<Boolean_value>,
      "lb_id":<String_value>,
      "graceful":<Boolean_value>}]}

get

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

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 Headers:

Content-Type:application/json

Response Payload:

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

disable

URL: https://<MGMT-IP>/nitro/v2/config/ns_service?action=disable;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_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>,
      "appflowlog":<String_value>,
      "svc_ip_address":<String_value>,
      "svc_name":<String_value>,
      "graceful":<Boolean_value>}}

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_service":[{
      "ns_ip_address":<String_value>,
      "svc_ip_address":<String_value>,
      "site_name":<String_value>,
      "svr_name":<String_value>,
      "id":<String_value>,
      "svc_port":<Integer_value>,
      "hostname":<String_value>,
      "svc_name":<String_value>,
      "svc_type":<String_value>,
      "poll_time":<Integer_value>,
      "svc_state_timestamp":<Double_value>,
      "type_svc":<String_value>,
      "appflowlog":<String_value>,
      "svc_state":<String_value>,
      "display_name":<String_value>,
      "partition_name":<String_value>,
      "vsvr_name":<String_value>,
      "delay":<Double_value>,
      "svr_id":<String_value>,
      "save_config":<Boolean_value>,
      "lb_id":<String_value>,
      "graceful":<Boolean_value>}]}
Was this article helpful?