ns_vserver

Configuration for Citrix ADC Lbvserver Information resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
user_managed	<Boolean>	Read-write	User Managed Idenfication.
hostname	<String>	Read-write	Hostname of the managed device. Minimum length = 1 Maximum length = 256
ns_ip_address	<String>	Read-write	Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
agent_list	<String>	Read-write	Agent List, on which traffic will flow.
id	<String>	Read-write	Id is system generated key.
export_option	<String>	Read-write	Export Options present for the given LB VServer.
name	<String>	Read-write	Vserver Name. Minimum length = 1 Maximum length = 100
export_list	<String>	Read-write	Export List present for the given LB VServer.
vsvr_ip_address	<String>	Read-write	Vserver IP Address. Minimum length = 1 Maximum length = 64
throughput	<Double>	Read-write	throughput value.
appflowlog_effective	<String>	Read-write	Appflowlog effective (validating AppFlow config) enabled or disabled.
icalog	<String>	Read-write	ICA log.
appflowlog	<String>	Read-write	Appflowlog enabled or disabled.
appflow_policy_rule	<String>	Read-write	AppFlow policy rule present.
es4nslog	<String>	Read-write	ESNS enable.
transport_mode	<String>	Read-write	Transport type - IPFix or LogStream.
save_config	<Boolean>	Read-write	Save configuration after enable/disable.
is_throughput_req	<Boolean>	Read-write	Throghput required.
svc_grp_name	<String>	Read-write	Service Group Name.
csvip_id	<String>	Read-write	CSVIP ID.
svc_grp_id	<String>	Read-write	Service Group ID.
csvip_name	<String>	Read-write	CSVIP Name.
svc_name	<String>	Read-write	Service Name.
svc_id	<String>	Read-write	Service ID.
state	<String>	Read-only	State of VServer.
cachetype	<String>	Read-only	Cache Type.
device_type	<String>	Read-only	Device Type : vpx, cpx, sdwan, blx, cpx-sidecar.
targetlbvserver	<String>	Read-only	Default Target LBVserver.
hits	<String>	Read-only	Traffic Domain.
license_type	<Integer>	Read-only	License Type : 0 - not licensed, 1 - manual, 2 - vpx, 3 - cpx, 4 - auto, 5 - cpx-sidecar/free.
display_name	<String>	Read-only	Display Name of Vserver.
comment	<String>	Read-only	Vserver comment.

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_vserver?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_vserver": {
<b>      "id":<String_value></b>,
      "user_managed":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "hostname":<String_value>,
      "csvip_id":<String_value>,
      "ns_ip_address":<String_value>,
      "agent_list":<String_value>,
      "csvip_name":<String_value>,
      "appflowlog_effective":<String_value>,
      "icalog":<String_value>,
      "save_config":<Boolean_value>,
      "export_option":<String_value>,
      "appflowlog":<String_value>,
      "appflow_policy_rule":<String_value>,
      "name":<String_value>,
      "es4nslog":<String_value>,
      "svc_grp_id":<String_value>,
      "export_list":<String_value>,
      "svc_name":<String_value>,
      "transport_mode":<String_value>,
      "vsvr_ip_address":<String_value>,
      "svc_id":<String_value>,
      "throughput":<Double_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_vserver":[{
      "user_managed":<Boolean_value>,
      "curclntconnections":<Double_value>,
      "vsvr_state":<String_value>,
      "hostname":<String_value>,
      "state":<String_value>,
      "ns_ip_address":<String_value>,
      "cachetype":<String_value>,
      "agent_list":<String_value>,
      "device_type":<String_value>,
      "vsvr_type":<String_value>,
      "id":<String_value>,
      "vsvr_cur_users":<String_value>,
      "export_option":<String_value>,
      "name":<String_value>,
      "poll_time":<Integer_value>,
      "export_list":<String_value>,
      "targetlbvserver":<String_value>,
      "vsvr_ip_address":<String_value>,
      "throughput":<Double_value>,
      "vsvr_state_timestamp":<Double_value>,
      "lbmethod":<String_value>,
      "hits":<String_value>,
      "appflowlog_effective":<String_value>,
      "type_vserver":<String_value>,
      "activeservices":<String_value>,
      "icalog":<String_value>,
      "totalservices":<String_value>,
      "vsvr_port":<Integer_value>,
      "vsvr_health":<Integer_value>,
      "vsvr_max_users":<String_value>,
      "appflowlog":<String_value>,
      "appflow_policy_rule":<String_value>,
      "license_type":<Integer_value>,
      "es4nslog":<String_value>,
      "parent_app_id":<String_value>,
      "cursrvrconnections":<Double_value>,
      "parent_app_name":<String_value>,
      "display_name":<String_value>,
      "managed":<Boolean_value>,
      "persistencetype":<String_value>,
      "partition_name":<String_value>,
      "comment":<String_value>,
      "transport_mode":<String_value>,
      "save_config":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "csvip_id":<String_value>,
      "svc_grp_id":<String_value>,
      "csvip_name":<String_value>,
      "svc_name":<String_value>,
      "svc_id":<String_value>}]}

