ns_cluster
Configuration for ns_cluster resource.
(click to see Operations)
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. Minimum value = 1 Maximum value = |
| nodeid | <Integer> | Read-write | Node Id. Maximum value = |
| state | <String> | Read-write | Node State. Minimum length = 1 Maximum length = 32 |
| channel_interface_list | <ns_clag_node[]> | Read-write | Array of CLAG nodes that are part of this channel (10/1, 10/4). |
| password | <String> | Read-write | Password of the Configuration Coordinator node(Cluster IP). Minimum length = 1 Maximum length = 128 |
| clag_intf_list | <String[]> | Read-write | CLAG Interface List containing interfaces which aren't shared across nodes and aren't backplanes. |
| process_local | <Boolean> | Read-write | Process Local. |
| clviewleader | <String> | Read-write | Cluster CCO NSIP. Minimum length = 1 Maximum length = 64 |
| inc_mode | <Boolean> | Read-write | Inc Mode. |
| clnumnodes | <Integer> | Read-write | Cluster ID. Maximum value = |
| 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 CCO. |
| 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 | NS ipaddress. 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. |
| totpropagationtimeout | <Double> | Read-only | Number of times the update to the client timed-out. |
| totsteeredpkts | <Double> | Read-only | Total number of packets steered on the cluster backplane. |
| act_id | <String> | Read-only | Activity Id. |
| numdfddroppkts | <Double> | Read-only | Total number of packets steered on the cluster backplane. |
| http_req | <Double> | Read-only | HTTP Requests/second on Cluster Instance. |
| cpu_usage | <Double> | Read-only | CPU Usage (%) of Cluster Instance. |
| clbkplanerx | <Double> | Read-only | Traffic received on backplane (in mbits). |
| clbkplanetx | <Double> | Read-only | Traffic transmitted from backplane (in mbits). |
| operationalstate | <String> | Read-only | Cluster Operational State. |
| tx | <Double> | Read-only | Out Throughput of Cluster Instance in Mbps. |
| clcurstatus | <String> | Read-only | 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. |
| clbkplanetxrate | <Double> | Read-only | Traffic rate transmitted from backplane (in mbits). |
| health | <String> | Read-only | Node Health State. |
| clbkplanerxrate | <Double> | Read-only | Traffic rate received on backplane (in mbits). |
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>.
remove
URL: https://<MGMT-IP>/nitro/v1/config/ns_cluster?action=remove;onerror=<String_value>
HTTP Method: null
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>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}],
"preemption":<Boolean_value>,
"password":<String_value>,
"clip":<String_value>,
"iscco":<Boolean_value>,
"process_local":<Boolean_value>,
"clag_intf_list":<String_value[]>,
"clviewleader":<String_value>,
"inc_mode":<Boolean_value>,
"clnumnodes":<Integer_value>,
"node_group":<String_value>,
"scheduleId":<String_value>,
"nodegroup_list":<String_value[]>,
"profile_name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_cluster":[{
"add_nodegroup":<Boolean_value>,
"mgmt_cpu_usage":<Double_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"state":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"totpropagationtimeout":<Double_value>,
"totsteeredpkts":<Double_value>,
"password":<String_value>,
"clag_intf_list":<String_value>,
"process_local":<Boolean_value>,
"act_id":<String_value>,
"numdfddroppkts":<Double_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>,
"clbkplanerx":<Double_value>,
"clnodes":<String_value>,
"clbkplanetx":<Double_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>,
"clbkplanetxrate":<Double_value>,
"health":<String_value>,
"clbkplanerxrate":<Double_value>,
"nodegroup_list":<String_value>,
"ipaddress":<String_value>,
"profile_name":<String_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/ns_cluster
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_cluster":[{
"add_nodegroup":<Boolean_value>,
"mgmt_cpu_usage":<Double_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"state":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"totpropagationtimeout":<Double_value>,
"totsteeredpkts":<Double_value>,
"password":<String_value>,
"clag_intf_list":<String_value>,
"process_local":<Boolean_value>,
"act_id":<String_value>,
"numdfddroppkts":<Double_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>,
"clbkplanerx":<Double_value>,
"clnodes":<String_value>,
"clbkplanetx":<Double_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>,
"clbkplanetxrate":<Double_value>,
"health":<String_value>,
"clbkplanerxrate":<Double_value>,
"nodegroup_list":<String_value>,
"ipaddress":<String_value>,
"profile_name":<String_value>}]}
modify_password
URL: https://<MGMT-IP>/nitro/v1/config/ns_cluster?action=modify_password;onerror=<String_value>
HTTP Method: null
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>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}],
"preemption":<Boolean_value>,
"password":<String_value>,
"clip":<String_value>,
"iscco":<Boolean_value>,
"process_local":<Boolean_value>,
"clag_intf_list":<String_value[]>,
"clviewleader":<String_value>,
"inc_mode":<Boolean_value>,
"clnumnodes":<Integer_value>,
"node_group":<String_value>,
"scheduleId":<String_value>,
"nodegroup_list":<String_value[]>,
"profile_name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_cluster":[{
"add_nodegroup":<Boolean_value>,
"mgmt_cpu_usage":<Double_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"state":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"totpropagationtimeout":<Double_value>,
"totsteeredpkts":<Double_value>,
"password":<String_value>,
"clag_intf_list":<String_value>,
"process_local":<Boolean_value>,
"act_id":<String_value>,
"numdfddroppkts":<Double_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>,
"clbkplanerx":<Double_value>,
"clnodes":<String_value>,
"clbkplanetx":<Double_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>,
"clbkplanetxrate":<Double_value>,
"health":<String_value>,
"clbkplanerxrate":<Double_value>,
"nodegroup_list":<String_value>,
"ipaddress":<String_value>,
"profile_name":<String_value>}]}
form_cluster
URL: https://<MGMT-IP>/nitro/v1/config/ns_cluster?action=form_cluster;onerror=<String_value>
HTTP Method: null
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>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}],
"preemption":<Boolean_value>,
"password":<String_value>,
"clip":<String_value>,
"iscco":<Boolean_value>,
"process_local":<Boolean_value>,
"clag_intf_list":<String_value[]>,
"clviewleader":<String_value>,
"inc_mode":<Boolean_value>,
"clnumnodes":<Integer_value>,
"node_group":<String_value>,
"scheduleId":<String_value>,
"nodegroup_list":<String_value[]>,
"profile_name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_cluster":[{
"add_nodegroup":<Boolean_value>,
"mgmt_cpu_usage":<Double_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"state":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"totpropagationtimeout":<Double_value>,
"totsteeredpkts":<Double_value>,
"password":<String_value>,
"clag_intf_list":<String_value>,
"process_local":<Boolean_value>,
"act_id":<String_value>,
"numdfddroppkts":<Double_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>,
"clbkplanerx":<Double_value>,
"clnodes":<String_value>,
"clbkplanetx":<Double_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>,
"clbkplanetxrate":<Double_value>,
"health":<String_value>,
"clbkplanerxrate":<Double_value>,
"nodegroup_list":<String_value>,
"ipaddress":<String_value>,
"profile_name":<String_value>}]}
join
URL: https://<MGMT-IP>/nitro/v1/config/ns_cluster?action=join;onerror=<String_value>
HTTP Method: null
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>,
"channel_interface_list":[{
"nodeid":<Integer_value>,
"parent_id":<String_value>,
"id":<String_value>,
"interface_name":<String_value>,
"local_node":<Boolean_value>,
"parent_name":<String_value>}],
"preemption":<Boolean_value>,
"password":<String_value>,
"clip":<String_value>,
"iscco":<Boolean_value>,
"process_local":<Boolean_value>,
"clag_intf_list":<String_value[]>,
"clviewleader":<String_value>,
"inc_mode":<Boolean_value>,
"clnumnodes":<Integer_value>,
"node_group":<String_value>,
"scheduleId":<String_value>,
"nodegroup_list":<String_value[]>,
"profile_name":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_cluster":[{
"add_nodegroup":<Boolean_value>,
"mgmt_cpu_usage":<Double_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"nodeid":<Integer_value>,
"state":<String_value>,
"channel_interface_list":[{
"local_node":<Boolean_value>,
"interface_name":<String_value>,
"parent_name":<String_value>,
"nodeid":<Integer_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"totpropagationtimeout":<Double_value>,
"totsteeredpkts":<Double_value>,
"password":<String_value>,
"clag_intf_list":<String_value>,
"process_local":<Boolean_value>,
"act_id":<String_value>,
"numdfddroppkts":<Double_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>,
"clbkplanerx":<Double_value>,
"clnodes":<String_value>,
"clbkplanetx":<Double_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>,
"clbkplanetxrate":<Double_value>,
"health":<String_value>,
"clbkplanerxrate":<Double_value>,
"nodegroup_list":<String_value>,
"ipaddress":<String_value>,
"profile_name":<String_value>}]}