Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

clusternodegroup

August 17, 2023
Contributed by: 
C

Configuration for Node group object type resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the nodegroup. The name uniquely identifies the nodegroup on the cluster.

Minimum length = 1
strict 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.

Default value: NO

Possible values = YES, NO
sticky 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.

Default value: NO

Possible values = YES, NO
state Read-write State of the nodegroup. All the nodes binding to this nodegroup must have the same state. ACTIVE/SPARE/PASSIVE.

Possible values = ACTIVE, SPARE, PASSIVE
priority Read-write Priority of Nodegroup. This priority is used for all the nodes bound to the nodegroup for Nodegroup selection.

Minimum value = 0

Maximum value = 31
currentnodemask Read-only Bitmap of current nodes in this nodegroup.
backupnodemask Read-only Bitmap of backup nodes in this nodegroup.
boundedentitiescntfrompe 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 Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • GET (ALL)
  • GET
  • COUNT
  • UPDATE
  • UNSET
  • DELETE

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"clusternodegroup":{
<b>      "name":<String_value>,
</b>      "strict":<String_value>,
      "sticky":<String_value>,
      "state":<String_value>,
      "priority":<Double_value>
}}

<!--NeedCopy-->

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"clusternodegroup":{
<b>      "name":<String_value>,
</b>      "strict":<String_value>,
      "state":<String_value>,
      "priority":<Double_value>
}}

<!--NeedCopy-->

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/clusternodegroup? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"clusternodegroup":{
<b>      "name":<String_value>,
</b>      "strict":true
}}

<!--NeedCopy-->

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

delete

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

get (all)

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/clusternodegroup? 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/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:// <netscaler-ip-address> /nitro/v1/config/clusternodegroup? view=summary

Use this query-parameter to get the summary output of clusternodegroup 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/clusternodegroup? pagesize=#no;pageno=#no

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


{ "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>,
      "state":<String_value>,
      "priority":<Double_value>
}]}

<!--NeedCopy-->

get

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/clusternodegroup/ 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/clusternodegroup/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of clusternodegroup 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: 


{  "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>,
      "state":<String_value>,
      "priority":<Double_value>
}]}

<!--NeedCopy-->

count

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


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

<!--NeedCopy-->
clusternodegroup
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.