Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

clusterinstance

May 23, 2024
Contributed by: 
C

Configuration for cluster instance resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clid Read-write Unique number that identifies the cluster.

Minimum value = 1

Maximum value = 16
deadinterval Read-write Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.If the value is less than 3 sec, set the helloInterval parameter to 200 msec.

Default value: 3

Minimum value = 1

Maximum value = 60
hellointerval Read-write Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.Set the value to 200 msec, if the deadInterval parameter is less than 3 sec.

Default value: 200

Minimum value = 200

Maximum value = 1000
preemption Read-write Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available.

Default value: DISABLED

Possible values = ENABLED, DISABLED
quorumtype Read-write Quorum Configuration Choices - “Majority” (recommended) requires majority of nodes to be online for the cluster to be UP. “None” relaxes this requirement.

Default value: MAJORITY

Possible values = MAJORITY, NONE
inc Read-write This option is required if the cluster nodes reside on different networks.

Default value: DISABLED

Possible values = ENABLED, DISABLED
processlocal Read-write By turning on this option packets destined to a service in a cluster will not under go any steering.

Default value: DISABLED

Possible values = ENABLED, DISABLED
retainconnectionsoncluster Read-write This option enables you to retain existing connections on a node joining a Cluster system or when a node is being configured for passive timeout. By default, this option is disabled.

Default value: NO

Possible values = YES, NO
backplanebasedview Read-write View based on heartbeat only on bkplane interface.

Default value: DISABLED

Possible values = ENABLED, DISABLED
syncstatusstrictmode Read-write strict mode for sync status of cluster. Depending on the the mode if there are any errors while applying config, sync status is displayed accordingly. By default the flag is disabled.

Default value: DISABLED

Possible values = ENABLED, DISABLED
dfdretainl2params Read-write flag to add ext l2 header during steering. By default the flag is disabled.

Default value: DISABLED

Possible values = ENABLED, DISABLED
clusterproxyarp Read-write This field controls the proxy arp feature in cluster. By default the flag is enabled.

Default value: ENABLED

Possible values = ENABLED, DISABLED
secureheartbeats Read-write By turning on this option cluster heartbeats will have security enabled.

Default value: DISABLED

Possible values = ENABLED, DISABLED
nodegroup Read-write The node group in a Cluster system used for transition from L2 to L3.
adminstate Read-only Cluster Admin State.

Default value: DISABLED

Possible values = ENABLED, DISABLED
propstate Read-only Enable/Disable the execution of commands on the cluster. This will not impact the execution of commands on individual cluster nodes by using the NSIP.

Default value: ENABLED

Possible values = ENABLED, DISABLED
validmtu Read-only Correct MTU value that has to be set on backplane.
heterogeneousflag Read-only This field diplay if heterogeneous is detected in the cluster system.

Default value: NO

Possible values = YES, NO
operationalstate Read-only Cluster Operational State.

Possible values = ENABLED, DISABLED
status Read-only Cluster Operational State.

Possible values = DOWN, UP, PARTIAL-UP, UNKNOWN
rsskeymismatch Read-only This argument is used to determine if there is a RSS key mismatch at cluster instance level.
penummismatch Read-only This argument is used to determine if there is a PE number mismatch at cluster instance level.
nodegroupstatewarning Read-only This argumnt is used to determind whether all the cluster nodes are bound to nodegroup with state set.
licensemismatch Read-only This argument is used to determine if there is a License mismatch at cluster instance level.
jumbonotsupported Read-only This argument is used to determine if Jumbo framework is not supported at cluster instance level.
clusternoheartbeatonnode Read-only HB is not seen on the backplane interface of member node.
clusternolinksetmbf Read-only MBF is enabled but linkset is not configured .
clusternospottedip Read-only There is no spotted SNIP or MIP.
clusterclipfailure Read-only CLIP movement failure. CLIP is not attached to CCO.
clusterhbhmacerrordetected Read-only There is cluster hb hmac error detected, it could be due to version mismatch.
nodepenummismatch Read-only This argument is used to determine if there is a PE missmatch at cluster node level.
operationalpropstate Read-only Cluster Operational Propagation State.

Default value: ENABLED

