uservserver
Configuration for virtual server resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver'). .
Minimum length = 1
|
| userprotocol | <String> | Read-write | User protocol uesd by the service. |
| ipaddress | <String> | Read-write | IPv4 or IPv6 address to assign to the virtual server. |
| port | <Integer> | Read-write | Port number for the virtual server.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
|
| defaultlb | <String> | Read-write | Name of the default Load Balancing virtual server used for load balancing of services. The protocol type of default Load Balancing virtual server should be a user type. |
| Params | <String> | Read-write | Any comments associated with the protocol. |
| comment | <String> | Read-write | Any comments that you might want to associate with the virtual server. |
| state | <String> | Read-write | Initial state of the user vserver.
Default value: ENABLED
Possible values = ENABLED, DISABLED
|
| curstate | <String> | Read-only | Current user vserver state.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
|
| value | <String> | Read-only | SSL status.
Possible values = Certkey/Certkeybundle/Vault not bound/Cert-store not usable, SSL feature disabled
|
| statechangetimesec | <String> | Read-only | Time when last state change happened. Seconds part. |
| statechangetimemsec | <Integer> | Read-only | Time at which last state change happened. Milliseconds part. |
| tickssincelaststatechange | <Integer> | Read-only | Time in 10 millisecond ticks since the last state change. |
| nodefaultbindings | <String> | Read-only | to determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO
Possible values = YES, NO
|
| _nextgenapiresource | <String> | Read-only | . |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- ENABLE
- DISABLE
- GET (ALL)
- GET
- COUNT
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=yesIf 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
add
URL: http:// <netscaler-ip-address> /nitro/v1/config/uservserver HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"uservserver":{
<b>"name":<String_value>,
</b><b>"userprotocol":<String_value>,
</b><b>"ipaddress":<String_value>,
</b><b>"port":<Integer_value>,
</b><b>"defaultlb":<String_value>,
</b>"Params":<String_value>,
"comment":<String_value>,
"state":<String_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/uservserver/ 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/uservserver HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"uservserver":{
<b>"name":<String_value>,
</b>"ipaddress":<String_value>,
"defaultlb":<String_value>,
"Params":<String_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/uservserver? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"uservserver":{
<b>"name":<String_value>,
</b>"Params":true,
"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/uservserver? action=enable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"uservserver":{
<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/uservserver? action=disable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"uservserver":{
<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
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/uservserver Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/uservserver? 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/uservserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of uservserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/uservserver? view=summary
Use this query-parameter to get the summary output of uservserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/uservserver? pagesize=#no;pageno=#no
Use this query-parameter to get the uservserver 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 Header:
Content-Type:application/json
Response Payload:
{ "uservserver": [ {
"name":<String_value>,
"userprotocol":<String_value>,
"ipaddress":<String_value>,
"port":<Integer_value>,
"defaultlb":<String_value>,
"Params":<String_value>,
"comment":<String_value>,
"curstate":<String_value>,
"value":<String_value>,
"statechangetimesec":<String_value>,
"statechangetimemsec":<Integer_value>,
"tickssincelaststatechange":<Integer_value>,
"state":<String_value>,
"nodefaultbindings":<String_value>,
"_nextgenapiresource":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/uservserver/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/uservserver/ 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/uservserver/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of uservserver resources configured on NetScaler.
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 Header:
Content-Type:application/json
Response Payload:
{ "uservserver": [ {
"name":<String_value>,
"userprotocol":<String_value>,
"ipaddress":<String_value>,
"port":<Integer_value>,
"defaultlb":<String_value>,
"Params":<String_value>,
"comment":<String_value>,
"curstate":<String_value>,
"value":<String_value>,
"statechangetimesec":<String_value>,
"statechangetimemsec":<Integer_value>,
"tickssincelaststatechange":<Integer_value>,
"state":<String_value>,
"nodefaultbindings":<String_value>,
"_nextgenapiresource":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/uservserver? 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 Header:
Content-Type:application/json
Response Payload:
{ "uservserver": [ { "__count": "#no"} ] }