Download full document:

clusternodegroup

Configuration for Node group object type resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	Read-write	Name of the nodegroup. The name uniquely identifies the nodegroup on the cluster.<br>Minimum length = 1
strict	<String>	Read-write	Specifies whether cluster nodes, that are not part of the nodegroup, will be used as backup for the nodegroup. * Enabled - When one of the nodes goes down, no other cluster node is picked up to replace it. When the node comes up, it will continue being part of the nodegroup. * Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.<br>Default value: NO<br>Possible values = YES, NO
sticky	<String>	Read-write	Only one node can be bound to nodegroup with this option enabled. It specifies whether to prempt the traffic for the entities bound to nodegroup when owner node goes down and rejoins the cluster. * Enabled - When owner node goes down, backup node will become the owner node and takes the traffic for the entities bound to the nodegroup. When bound node rejoins the cluster, traffic for the entities bound to nodegroup will not be steered back to this bound node. Current owner will have the ownership till it goes down. * Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.<br>Default value: NO<br>Possible values = YES, NO
currentnodemask	<Double>	Read-only	Bitmap of current nodes in this nodegroup.
backupnodemask	<Double>	Read-only	Bitmap of backup nodes in this nodegroup.
boundedentitiescntfrompe	<Double>	Read-only	Count of bounded entities to this nodegroup accoding to PE.
activelist	<Double[]>	Read-only	Active node list of this nodegroup.
backuplist	<Double[]>	Read-only	Backup node list of this nodegroup.
__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>

Note:

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

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"clusternodegroup":{
      "name":<String_value>,
      "strict":<String_value>,
      "sticky":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"clusternodegroup":{
      "name":<String_value>,
      "strict":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"clusternodegroup":{
      "name":<String_value>,
      "strict":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/clusternodegroup/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/clusternodegroup/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/clusternodegroup

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/clusternodegroup?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<NS_IP>/nitro/v1/config/clusternodegroup?view=summary

Use this query-parameter to get the summary output of clusternodegroup resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/clusternodegroup?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/clusternodegroup?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "clusternodegroup": [ {
      "name":<String_value>,
      "strict":<String_value>,
      "sticky":<String_value>,
      "currentnodemask":<Double_value>,
      "backupnodemask":<Double_value>,
      "boundedentitiescntfrompe":<Double_value>,
      "activelist":<Double[]_value>,
      "backuplist":<Double[]_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/clusternodegroup/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "clusternodegroup": [ {
      "name":<String_value>,
      "strict":<String_value>,
      "sticky":<String_value>,
      "currentnodemask":<Double_value>,
      "backupnodemask":<Double_value>,
      "boundedentitiescntfrompe":<Double_value>,
      "activelist":<Double[]_value>,
      "backuplist":<Double[]_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/clusternodegroup?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",clusternodegroup: [ { "__count": "#no"} ] }