poll

URL: https://<MGMT-IP>/nitro/v2/config/ns_vserver?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_vserver": {
<b>      "id":<String_value></b>,
      "user_managed":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "hostname":<String_value>,
      "csvip_id":<String_value>,
      "ns_ip_address":<String_value>,
      "agent_list":<String_value>,
      "csvip_name":<String_value>,
      "appflowlog_effective":<String_value>,
      "icalog":<String_value>,
      "save_config":<Boolean_value>,
      "export_option":<String_value>,
      "appflow_policy_rule":<String_value>,
      "appflowlog":<String_value>,
      "es4nslog":<String_value>,
      "name":<String_value>,
      "svc_grp_id":<String_value>,
      "export_list":<String_value>,
      "svc_name":<String_value>,
      "transport_mode":<String_value>,
      "vsvr_ip_address":<String_value>,
      "svc_id":<String_value>,
      "throughput":<Double_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_vserver":[{
      "user_managed":<Boolean_value>,
      "curclntconnections":<Double_value>,
      "vsvr_state":<String_value>,
      "hostname":<String_value>,
      "state":<String_value>,
      "ns_ip_address":<String_value>,
      "cachetype":<String_value>,
      "agent_list":<String_value>,
      "device_type":<String_value>,
      "vsvr_type":<String_value>,
      "id":<String_value>,
      "vsvr_cur_users":<String_value>,
      "export_option":<String_value>,
      "name":<String_value>,
      "poll_time":<Integer_value>,
      "export_list":<String_value>,
      "targetlbvserver":<String_value>,
      "vsvr_ip_address":<String_value>,
      "throughput":<Double_value>,
      "vsvr_state_timestamp":<Double_value>,
      "lbmethod":<String_value>,
      "hits":<String_value>,
      "appflowlog_effective":<String_value>,
      "type_vserver":<String_value>,
      "activeservices":<String_value>,
      "icalog":<String_value>,
      "totalservices":<String_value>,
      "vsvr_port":<Integer_value>,
      "vsvr_health":<Integer_value>,
      "vsvr_max_users":<String_value>,
      "appflowlog":<String_value>,
      "appflow_policy_rule":<String_value>,
      "license_type":<Integer_value>,
      "es4nslog":<String_value>,
      "parent_app_id":<String_value>,
      "cursrvrconnections":<Double_value>,
      "parent_app_name":<String_value>,
      "display_name":<String_value>,
      "managed":<Boolean_value>,
      "persistencetype":<String_value>,
      "partition_name":<String_value>,
      "comment":<String_value>,
      "transport_mode":<String_value>,
      "save_config":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "csvip_id":<String_value>,
      "svc_grp_id":<String_value>,
      "csvip_name":<String_value>,
      "svc_name":<String_value>,
      "svc_id":<String_value>}]}

