Product Documentation

hanode

Sep 08, 2016

Statistics for node resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
hacurstatus
<String>
Read-only
Whether a NetScaler appliance is configured for high availability. Possible values are YES and NO. If the value is NO, the high availability statistics below are invalid.
hacurstate
<String>
Read-only
State of the HA node, based on its health, in a high availability setup. Possible values are: UP ? Indicates that the node is accessible and can function as either a primary or secondary node. DISABLED ? Indicates that the high availability status of the node has been manually disabled. Synchronization and propagation cannot take place between the peer nodes. INIT ? Indicates that the node is in the process of becoming part of the high availability configuration. PARTIALFAIL ? Indicates that one of the high availability monitored interfaces has failed because of a card or link failure. This state triggers a failover. COMPLETEFAIL ? Indicates that all the interfaces of the node are unusable, because the interfaces on which high availability monitoring is enabled are not connected or are manually disabled. This state triggers a failover. DUMB ? Indicates that the node is in listening mode. It does not participate in high availability transitions or transfer configuration from the peer node. This is a configured value, not a statistic. PARTIALFAILSSL ? Indicates that the SSL card has failed. This state triggers a failover. ROUTEMONITORFAIL ? Indicates that the route monitor has failed. This state triggers a failover.
hacurmasterstate
<String>
Read-only
Indicates the high availability state of the node. Possible values are: STAYSECONDARY ? Indicates that the selected node remains the secondary node in a high availability setup. In this case a forced failover does not change the state but, instead, returns an appropriate error message. This is a configured value and not a statistic. PRIMARY ? Indicates that the selected node is the primary node in a high availability setup. SECONDARY ? Indicates that the selected node is the secondary node in a high availability setup. CLAIMING ? Indicates that the secondary node is in the process of taking over as the primary node. This is the intermediate state in the transition of the secondary node to primary status. FORCE CHANGE - Indicates that the secondary node is forcibly changing its status to primary due to a forced failover issued on the secondary node.
transtime
<String>
Read-only
Time when the last master state transition occurred. You can use this statistic for debugging.
hatotpktrx
<Double>
Read-only
Number of heartbeat packets received from the peer node. Heartbeats are sent at regular intervals (default is 200 milliseconds) to determine the state of the peer node.
hapktrxrate
<Double>
Read-only
Rate (/s) counter for hatotpktrx
hatotpkttx
<Double>
Read-only
Number of heartbeat packets sent to the peer node. Heartbeats are sent at regular intervals (default is 200 milliseconds) to determine the state of the peer node.
hapkttxrate
<Double>
Read-only
Rate (/s) counter for hatotpkttx
haerrproptimeout
<Double>
Read-only
Number of times propagation timed out.
haerrsyncfailure
<Double>
Read-only
Number of times the configuration of the primary and secondary nodes failed to synchronize since that last transition. A synchronization failure results in mismatched configuration. It can be caused by a mismatch in the Remote Procedural Call (RPC) password on the two nodes forming the high availability pair.

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>

메모

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

get (all)

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

Query-parameters:

args

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

Use this query-parameter to get hanode 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 Headers:

Content-Type:application/json

Response Payload:

{ "hanode": [ {
      "haerrsyncfailure":<Double_value>,
      "transtime":<String_value>,
      "hacurstatus":<String_value>,
      "hacurmasterstate":<String_value>,
      "hatotpkttx":<Double_value>,
      "hapktrxrate":<Double_value>,
      "haerrproptimeout":<Double_value>,
      "hapkttxrate":<Double_value>,
      "hacurstate":<String_value>,
      "hatotpktrx":<Double_value>
}]}