com.citrix.sdx.nitro.resource.config.ns

Class ns_clusternode

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.config.ns.ns_clusternode

public class ns_clusternode
extends base_resource

Configuration for ns_clusternode resource.

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
ns_clusternode()

Method Summary

Methods

Modifier and Type	Method and Description
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of ns_clusternode resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of ns_clusternode resources.
static long	count(nitro_service service) Use this API to count the ns_clusternode resources configured on NetScaler SDX.
String	get_act_id() Activity Id
String	get_clip() Cluster IP
String	get_clmasterstate() Cluster Master State
String	get_clnodeeffectivehealth() Effective Health of the node in the cluster
String	get_clnodehealth() Health of the node in the cluster
String	get_clnodeip() Cluster Node IP
Double	get_clptprx() Number of PTP packets received on the node
String	get_clptpstate() PTP state of the node.
Double	get_clptptx() Number of PTP packets transmitted by the node
String	get_clsyncstate() Sync state of the cluster node
Double	get_cltothbrx() Cluster Number of Heartbeats Received
Double	get_cltothbtx() Cluster Number of Heartbeats Sent
Integer	get_clusterid() Cluster Instance ID
static ns_clusternode[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of ns_clusternode resources.
static ns_clusternode[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of ns_clusternode resources.
Boolean	get_iscco() Is CCO
String	get_islocalsdx() Is Node Belonging to Local SDX
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
Double	get_nnmcurconn() Number of Connections open for node to node connection.
Double	get_nnmerrmsend() Number of errors in sending node-to-node multicast/broadcast messages
Double	get_nnmtotconnrx() Number of node-to-node messages received
Double	get_nnmtotconntx() Number of node-to-node messages sent
Integer	get_nodeid() Cluster Node ID
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_password() Password of the CCO node(CLIP)
static ns_clusternode	remove_node(nitro_service client, ns_clusternode resource) Use this operation to remove node from cluster.
static ns_clusternode[]	remove_node(nitro_service client, ns_clusternode[] resources) Use this operation to remove node from cluster in bulk.
void	set_clip(String clip) Cluster IP
void	set_clnodeip(String clnodeip) Cluster Node IP
void	set_clusterid(Integer clusterid) Cluster Instance ID
void	set_iscco(Boolean iscco) Is CCO
void	set_islocalsdx(String islocalsdx) Is Node Belonging to Local SDX
void	set_nodeid(Integer nodeid) Cluster Node ID
void	set_password(String password) Password of the CCO node(CLIP)
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ns_clusternode

public ns_clusternode()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

get_clnodehealth

public String get_clnodehealth()

 Health of the node in the cluster
 

set_clusterid

public void set_clusterid(Integer clusterid)

 Cluster Instance ID
 

get_clusterid

public Integer get_clusterid()

 Cluster Instance ID
 

set_nodeid

public void set_nodeid(Integer nodeid)

 Cluster Node ID
 

get_nodeid

public Integer get_nodeid()

 Cluster Node ID
 

get_nnmcurconn

public Double get_nnmcurconn()

 Number of Connections open for node to node connection.
 

set_clnodeip

public void set_clnodeip(String clnodeip)

 Cluster Node IP
 

get_clnodeip

public String get_clnodeip()

 Cluster Node IP
 

get_nnmerrmsend

public Double get_nnmerrmsend()

 Number of errors in sending node-to-node multicast/broadcast messages
 

get_nnmtotconntx

public Double get_nnmtotconntx()

 Number of node-to-node messages sent
 

set_password

public void set_password(String password)

 Password of the CCO node(CLIP)
 

get_password

public String get_password()

 Password of the CCO node(CLIP)
 

get_act_id

public String get_act_id()

 Activity Id
 

set_iscco

public void set_iscco(Boolean iscco)

 Is CCO
 

get_iscco

public Boolean get_iscco()

 Is CCO
 

get_clnodeeffectivehealth

public String get_clnodeeffectivehealth()

 Effective Health of the node in the cluster
 

set_clip

public void set_clip(String clip)

 Cluster IP
 

get_clip

public String get_clip()

 Cluster IP
 

get_clptptx

public Double get_clptptx()

 Number of PTP packets transmitted by the node
 

get_clmasterstate

public String get_clmasterstate()

 Cluster Master State
 

get_clsyncstate

public String get_clsyncstate()

 Sync state of the cluster node
 

get_cltothbtx

public Double get_cltothbtx()

 Cluster Number of Heartbeats Sent
 

get_nnmtotconnrx

public Double get_nnmtotconnrx()

 Number of node-to-node messages received
 

get_clptprx

public Double get_clptprx()

 Number of PTP packets received on the node
 

get_clptpstate

public String get_clptpstate()

 PTP state of the node. This state is Master for one node and Slave for the rest
 

get_cltothbrx

public Double get_cltothbrx()

 Cluster Number of Heartbeats Received
 

set_islocalsdx

public void set_islocalsdx(String islocalsdx)

 Is Node Belonging to Local SDX
 

get_islocalsdx

public String get_islocalsdx()

 Is Node Belonging to Local SDX
 

remove_node

public static ns_clusternode remove_node(nitro_service client,
                         ns_clusternode resource)
                                  throws Exception

 Use this operation to remove node from cluster.
 

Throws:

Exception

remove_node

public static ns_clusternode[] remove_node(nitro_service client,
                           ns_clusternode[] resources)
                                    throws Exception

 Use this operation to remove node from cluster in bulk.
 

Throws:

Exception

get_filtered

public static ns_clusternode[] get_filtered(nitro_service service,
                            String filter)
                                     throws Exception

Use this API to fetch filtered set of ns_clusternode resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static ns_clusternode[] get_filtered(nitro_service service,
                            filtervalue[] filter)
                                     throws Exception

Use this API to fetch filtered set of ns_clusternode resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the ns_clusternode resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of ns_clusternode resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of ns_clusternode resources. set the filter parameter values in filtervalue object.

Throws:

Exception

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception