Skip to content

ns_cluster

Configuration for Cluster information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
add_nodegroup <Boolean> Read-write Add Node group in cluster instance if this property is true.
backplane <String> Read-write Backplane Interface.
clusterid <Integer> Read-write Cluster Id in range of 1 and 16.

Minimum value = 1

Maximum value =
nodeid <Integer> Read-write Node Id in range of 0 and 31.

Maximum value =
state <String> Read-write Node State. Can be ACTIVE, SPARE, PASSIVE.

Minimum length = 1

Maximum length = 32
password <String> Read-write Password of the Configuration Coordinator node(Cluster IP).

Minimum length = 1

Maximum length = 128
process_local <Boolean> Read-write Process Local.
inc_mode <Boolean> Read-write Inc Mode.
scheduleId <String> Read-write scheduleId is used to refer maintenaince schedule task.
clnodes <String> Read-write List of Nodes part of Cluster.
preemption <Boolean> Read-write Preemption.
iscco <Boolean> Read-write Is Cluster coordinator.
clip <String> Read-write Cluster IPAddress.

Minimum length = 1

Maximum length = 64
node_group <String> Read-write Node group.
nodegroup_list <String[]> Read-write Available Node group list on this cluster.
ipaddress <String> Read-write Citrix ADC ipaddress which is going to participate in cluster.

Minimum length = 1

Maximum length = 64
profile_name <String> Read-write Profile Name.

Maximum length = 128
mgmt_cpu_usage <Double> Read-only Management CPU Usage (%) of Cluster Instance.
act_id <String> Read-only Activity Id.
clviewleader <String> Read-only Cluster CCO NSIP.
clnumnodes <Integer> Read-only Number of nodes in cluster.
http_req <Double> Read-only HTTP Requests/second on Cluster Instance.
cpu_usage <Double> Read-only CPU Usage (%) of Cluster Instance.
operationalstate <String> Read-only Cluster Operational State.
tx <Double> Read-only Out Throughput of Cluster Instance in Mbps.
clcurstatus <String> Read-only Current State of the cluster.
rx <Double> Read-only In Throughput of Cluster Instance in Mbps.
memory_usage <Double> Read-only Memory Usage (%) of Cluster Instance.
health <String> Read-only Node Health State.

Operations

(click to see Properties )

  • REMOVE
  • GET (ALL)
  • MODIFY_PASSWORD
  • FORM_CLUSTER
  • JOIN

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

remove

URL: https://<MGMT-IP>/nitro/v2/config/ns_cluster?action=remove;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_cluster": {
<b>      "ipaddress":<String_value></b>,
      "add_nodegroup":<Boolean_value>,
      "clusterid":<Integer_value>,
      "backplane":<String_value>,
      "nodeid":<Integer_value>,
      "clnodes":<String_value>,
      "state":<String_value>,
      "preemption":<Boolean_value>,
      "password":<String_value>,
      "clip":<String_value>,
      "iscco":<Boolean_value>,
      "process_local":<Boolean_value>,
      "inc_mode":<Boolean_value>,
      "node_group":<String_value>,
      "scheduleId":<String_value>,
      "nodegroup_list":<String_value[]>,
      "profile_name":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_cluster":[{
      "add_nodegroup":<Boolean_value>,
      "mgmt_cpu_usage":<Double_value>,
      "backplane":<String_value>,
      "clusterid":<Integer_value>,
      "nodeid":<Integer_value>,
      "state":<String_value>,
      "password":<String_value>,
      "process_local":<Boolean_value>,
      "act_id":<String_value>,
      "clviewleader":<String_value>,
      "inc_mode":<Boolean_value>,
      "clnumnodes":<Integer_value>,
      "http_req":<Double_value>,
      "scheduleId":<String_value>,
      "sync_operation":<Boolean_value>,
      "cpu_usage":<Double_value>,
      "clnodes":<String_value>,
      "preemption":<Boolean_value>,
      "iscco":<Boolean_value>,
      "clip":<String_value>,
      "operationalstate":<String_value>,
      "tx":<Double_value>,
      "clcurstatus":<String_value>,
      "rx":<Double_value>,
      "memory_usage":<Double_value>,
      "node_group":<String_value>,
      "health":<String_value>,
      "nodegroup_list":<String_value>,
      "ipaddress":<String_value>,
      "profile_name":<String_value>}]}

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_cluster

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_cluster ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_cluster resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_cluster ?pagesize=#no;pageno=#no

Use this query-parameter to get the ns_cluster resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_cluster ?count=yes

Use this query-parameter to get the count of ns_cluster resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_cluster":[{
      "add_nodegroup":<Boolean_value>,
      "mgmt_cpu_usage":<Double_value>,
      "backplane":<String_value>,
      "clusterid":<Integer_value>,
      "nodeid":<Integer_value>,
      "state":<String_value>,
      "password":<String_value>,
      "process_local":<Boolean_value>,
      "act_id":<String_value>,
      "clviewleader":<String_value>,
      "inc_mode":<Boolean_value>,
      "clnumnodes":<Integer_value>,
      "http_req":<Double_value>,
      "scheduleId":<String_value>,
      "sync_operation":<Boolean_value>,
      "cpu_usage":<Double_value>,
      "clnodes":<String_value>,
      "preemption":<Boolean_value>,
      "iscco":<Boolean_value>,
      "clip":<String_value>,
      "operationalstate":<String_value>,
      "tx":<Double_value>,
      "clcurstatus":<String_value>,
      "rx":<Double_value>,
      "memory_usage":<Double_value>,
      "node_group":<String_value>,
      "health":<String_value>,
      "nodegroup_list":<String_value>,
      "ipaddress":<String_value>,
      "profile_name":<String_value>}]}

modify_password

