ns_vserver_info
Configuration for Enabled Virtual server on Citrix ADC 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 |
agent_list | <String[]> | Read-write | Agent List, on which traffic will flow. |
tenant_id | <String> | Read-write | TenantID. |
ip_address | <String> | Read-write | Virtual server IP Address.
Minimum length = 1 Maximum length = 64 |
servicetype | <String> | Read-write | servicetype. |
icalog | <String> | Read-write | ICA log. |
export_option | <String[]> | Read-write | Export Options: TCP, ICA. |
appflow_policy_rule | <String> | Read-write | Appflow policy rule. |
appflowlog | <String> | Read-write | Appflow log. |
es4nslog | <String> | Read-write | ESNS enable. |
name | <String> | Read-write | Virtual server name.
Maximum length = 255 |
export_list | <String[]> | Read-write | Export List: WebInsight, SecurityInsight. |
transport_mode | <String> | Read-write | Transport Mode [ Logstream/Appflow ]. |
type | <String> | Read-write | Tells whether virtual server type.
Minimum length = 2 Maximum length = 64 |
state | <String> | Read-only | Tells whether virtual server up/down. |
Operations
(click to see Properties )
- DELETE
- GET (ALL)
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
delete
URL: https://<MGMT-IP>/nitro/v2/config/ns_vserver_info/ HTTPS Method: DELETE
Request Headers: 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 Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
<!--NeedCopy-->
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/ns_vserver_info Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/ns_vserver_info ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_vserver_info resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_vserver_info ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_vserver_info resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/ns_vserver_info ?count=yes Use this query-parameter to get the count of ns_vserver_info resources.
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_info":[{
"ns_ip_address":<String_value>,
"state":<String_value>,
"agent_list":<String_value>,
"tenant_id":<String_value>,
"ip_address":<String_value>,
"servicetype":<String_value>,
"icalog":<String_value>,
"export_option":<String_value>,
"primary_appflowlog":<String_value>,
"appflow_policy_rule":<String_value>,
"appflowlog":<String_value>,
"es4nslog":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"is_vsever_to_query":<Boolean_value>,
"transport_mode":<String_value>,
"type":<String_value>}]}
<!--NeedCopy-->