Product Documentation

server

Sep 02, 2016

Configuration for server resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the server.
Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
Can be changed after the name is created.
Minimum length = 1
ipaddress
<String>
Read-write
IPv4 or IPv6 address of the server. If you create an IP address based server, you can specify the name of the server, instead of its IP address, when creating a service. Note: If you do not create a server entry, the server IP address that you enter when you create a service becomes the name of the server.
domain
<String>
Read-write
Domain name of the server. For a domain based configuration, you must create the server first.
Minimum length = 1
translationip
<String>
Read-write
IP address used to transform the server's DNS-resolved IP address.
translationmask
<String>
Read-write
The netmask of the translation ip.
domainresolveretry
<Integer>
Read-write
Time, in seconds, for which the NetScaler appliance must wait, after DNS resolution fails, before sending the next DNS query to resolve the domain name.
Default value: 5
Minimum value = 5
Maximum value = 20939
state
<String>
Read-write
Initial state of the server.
Default value: ENABLED
Possible values = ENABLED, DISABLED
ipv6address
<String>
Read-write
Support IPv6 addressing mode. If you configure a server with the IPv6 addressing mode, you cannot use the server in the IPv4 addressing mode.
Default value: NO
Possible values = YES, NO
comment
<String>
Read-write
Any information about the server.
td
<Double>
Read-write
Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value = 0
Maximum value = 4094
domainresolvenow
<Boolean>
Read-write
Immediately send a DNS query to resolve the server's domain name.
delay
<Double>
Read-write
Time, in seconds, after which all the services configured on the server are disabled.
graceful
<String>
Read-write
Shut down gracefully, without accepting any new connections, and disabling each service when all of its connections are closed.
Default value: NO
Possible values = YES, NO
Internal
<Boolean>
Read-write
Display names of the servers that have been created for internal use.
newname
<String>
Read-write
New name for the server. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
Minimum length = 1
statechangetimesec
<String>
Read-only
Time when last state change happened. Seconds part.
tickssincelaststatechange
<Double>
Read-only
Time in 10 millisecond ticks since the last state change.
autoscale
<String>
Read-only
Auto scale option for a servicegroup.
Default value: DISABLED
Possible values = DISABLED, DNS, POLICY
customserverid
<String>
Read-only
A positive integer to identify the service. Used when the persistency type is set to Custom Server ID.
Default value: "None"
monthreshold
<Double>
Read-only
Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.
Minimum value = 0
Maximum value = 65535
maxclient
<Double>
Read-only
Maximum number of simultaneous open connections for the service group.
Minimum value = 0
Maximum value = 4294967294
maxreq
<Double>
Read-only
Maximum number of requests that can be sent on a persistent connection to the service group.
Note: Connection requests beyond this value are rejected.
Minimum value = 0
Maximum value = 65535
maxbandwidth
<Double>
Read-only
Maximum bandwidth, in Kbps, allocated for all the services in the service group.
Minimum value = 0
Maximum value = 4294967287
usip
<String>
Read-only
Use the client's IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.
Possible values = YES, NO
cka
<String>
Read-only
Enable client keep-alive for the service group.
Possible values = YES, NO
tcpb
<String>
Read-only
Enable TCP buffering for the service group.
Possible values = YES, NO
cmp
<String>
Read-only
Enable compression for the specified service.
Possible values = YES, NO
clttimeout
<Double>
Read-only
Time, in seconds, after which to terminate an idle client connection.
Minimum value = 0
Maximum value = 31536000
svrtimeout
<Double>
Read-only
Time, in seconds, after which to terminate an idle server connection.
Minimum value = 0
Maximum value = 31536000
cipheader
<String>
Read-only
Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client's IP header name.
Minimum length = 1
cip
<String>
Read-only
Before forwarding a request to the service, insert an HTTP header with the client's IPv4 or IPv6 address as its value. Used if the server needs the client's IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option.
Possible values = ENABLED, DISABLED
cacheable
<String>
Read-only
Use the transparent cache redirection virtual server to forward the request to the cache server.
Default value: NO
Possible values = YES, NO
sc
<String>
Read-only
State of the SureConnect feature for the service group.
Default value: OFF
Possible values = ON, OFF
sp
<String>
Read-only
Enable surge protection for the service group.
Default value: OFF
Possible values = ON, OFF
downstateflush
<String>
Read-only
Perform delayed clean-up of connections to all services in the service group.
Default value: ENABLED
Possible values = ENABLED, DISABLED
appflowlog
<String>
Read-only
Enable logging of AppFlow information for the specified service group.
Default value: ENABLED
Possible values = ENABLED, DISABLED
boundtd
<Double>
Read-only
Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value = 0
Maximum value = 4094
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"server":{
      "name":<String_value>,
      "ipaddress":<String_value>,
      "domain":<String_value>,
      "translationip":<String_value>,
      "translationmask":<String_value>,
      "domainresolveretry":<Integer_value>,
      "state":<String_value>,
      "ipv6address":<String_value>,
      "comment":<String_value>,
      "td":<Double_value>
}}