URL: https://<MGMT-IP>/nitro/v2/config/ns_cluster?action=modify_password;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_cluster": {
<b>      "ipaddress":<String_value></b>,
      "add_nodegroup":<Boolean_value>,
      "clusterid":<Integer_value>,
      "backplane":<String_value>,
      "nodeid":<Integer_value>,
      "clnodes":<String_value>,
      "state":<String_value>,
      "preemption":<Boolean_value>,
      "password":<String_value>,
      "clip":<String_value>,
      "iscco":<Boolean_value>,
      "process_local":<Boolean_value>,
      "inc_mode":<Boolean_value>,
      "node_group":<String_value>,
      "scheduleId":<String_value>,
      "nodegroup_list":<String_value[]>,
      "profile_name":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_cluster":[{
      "add_nodegroup":<Boolean_value>,
      "mgmt_cpu_usage":<Double_value>,
      "backplane":<String_value>,
      "clusterid":<Integer_value>,
      "nodeid":<Integer_value>,
      "state":<String_value>,
      "password":<String_value>,
      "process_local":<Boolean_value>,
      "act_id":<String_value>,
      "clviewleader":<String_value>,
      "inc_mode":<Boolean_value>,
      "clnumnodes":<Integer_value>,
      "http_req":<Double_value>,
      "scheduleId":<String_value>,
      "sync_operation":<Boolean_value>,
      "cpu_usage":<Double_value>,
      "clnodes":<String_value>,
      "preemption":<Boolean_value>,
      "iscco":<Boolean_value>,
      "clip":<String_value>,
      "operationalstate":<String_value>,
      "tx":<Double_value>,
      "clcurstatus":<String_value>,
      "rx":<Double_value>,
      "memory_usage":<Double_value>,
      "node_group":<String_value>,
      "health":<String_value>,
      "nodegroup_list":<String_value>,
      "ipaddress":<String_value>,
      "profile_name":<String_value>}]}

form_cluster

URL: https://<MGMT-IP>/nitro/v2/config/ns_cluster?action=form_cluster;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_cluster": {
<b>      "ipaddress":<String_value></b>,
      "add_nodegroup":<Boolean_value>,
      "clusterid":<Integer_value>,
      "backplane":<String_value>,
      "nodeid":<Integer_value>,
      "clnodes":<String_value>,
      "state":<String_value>,
      "preemption":<Boolean_value>,
      "password":<String_value>,
      "clip":<String_value>,
      "iscco":<Boolean_value>,
      "process_local":<Boolean_value>,
      "inc_mode":<Boolean_value>,
      "node_group":<String_value>,
      "scheduleId":<String_value>,
      "nodegroup_list":<String_value[]>,
      "profile_name":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_cluster":[{
      "add_nodegroup":<Boolean_value>,
      "mgmt_cpu_usage":<Double_value>,
      "backplane":<String_value>,
      "clusterid":<Integer_value>,
      "nodeid":<Integer_value>,
      "state":<String_value>,
      "password":<String_value>,
      "process_local":<Boolean_value>,
      "act_id":<String_value>,
      "clviewleader":<String_value>,
      "inc_mode":<Boolean_value>,
      "clnumnodes":<Integer_value>,
      "http_req":<Double_value>,
      "scheduleId":<String_value>,
      "sync_operation":<Boolean_value>,
      "cpu_usage":<Double_value>,
      "clnodes":<String_value>,
      "preemption":<Boolean_value>,
      "iscco":<Boolean_value>,
      "clip":<String_value>,
      "operationalstate":<String_value>,
      "tx":<Double_value>,
      "clcurstatus":<String_value>,
      "rx":<Double_value>,
      "memory_usage":<Double_value>,
      "node_group":<String_value>,
      "health":<String_value>,
      "nodegroup_list":<String_value>,
      "ipaddress":<String_value>,
      "profile_name":<String_value>}]}

join

URL: https://<MGMT-IP>/nitro/v2/config/ns_cluster?action=join;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_cluster": {
<b>      "ipaddress":<String_value></b>,
      "add_nodegroup":<Boolean_value>,
      "clusterid":<Integer_value>,
      "backplane":<String_value>,
      "nodeid":<Integer_value>,
      "clnodes":<String_value>,
      "state":<String_value>,
      "preemption":<Boolean_value>,
      "password":<String_value>,
      "clip":<String_value>,
      "iscco":<Boolean_value>,
      "process_local":<Boolean_value>,
      "inc_mode":<Boolean_value>,
      "node_group":<String_value>,
      "scheduleId":<String_value>,
      "nodegroup_list":<String_value[]>,
      "profile_name":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_cluster":[{
      "add_nodegroup":<Boolean_value>,
      "mgmt_cpu_usage":<Double_value>,
      "backplane":<String_value>,
      "clusterid":<Integer_value>,
      "nodeid":<Integer_value>,
      "state":<String_value>,
      "password":<String_value>,
      "process_local":<Boolean_value>,
      "act_id":<String_value>,
      "clviewleader":<String_value>,
      "inc_mode":<Boolean_value>,
      "clnumnodes":<Integer_value>,
      "http_req":<Double_value>,
      "scheduleId":<String_value>,
      "sync_operation":<Boolean_value>,
      "cpu_usage":<Double_value>,
      "clnodes":<String_value>,
      "preemption":<Boolean_value>,
      "iscco":<Boolean_value>,
      "clip":<String_value>,
      "operationalstate":<String_value>,
      "tx":<Double_value>,
      "clcurstatus":<String_value>,
      "rx":<Double_value>,
      "memory_usage":<Double_value>,
      "node_group":<String_value>,
      "health":<String_value>,
      "nodegroup_list":<String_value>,
      "ipaddress":<String_value>,
      "profile_name":<String_value>}]}
Was this article helpful?