Possible values = UNKNOWN, ENABLED, DISABLED, AUTO DISABLED
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • ENABLE
  • DISABLE
  • GET (ALL)
  • GET
  • COUNT

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"clusterinstance":{
<b>"clid":<Double_value>,
</b>"deadinterval":<Double_value>,
"hellointerval":<Double_value>,
"preemption":<String_value>,
"quorumtype":<String_value>,
"inc":<String_value>,
"processlocal":<String_value>,
"retainconnectionsoncluster":<String_value>,
"backplanebasedview":<String_value>,
"syncstatusstrictmode":<String_value>,
"dfdretainl2params":<String_value>,
"clusterproxyarp":<String_value>,
"secureheartbeats":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance/ clid_value<Double> HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"clusterinstance":{
<b>"clid":<Double_value>,
</b>"deadinterval":<Double_value>,
"hellointerval":<Double_value>,
"preemption":<String_value>,
"quorumtype":<String_value>,
"inc":<String_value>,
"processlocal":<String_value>,
"nodegroup":<String_value>,
"retainconnectionsoncluster":<String_value>,
"backplanebasedview":<String_value>,
"syncstatusstrictmode":<String_value>,
"dfdretainl2params":<String_value>,
"clusterproxyarp":<String_value>,
"secureheartbeats":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"clusterinstance":{
<b>"clid":<Double_value>,
</b>"deadinterval":true,
"hellointerval":true,
"preemption":true,
"quorumtype":true,
"inc":true,
"processlocal":true,
"nodegroup":true,
"retainconnectionsoncluster":true,
"backplanebasedview":true,
"syncstatusstrictmode":true,
"dfdretainl2params":true,
"clusterproxyarp":true,
"secureheartbeats":true
}}

<!--NeedCopy-->

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

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? action=enable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"clusterinstance":{
<b>"clid":<Double_value>
</b>}}

<!--NeedCopy-->

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

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? action=disable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"clusterinstance":{
<b>"clid":<Double_value>
</b>}}

<!--NeedCopy-->

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of clusterinstance resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? view=summary

Use this query-parameter to get the summary output of clusterinstance resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? pagesize=#no;pageno=#no

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

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>,
"deadinterval":<Double_value>,
"hellointerval":<Double_value>,
"preemption":<String_value>,
"adminstate":<String_value>,
"quorumtype":<String_value>,
"propstate":<String_value>,
"inc":<String_value>,
"nodegroup":<String_value>,
"processlocal":<String_value>,
"validmtu":<Double_value>,
"retainconnectionsoncluster":<String_value>,
"heterogeneousflag":<String_value>,
"backplanebasedview":<String_value>,
"syncstatusstrictmode":<String_value>,
"dfdretainl2params":<String_value>,
"clusterproxyarp":<String_value>,
"secureheartbeats":<String_value>,
"operationalstate":<String_value>,
"status":<String_value>,
"rsskeymismatch":<Boolean_value>,
"penummismatch":<Boolean_value>,
"nodegroupstatewarning":<Boolean_value>,
"licensemismatch":<Boolean_value>,
"jumbonotsupported":<Boolean_value>,
"clusternoheartbeatonnode":<Boolean_value>,
"clusternolinksetmbf":<Boolean_value>,
"clusternospottedip":<Boolean_value>,
"clusterclipfailure":<Boolean_value>,
"clusterhbhmacerrordetected":<Boolean_value>,
"nodepenummismatch":<Boolean_value>,
"operationalpropstate":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance/ clid_value<Double> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance/ clid_value<Double> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance/ clid_value<Double> ? view=summary

Use this query-parameter to get the summary output of clusterinstance resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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>,
"deadinterval":<Double_value>,
"hellointerval":<Double_value>,
"preemption":<String_value>,
"adminstate":<String_value>,
"quorumtype":<String_value>,
"propstate":<String_value>,
"inc":<String_value>,
"nodegroup":<String_value>,
"processlocal":<String_value>,
"validmtu":<Double_value>,
"retainconnectionsoncluster":<String_value>,
"heterogeneousflag":<String_value>,
"backplanebasedview":<String_value>,
"syncstatusstrictmode":<String_value>,
"dfdretainl2params":<String_value>,
"clusterproxyarp":<String_value>,
"secureheartbeats":<String_value>,
"operationalstate":<String_value>,
"status":<String_value>,
"rsskeymismatch":<Boolean_value>,
"penummismatch":<Boolean_value>,
"nodegroupstatewarning":<Boolean_value>,
"licensemismatch":<Boolean_value>,
"jumbonotsupported":<Boolean_value>,
"clusternoheartbeatonnode":<Boolean_value>,
"clusternolinksetmbf":<Boolean_value>,
"clusternospottedip":<Boolean_value>,
"clusterclipfailure":<Boolean_value>,
"clusterhbhmacerrordetected":<Boolean_value>,
"nodepenummismatch":<Boolean_value>,
"operationalpropstate":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/clusterinstance? count=yes 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": [ { "__count": "#no"} ] }

<!--NeedCopy-->
clusterinstance
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.