Skip to content

clusternode

Statistics for cluster node resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
nodeid<Double>Read-writeID of the cluster node for which to display statistics. If an ID is not provided, statistics are shown for all nodes.
Minimum value = 0
Maximum value = 31
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
clsyncstate<String>Read-onlySync state of the cluster node.
clnodeeffectivehealth<String>Read-onlyHealth of the cluster node.
clnodeip<String>Read-onlyNSIP address of the cluster node.
clmasterstate<String>Read-onlyOperational state of the cluster node.
cltothbtx<Double>Read-onlyNumber of heartbeats sent. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
cltothbrx<Double>Read-onlyNumber of heartbeats received. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
nnmcurconn<Double>Read-onlyNumber of connections open for node-to-node communication.
nnmtotconntx<Double>Read-onlyNumber of node-to-node messages sent. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
nnmtotconnrx<Double>Read-onlyNumber of node-to-node messages received. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
clptpstate<String>Read-onlyPTP state of the node. This state is Master for one node and Slave for the rest. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows UNKNOWN. When executed from the cluster IP address, shows all the statistics.
clptptx<Double>Read-onlyNumber of PTP packets transmitted by the node. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
clptprx<Double>Read-onlyNumber of PTP packets received on the node. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.
nnmerrmsend<Double>Read-onlyNumber of errors in sending node-to-node multicast/broadcast messages. When executed from the NSIP address, shows the statistics for local node only. For remote node it shows a value of 0. When executed from the cluster IP address, shows all the statistics.

Operations

(click to see Properties)

GET (ALL)| GET

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/clusternode

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/clusternode?args=nodeid:<Double_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get clusternode resources based on additional properties.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "clusternode": [ {
"nodeid":<Double_value>,
"clnodeip":<String_value>,
"clsyncstate":<String_value>,
"nnmcurconn":<Double_value>,
"nnmerrmsend":<Double_value>,
"clnodeeffectivehealth":<String_value>,
"nnmtotconnrx":<Double_value>,
"cltothbrx":<Double_value>,
"clptprx":<Double_value>,
"nnmtotconntx":<Double_value>,
"clmasterstate":<String_value>,
"clptptx":<Double_value>,
"clptpstate":<String_value>,
"cltothbtx":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/clusternode/nodeid_value><Double>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "clusternode": [ {
"nodeid":<Double_value>,
"clnodeip":<String_value>,
"clsyncstate":<String_value>,
"nnmcurconn":<Double_value>,
"nnmerrmsend":<Double_value>,
"clnodeeffectivehealth":<String_value>,
"nnmtotconnrx":<Double_value>,
"cltothbrx":<Double_value>,
"clptprx":<Double_value>,
"nnmtotconntx":<Double_value>,
"clmasterstate":<String_value>,
"clptptx":<Double_value>,
"clptpstate":<String_value>,
"cltothbtx":<Double_value>
}]}