Skip to content

clusterinstance

Statistics for cluster instance resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clid <Double> Read-write ID of the cluster instance for which to display statistics.

Minimum value = 1

Maximum value = 16
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
clbkplanetx <Double> Read-only Traffic transmitted from backplane (in mbits)
clbkplanetxrate <Double> Read-only Rate (/s) counter for clbkplanetx
clbkplanerx <Double> Read-only Traffic received on backplane (in mbits)
clbkplanerxrate <Double> Read-only Rate (/s) counter for clbkplanerx
clnumnodes <Double> Read-only Number of nodes in the cluster.
clcurstatus <String> Read-only State of the cluster.
clviewleader <String> Read-only NSIP address of the Configuration Coordinator of the cluster.
totsteeredpkts <Double> Read-only Total number of packets steered on the cluster backplane.
numdfddroppkts <Double> Read-only Number of steered packets that are dropped.
totpropagationtimeout <Double> Read-only Number of times the update to the client timed-out.

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 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 (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/clusterinstance

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/clusterinstance? args=clid: <Double_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get clusterinstance 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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "clusterinstance": [ {
      "clid":<Double_value>,
      "totpropagationtimeout":<Double_value>,
      "clbkplanetx":<Double_value>,
      "clbkplanetxrate":<Double_value>,
      "totsteeredpkts":<Double_value>,
      "numdfddroppkts":<Double_value>,
      "clviewleader":<String_value>,
      "clbkplanerx":<Double_value>,
      "clcurstatus":<String_value>,
      "clnumnodes":<Double_value>,
      "clbkplanerxrate":<Double_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/clusterinstance/ clid_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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "clusterinstance": [ {
      "clid":<Double_value>,
      "totpropagationtimeout":<Double_value>,
      "clbkplanetx":<Double_value>,
      "clbkplanetxrate":<Double_value>,
      "totsteeredpkts":<Double_value>,
      "numdfddroppkts":<Double_value>,
      "clviewleader":<String_value>,
      "clbkplanerx":<Double_value>,
      "clcurstatus":<String_value>,
      "clnumnodes":<Double_value>,
      "clbkplanerxrate":<Double_value>
}]}