Product Documentation

lbgroup

Sep 07, 2016

Configuration for LB group resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the load balancing virtual server group.
Minimum length = 1
persistencetype
<String>
Read-write
Type of persistence for the group. Available settings function as follows:
* SOURCEIP - Create persistence sessions based on the client IP.
* COOKIEINSERT - Create persistence sessions based on a cookie in client requests. The cookie is inserted by a Set-Cookie directive from the server, in its first response to a client.
* RULE - Create persistence sessions based on a user defined rule.
* NONE - Disable persistence for the group.
Possible values = SOURCEIP, COOKIEINSERT, RULE, NONE
persistencebackup
<String>
Read-write
Type of backup persistence for the group.
Possible values = SOURCEIP, NONE
backuppersistencetimeout
<Double>
Read-write
Time period, in minutes, for which backup persistence is in effect.
Default value: 2
Minimum value = 2
Maximum value = 1440
persistmask
<String>
Read-write
Persistence mask to apply to source IPv4 addresses when creating source IP based persistence sessions.
Minimum length = 1
cookiename
<String>
Read-write
Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.
v6persistmasklen
<Double>
Read-write
Persistence mask to apply to source IPv6 addresses when creating source IP based persistence sessions.
Default value: 128
Minimum value = 1
Maximum value = 128
cookiedomain
<String>
Read-write
Domain attribute for the HTTP cookie.
Minimum length = 1
timeout
<Double>
Read-write
Time period for which a persistence session is in effect.
Default value: 2
Minimum value = 0
Maximum value = 1440
rule
<String>
Read-write
Expression, or name of a named expression, against which traffic is evaluated. Written in the classic or default syntax.
Note:
Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'

The following requirements apply only to the NetScaler CLI:
* If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
* If the expression itself includes double quotation marks, escape the quotations by using the \ character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.
Default value: "None"
newname
<String>
Read-write
New name for the load balancing virtual server group.
Minimum length = 1
td
<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>.

update

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"lbgroup":{
      "name":<String_value>,
      "persistencetype":<String_value>,
      "persistencebackup":<String_value>,
      "backuppersistencetimeout":<Double_value>,
      "persistmask":<String_value>,
      "cookiename":<String_value>,
      "v6persistmasklen":<Double_value>,
      "cookiedomain":<String_value>,
      "timeout":<Double_value>,
      "rule":<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/lbgroup?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"lbgroup":{
      "name":<String_value>,
      "persistencetype":true,
      "persistencebackup":true,
      "backuppersistencetimeout":true,
      "persistmask":true,
      "cookiename":true,
      "v6persistmasklen":true,
      "cookiedomain":true,
      "timeout":true,
      "rule":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

rename

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"lbgroup":{
      "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/lbgroup

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/lbgroup?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/lbgroup?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

Use this query-parameter to get the lbgroup 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:

{ "lbgroup": [ {
      "name":<String_value>,
      "persistencetype":<String_value>,
      "persistencebackup":<String_value>,
      "backuppersistencetimeout":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "cookiename":<String_value>,
      "cookiedomain":<String_value>,
      "timeout":<Double_value>,
      "rule":<String_value>,
      "td":<Double_value>
}]}

get

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

Query-parameters:

attrs

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

{ "lbgroup": [ {
      "name":<String_value>,
      "persistencetype":<String_value>,
      "persistencebackup":<String_value>,
      "backuppersistencetimeout":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "cookiename":<String_value>,
      "cookiedomain":<String_value>,
      "timeout":<Double_value>,
      "rule":<String_value>,
      "td":<Double_value>
}]}

count

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

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