get

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

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_vserver":[{
      "user_managed":<Boolean_value>,
      "curclntconnections":<Double_value>,
      "vsvr_state":<String_value>,
      "hostname":<String_value>,
      "state":<String_value>,
      "ns_ip_address":<String_value>,
      "cachetype":<String_value>,
      "agent_list":<String_value>,
      "device_type":<String_value>,
      "vsvr_type":<String_value>,
      "id":<String_value>,
      "vsvr_cur_users":<String_value>,
      "export_option":<String_value>,
      "name":<String_value>,
      "poll_time":<Integer_value>,
      "export_list":<String_value>,
      "targetlbvserver":<String_value>,
      "vsvr_ip_address":<String_value>,
      "throughput":<Double_value>,
      "vsvr_state_timestamp":<Double_value>,
      "lbmethod":<String_value>,
      "hits":<String_value>,
      "appflowlog_effective":<String_value>,
      "type_vserver":<String_value>,
      "activeservices":<String_value>,
      "icalog":<String_value>,
      "totalservices":<String_value>,
      "vsvr_port":<Integer_value>,
      "vsvr_health":<Integer_value>,
      "vsvr_max_users":<String_value>,
      "appflowlog":<String_value>,
      "appflow_policy_rule":<String_value>,
      "license_type":<Integer_value>,
      "es4nslog":<String_value>,
      "parent_app_id":<String_value>,
      "cursrvrconnections":<Double_value>,
      "parent_app_name":<String_value>,
      "display_name":<String_value>,
      "managed":<Boolean_value>,
      "persistencetype":<String_value>,
      "partition_name":<String_value>,
      "comment":<String_value>,
      "transport_mode":<String_value>,
      "save_config":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "csvip_id":<String_value>,
      "svc_grp_id":<String_value>,
      "csvip_name":<String_value>,
      "svc_name":<String_value>,
      "svc_id":<String_value>}]}

disable

URL: https://<MGMT-IP>/nitro/v2/config/ns_vserver?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_vserver": {
<b>      "id":<String_value></b>,
      "user_managed":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "hostname":<String_value>,
      "csvip_id":<String_value>,
      "ns_ip_address":<String_value>,
      "agent_list":<String_value>,
      "csvip_name":<String_value>,
      "appflowlog_effective":<String_value>,
      "icalog":<String_value>,
      "save_config":<Boolean_value>,
      "export_option":<String_value>,
      "appflow_policy_rule":<String_value>,
      "appflowlog":<String_value>,
      "es4nslog":<String_value>,
      "name":<String_value>,
      "svc_grp_id":<String_value>,
      "export_list":<String_value>,
      "svc_name":<String_value>,
      "transport_mode":<String_value>,
      "vsvr_ip_address":<String_value>,
      "svc_id":<String_value>,
      "throughput":<Double_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_vserver":[{
      "user_managed":<Boolean_value>,
      "curclntconnections":<Double_value>,
      "vsvr_state":<String_value>,
      "hostname":<String_value>,
      "state":<String_value>,
      "ns_ip_address":<String_value>,
      "cachetype":<String_value>,
      "agent_list":<String_value>,
      "device_type":<String_value>,
      "vsvr_type":<String_value>,
      "id":<String_value>,
      "vsvr_cur_users":<String_value>,
      "export_option":<String_value>,
      "name":<String_value>,
      "poll_time":<Integer_value>,
      "export_list":<String_value>,
      "targetlbvserver":<String_value>,
      "vsvr_ip_address":<String_value>,
      "throughput":<Double_value>,
      "vsvr_state_timestamp":<Double_value>,
      "lbmethod":<String_value>,
      "hits":<String_value>,
      "appflowlog_effective":<String_value>,
      "type_vserver":<String_value>,
      "activeservices":<String_value>,
      "icalog":<String_value>,
      "totalservices":<String_value>,
      "vsvr_port":<Integer_value>,
      "vsvr_health":<Integer_value>,
      "vsvr_max_users":<String_value>,
      "appflowlog":<String_value>,
      "appflow_policy_rule":<String_value>,
      "license_type":<Integer_value>,
      "es4nslog":<String_value>,
      "parent_app_id":<String_value>,
      "cursrvrconnections":<Double_value>,
      "parent_app_name":<String_value>,
      "display_name":<String_value>,
      "managed":<Boolean_value>,
      "persistencetype":<String_value>,
      "partition_name":<String_value>,
      "comment":<String_value>,
      "transport_mode":<String_value>,
      "save_config":<Boolean_value>,
      "is_throughput_req":<Boolean_value>,
      "svc_grp_name":<String_value>,
      "csvip_id":<String_value>,
      "svc_grp_id":<String_value>,
      "csvip_name":<String_value>,
      "svc_name":<String_value>,
      "svc_id":<String_value>}]}