ADC NITRO APIs

clusterinstance_clusternode_binding

August 17, 2023

Contributed by:

Binding object showing the clusternode that can be bound to clusterinstance.

Properties

(click to see Operations )

Name	Permissions	Description
nodeid	Read-write	The unique number that identiies a cluster. Minimum value = 0 Maximum value = 31
clid	Read-write	Unique number that identifies the cluster. Minimum value = 1 Maximum value = 16
state	Read-only	Active, Spare or Passive. An active node serves traffic. A spare node serves as a backup for active nodes. A passive node does not serve traffic. This may be useful during temporary maintenance activity where it is desirable that the node takes part in the consensus protocol, but not serve traffic. Default value: PASSIVE Possible values = ACTIVE, SPARE, PASSIVE
nodersskeymismatch	Read-only	This argument is used to determine if there is a RSS key mismatch at cluster node level.
nodelicensemismatch	Read-only	This argument is used to determine if there is a License mismatch at cluster node level.
effectivestate	Read-only	Node effective health state. Possible values = UP, NOT UP, UNKNOWN, INIT
islocalnode	Read-only	This argument is used to determine whether it is local node.
isconfigurationcoordinator	Read-only	This argument is used to determine whether the node is configuration coordinator (CCO).
nodejumbonotsupported	Read-only	This argument is used to determine if Jumbo framework not supported at cluster node level.
health	Read-only	Node Health state. Possible values = UNKNOWN, INIT, DOWN, UP, Some enabled and HAMON interfaces of the node are down, All interfaces of the node are down or disabled, SSL card(s) of the node have failed, Route Monitor(s) of the node have failed, Service state is being synchronized with the cluster, The backplane interface is either not set or it is down or is disabled, The CLAG member(s) of the node are down, Persistence sessions are being synchronized with the cluster, The Syn Cookie is being synchronized with the cluster, Unknown Health, AAA keys are being sychronized with the cluster, Cluster health is not up due to config sync is in progress
clusterhealth	Read-only	Node clusterd state. Possible values = UP, Configurations of the node are lagging behind the cluster by more than 256 commands, The config sync operation has exceeded the time limit of 60 seconds, The config sync operation (full sync) is in progress, The node is not in sync with the cluster configurations as sync is disabled on this node, The execution of a configuration command has failed on this node, UNKNOWN
masterstate	Read-only	Master state. Possible values = INACTIVE, ACTIVE, UNKNOWN
ipaddress	Read-only	The IP Address of the node.
__count	Read-only	count parameter

Operations

(click to see Properties )

GET
GET (ALL)
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=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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance_clusternode_binding/ clid_value<Double>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance_clusternode_binding/ clid_value<Double> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance_clusternode_binding/ clid_value<Double> ? pagesize=#no;pageno=#no

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

{  "clusterinstance_clusternode_binding": [ {
      "nodeid":<Double_value>,
      "clid":<Double_value>,
      "state":<String_value>,
      "nodersskeymismatch":<Boolean_value>,
      "nodelicensemismatch":<Boolean_value>,
      "effectivestate":<String_value>,
      "islocalnode":<Boolean_value>,
      "isconfigurationcoordinator":<Boolean_value>,
      "nodejumbonotsupported":<Boolean_value>,
      "health":<String_value>,
      "clusterhealth":<String_value>,
      "masterstate":<String_value>,
      "ipaddress":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance_clusternode_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:

{  "clusterinstance_clusternode_binding": [ {
      "nodeid":<Double_value>,
      "clid":<Double_value>,
      "state":<String_value>,
      "nodersskeymismatch":<Boolean_value>,
      "nodelicensemismatch":<Boolean_value>,
      "effectivestate":<String_value>,
      "islocalnode":<Boolean_value>,
      "isconfigurationcoordinator":<Boolean_value>,
      "nodejumbonotsupported":<Boolean_value>,
      "health":<String_value>,
      "clusterhealth":<String_value>,
      "masterstate":<String_value>,
      "ipaddress":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

clusterinstance_clusternode_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

clusterinstance_clusternode_binding

Properties

Operations

get

get (all)

count

In this article