Skip to content


Configuration for ns_clusternode resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
clusterid<Integer>Read-writeCluster Instance ID.
Minimum value = 1
Maximum value =
nodeid<Integer>Read-writeCluster Node ID.
Maximum value =
clnodeip<String>Read-writeCluster Node IP.
Minimum length = 1
Maximum length = 64
password<String>Read-writePassword of the CCO node(CLIP).
Minimum length = 1
Maximum length = 128
iscco<Boolean>Read-writeIs CCO.
clip<String>Read-writeCluster IP.
Minimum length = 1
Maximum length = 64
node_group<String>Read-writeNode Group where the node belongs in L3 Cluster.
islocalsdx<String>Read-writeIs Node Belonging to Local SDX.
clnodehealth<String>Read-onlyHealth of the node in the cluster.
nnmcurconn<Double>Read-onlyNumber of Connections open for node to node connection..
nnmerrmsend<Double>Read-onlyNumber of errors in sending node-to-node multicast/broadcast messages.
nnmtotconntx<Double>Read-onlyNumber of node-to-node messages sent.
act_id<String>Read-onlyActivity Id.
clnodeeffectivehealth<String>Read-onlyEffective Health of the node in the cluster.
clptptx<Double>Read-onlyNumber of PTP packets transmitted by the node.
clmasterstate<String>Read-onlyCluster Master State.
clsyncstate<String>Read-onlySync state of the cluster node.
cltothbtx<Double>Read-onlyCluster Number of Heartbeats Sent.
nnmtotconnrx<Double>Read-onlyNumber of node-to-node messages received.
clptprx<Double>Read-onlyNumber of PTP packets received on the node.
clptpstate<String>Read-onlyPTP state of the node. This state is Master for one node and Slave for the rest.
cltothbrx<Double>Read-onlyCluster Number of Heartbeats Received.


(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:


    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:



    Note: In such cases, make sure that the request header DOES not include the following:



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


URL: https://<MGMT-IP>/nitro/v1/config/ns_clusternode?action=remove_node;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_clusternode: {

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_clusternode":[{