Response:

HTTP Status Code on Success: 201 Created
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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/server/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/server

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"server":{
      "name":<String_value>,
      "ipaddress":<String_value>,
      "domainresolveretry":<Integer_value>,
      "translationip":<String_value>,
      "translationmask":<String_value>,
      "domainresolvenow":<Boolean_value>,
      "comment":<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

unset

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"server":{
      "name":<String_value>,
      "comment":true
}}

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/server?action=enable

HTTP Method: POST

Request Headers:

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

Request Payload:

{"server":{
      "name":<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

disable

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"server":{
      "name":<String_value>,
      "delay":<Double_value>,
      "graceful":<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

rename

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"server":{
      "name":<String_value>,
      "newname":<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

get (all)

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/server?args=name:<String_value>,Internal:<Boolean_value>

Use this query-parameter to get server resources based on additional properties.

attrs

http://<netscaler-ip-address>/nitro/v1/config/server?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/server?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of server resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/server?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/server?pagesize=#no&pageno=#no

Use this query-parameter to get the server resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "server": [ {
name:<String_value>,Internal:<Boolean_value>      "ipaddress":<String_value>,
      "state":<String_value>,
      "domain":<String_value>,
      "domainresolveretry":<Integer_value>,
      "translationip":<String_value>,
      "translationmask":<String_value>,
      "comment":<String_value>,
      "statechangetimesec":<String_value>,
      "tickssincelaststatechange":<Double_value>,
      "ipv6address":<String_value>,
      "td":<Double_value>,
      "autoscale":<String_value>,
      "customserverid":<String_value>,
      "monthreshold":<Double_value>,
      "maxclient":<Double_value>,
      "maxreq":<Double_value>,
      "maxbandwidth":<Double_value>,
      "usip":<String_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "cmp":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "cipheader":<String_value>,
      "cip":<String_value>,
      "cacheable":<String_value>,
      "sc":<String_value>,
      "sp":<String_value>,
      "downstateflush":<String_value>,
      "appflowlog":<String_value>,
      "boundtd":<Double_value>
}]}

get

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/server/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/server/name_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "server": [ {
name:<String_value>,Internal:<Boolean_value>      "ipaddress":<String_value>,
      "state":<String_value>,
      "domain":<String_value>,
      "domainresolveretry":<Integer_value>,
      "translationip":<String_value>,
      "translationmask":<String_value>,
      "comment":<String_value>,
      "statechangetimesec":<String_value>,
      "tickssincelaststatechange":<Double_value>,
      "ipv6address":<String_value>,
      "td":<Double_value>,
      "autoscale":<String_value>,
      "customserverid":<String_value>,
      "monthreshold":<Double_value>,
      "maxclient":<Double_value>,
      "maxreq":<Double_value>,
      "maxbandwidth":<Double_value>,
      "usip":<String_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "cmp":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "cipheader":<String_value>,
      "cip":<String_value>,
      "cacheable":<String_value>,
      "sc":<String_value>,
      "sp":<String_value>,
      "downstateflush":<String_value>,
      "appflowlog":<String_value>,
      "boundtd":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/server?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "server": [ { "__count": "#no"} ] }