ns_clusternode
Configuration for ns_clusternode resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clusterid | <Integer> | Read-write | Cluster Instance ID. Minimum value = 1 Maximum value = |
| nodeid | <Integer> | Read-write | Cluster Node ID. Maximum value = |
| clnodeip | <String> | Read-write | Cluster Node IP. Minimum length = 1 Maximum length = 64 |
| password | <String> | Read-write | Password of the CCO node(CLIP). Minimum length = 1 Maximum length = 128 |
| iscco | <Boolean> | Read-write | Is CCO. |
| clip | <String> | Read-write | Cluster IP. Minimum length = 1 Maximum length = 64 |
| node_group | <String> | Read-write | Node Group where the node belongs in L3 Cluster. |
| islocalsdx | <String> | Read-write | Is Node Belonging to Local SDX. |
| clnodehealth | <String> | Read-only | Health of the node in the cluster. |
| nnmcurconn | <Double> | Read-only | Number of Connections open for node to node connection.. |
| nnmerrmsend | <Double> | Read-only | Number of errors in sending node-to-node multicast/broadcast messages. |
| nnmtotconntx | <Double> | Read-only | Number of node-to-node messages sent. |
| act_id | <String> | Read-only | Activity Id. |
| clnodeeffectivehealth | <String> | Read-only | Effective Health of the node in the cluster. |
| clptptx | <Double> | Read-only | Number of PTP packets transmitted by the node. |
| clmasterstate | <String> | Read-only | Cluster Master State. |
| clsyncstate | <String> | Read-only | Sync state of the cluster node. |
| cltothbtx | <Double> | Read-only | Cluster Number of Heartbeats Sent. |
| nnmtotconnrx | <Double> | Read-only | Number of node-to-node messages received. |
| clptprx | <Double> | Read-only | Number of PTP packets received on the node. |
| clptpstate | <String> | Read-only | PTP state of the node. This state is Master for one node and Slave for the rest. |
| cltothbrx | <Double> | Read-only | Cluster Number of Heartbeats Received. |
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>.
remove_node
URL: https://<MGMT-IP>/nitro/v1/config/ns_clusternode?action=remove_node;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_clusternode: {
<b>"nodeid":<Integer_value></b>,
"clusterid":<Integer_value>,
"clnodeip":<String_value>,
"password":<String_value>,
"clip":<String_value>,
"iscco":<Boolean_value>,
"node_group":<String_value>,
"islocalsdx":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clusternode":[{
"clnodehealth":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"nnmcurconn":<Double_value>,
"clnodeip":<String_value>,
"nnmerrmsend":<Double_value>,
"nnmtotconntx":<Double_value>,
"password":<String_value>,
"act_id":<String_value>,
"iscco":<Boolean_value>,
"clnodeeffectivehealth":<String_value>,
"clip":<String_value>,
"clptptx":<Double_value>,
"clmasterstate":<String_value>,
"clsyncstate":<String_value>,
"cltothbtx":<Double_value>,
"nnmtotconnrx":<Double_value>,
"clptprx":<Double_value>,
"clptpstate":<String_value>,
"node_group":<String_value>,
"cltothbrx":<Double_value>,
"islocalsdx":<String_value>}]}