Download full document:

vserver

Configuration for virtual server resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeThe name of the virtual server to be removed.
Minimum length = 1
backupvserver<String>Read-writeThe name of the backup virtual server for this virtual server.
Minimum length = 1
redirecturl<String>Read-writeThe URL where traffic is redirected if the virtual server in the system becomes unavailable.
Minimum length = 1
cacheable<String>Read-writeUse this option to specify whether a virtual server (used for load balancing or content switching) routes requests to the cache redirection virtual server before sending it to the configured servers.
Possible values = YES, NO
clttimeout<Double>Read-writeThe timeout value in seconds for idle client connection.
Minimum value = 0
Maximum value = 31536000
somethod<String>Read-writeThe spillover factor. The system will use this value to determine if it should send traffic to the backupvserver when the main virtual server reaches the spillover threshold.
Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE
sopersistence<String>Read-writeThe state of the spillover persistence.
Default value: DISABLED
Possible values = ENABLED, DISABLED
sopersistencetimeout<Double>Read-writeThe spillover persistence entry timeout.
Default value: 2
Minimum value = 2
Maximum value = 1440
sothreshold<Double>Read-writeThe spillver threshold value.
Minimum value = 1
Maximum value = 4294967294
pushvserver<String>Read-writeThe lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver.
Minimum length = 1

Operations

(click to see Properties)

DELETE| UPDATE| ENABLE| 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 redand placeholder content is marked in <green>.

delete

URL:http://<netscaler-ip-address>/nitro/v1/config/vserver/name_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL:http://<netscaler-ip-address>/nitro/v1/config/vserver

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vserver":{
<b>"name":<String_value>,
</b>"backupvserver":<String_value>,
"redirecturl":<String_value>,
"cacheable":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"pushvserver":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

enable

URL:http://<netscaler-ip-address>/nitro/v1/config/vserver?action=enable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vserver":{
<b>"name":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

disable

URL:http://<netscaler-ip-address>/nitro/v1/config/vserver?action=disable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vserver":{
<b>"name":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error