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

Class ns_cluster

java.lang.Object

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

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

public class ns_cluster
extends base_resource

Configuration for ns_cluster 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_cluster()

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_cluster resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of ns_cluster resources.
static long	count(nitro_service service) Use this API to count the ns_cluster resources configured on NetScaler SDX.
static ns_cluster	form_cluster(nitro_service client, ns_cluster resource) Use this operation to form one node cluster from NetScaler Instance.
static ns_cluster[]	form_cluster(nitro_service client, ns_cluster[] resources) Use this operation to form one node cluster from NetScaler Instance in bulk.
String	get_act_id() Activity Id
String	get_backplane() Backplane Interface
Double	get_clbkplanerx() Traffic received on backplane (in mbits)
Double	get_clbkplanerxrate() Traffic rate received on backplane (in mbits)
Double	get_clbkplanetx() Traffic transmitted from backplane (in mbits)
Double	get_clbkplanetxrate() Traffic rate transmitted from backplane (in mbits)
String	get_clcurstatus() State of the cluster
String	get_clip() Cluster IPAddress
String	get_clnodes() List of Nodes part of Cluster
Integer	get_clnumnodes() Cluster ID
Integer	get_clusterid() Cluster Id
String	get_clviewleader() Cluster CCO NSIP
Double	get_cpu_usage() CPU Usage (%) of Cluster Instance
static ns_cluster[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of ns_cluster resources.
static ns_cluster[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of ns_cluster resources.
String	get_health() Node Health State
Double	get_http_req() HTTP Requests/second on Cluster Instance
String	get_ipaddress() NS ipaddress
Boolean	get_iscco() Is CCO
Double	get_memory_usage() Memory Usage (%) of Cluster Instance
Double	get_mgmt_cpu_usage() Management CPU Usage (%) of Cluster Instance
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.
Integer	get_nodeid() Node Id
Double	get_numdfddroppkts() Total number of packets steered on the cluster backplane
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_operationalstate() Cluster Operational State
String	get_password() Password of the Configuration Coordinator node(Cluster IP)
String	get_profile_name() Profile Name
Double	get_rx() In Throughput of Cluster Instance in Mbps
String	get_state() Node State
Double	get_totpropagationtimeout() Number of times the update to the client timed-out
Double	get_totsteeredpkts() Total number of packets steered on the cluster backplane
Double	get_tx() Out Throughput of Cluster Instance in Mbps
static ns_cluster[]	get(nitro_service client) Use this operation to get ns cluster instance.
static ns_cluster	join(nitro_service client, ns_cluster resource) Use this operation to join NetScaler Instance to existing cluster.
static ns_cluster[]	join(nitro_service client, ns_cluster[] resources) Use this operation to join NetScaler Instance to existing cluster in bulk.
static ns_cluster	modify_password(nitro_service client, ns_cluster resource) Use this operation to modify Cluster IP admin ns password.
static ns_cluster[]	modify_password(nitro_service client, ns_cluster[] resources) Use this operation to modify Cluster IP admin ns password in bulk.
static ns_cluster	remove(nitro_service client, ns_cluster resource) Use this operation to remove entire Cluster Instance.
static ns_cluster[]	remove(nitro_service client, ns_cluster[] resources) Use this operation to remove entire Cluster Instance in bulk.
void	set_backplane(String backplane) Backplane Interface
void	set_clip(String clip) Cluster IPAddress
void	set_clnodes(String clnodes) List of Nodes part of Cluster
void	set_clnumnodes(Integer clnumnodes) Cluster ID
void	set_clusterid(Integer clusterid) Cluster Id
void	set_clviewleader(String clviewleader) Cluster CCO NSIP
void	set_ipaddress(String ipaddress) NS ipaddress
void	set_iscco(Boolean iscco) Is CCO
void	set_nodeid(Integer nodeid) Node Id
void	set_password(String password) Password of the Configuration Coordinator node(Cluster IP)
void	set_profile_name(String profile_name) Profile Name
void	set_state(String state) Node State
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_cluster

public ns_cluster()

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_mgmt_cpu_usage

public Double get_mgmt_cpu_usage()

 Management CPU Usage (%) of Cluster Instance
 

get_clbkplanerx

public Double get_clbkplanerx()

 Traffic received on backplane (in mbits)
 

set_backplane

public void set_backplane(String backplane)

 Backplane Interface
 

get_backplane

public String get_backplane()

 Backplane Interface
 

set_clusterid

public void set_clusterid(Integer clusterid)

 Cluster Id
 

get_clusterid

public Integer get_clusterid()

 Cluster Id
 

set_nodeid

public void set_nodeid(Integer nodeid)

 Node Id
 

get_nodeid

public Integer get_nodeid()

 Node Id
 

set_clnodes

public void set_clnodes(String clnodes)

 List of Nodes part of Cluster
 

get_clnodes

public String get_clnodes()

 List of Nodes part of Cluster
 

set_state

public void set_state(String state)

 Node State
 

get_state

public String get_state()

 Node State
 

get_totpropagationtimeout

public Double get_totpropagationtimeout()

 Number of times the update to the client timed-out
 

get_totsteeredpkts

public Double get_totsteeredpkts()

 Total number of packets steered on the cluster backplane
 

get_clbkplanetx

public Double get_clbkplanetx()

 Traffic transmitted from backplane (in mbits)
 

set_password

public void set_password(String password)

 Password of the Configuration Coordinator node(Cluster IP)
 

get_password

public String get_password()

 Password of the Configuration Coordinator node(Cluster IP)
 

get_act_id

public String get_act_id()

 Activity Id
 

set_clip

public void set_clip(String clip)

 Cluster IPAddress
 

get_clip

public String get_clip()

 Cluster IPAddress
 

set_iscco

public void set_iscco(Boolean iscco)

 Is CCO
 

get_iscco

public Boolean get_iscco()

 Is CCO
 

get_operationalstate

public String get_operationalstate()

 Cluster Operational State
 

get_numdfddroppkts

public Double get_numdfddroppkts()

 Total number of packets steered on the cluster backplane
 

set_clviewleader

public void set_clviewleader(String clviewleader)

 Cluster CCO NSIP
 

get_clviewleader

public String get_clviewleader()

 Cluster CCO NSIP
 

get_tx

public Double get_tx()

 Out Throughput of Cluster Instance in Mbps
 

set_clnumnodes

public void set_clnumnodes(Integer clnumnodes)

 Cluster ID
 

get_clnumnodes

public Integer get_clnumnodes()

 Cluster ID
 

get_clcurstatus

public String get_clcurstatus()

 State of the cluster
 

get_http_req

public Double get_http_req()

 HTTP Requests/second on Cluster Instance
 

get_rx

public Double get_rx()

 In Throughput of Cluster Instance in Mbps
 

get_memory_usage

public Double get_memory_usage()

 Memory Usage (%) of Cluster Instance
 

get_clbkplanetxrate

public Double get_clbkplanetxrate()

 Traffic rate transmitted from backplane (in mbits)
 

get_health

public String get_health()

 Node Health State
 

get_clbkplanerxrate

public Double get_clbkplanerxrate()

 Traffic rate received on backplane (in mbits)
 

get_cpu_usage

public Double get_cpu_usage()

 CPU Usage (%) of Cluster Instance
 

set_ipaddress

public void set_ipaddress(String ipaddress)

 NS ipaddress
 

get_ipaddress

public String get_ipaddress()

 NS ipaddress
 

set_profile_name

public void set_profile_name(String profile_name)

 Profile Name
 

get_profile_name

public String get_profile_name()

 Profile Name
 

remove

public static ns_cluster remove(nitro_service client,
                ns_cluster resource)
                         throws Exception

 Use this operation to remove entire Cluster Instance.
 

Throws:

Exception

remove

public static ns_cluster[] remove(nitro_service client,
                  ns_cluster[] resources)
                           throws Exception

 Use this operation to remove entire Cluster Instance in bulk.
 

Throws:

Exception

get

public static ns_cluster[] get(nitro_service client)
                        throws Exception

 Use this operation to get ns cluster instance.
 

Throws:

Exception

modify_password

public static ns_cluster modify_password(nitro_service client,
                         ns_cluster resource)
                                  throws Exception

 Use this operation to modify Cluster IP admin ns password.
 

Throws:

Exception

modify_password

public static ns_cluster[] modify_password(nitro_service client,
                           ns_cluster[] resources)
                                    throws Exception

 Use this operation to modify Cluster IP admin ns password in bulk.
 

Throws:

Exception

form_cluster

public static ns_cluster form_cluster(nitro_service client,
                      ns_cluster resource)
                               throws Exception

 Use this operation to form one node cluster from NetScaler Instance.
 

Throws:

Exception

form_cluster

public static ns_cluster[] form_cluster(nitro_service client,
                        ns_cluster[] resources)
                                 throws Exception

 Use this operation to form one node cluster from NetScaler Instance in bulk.
 

Throws:

Exception

join

public static ns_cluster join(nitro_service client,
              ns_cluster resource)
                       throws Exception

 Use this operation to join NetScaler Instance to existing cluster.
 

Throws:

Exception

join

public static ns_cluster[] join(nitro_service client,
                ns_cluster[] resources)
                         throws Exception

 Use this operation to join NetScaler Instance to existing cluster in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

Use this API to fetch filtered set of ns_cluster 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_cluster 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_cluster 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_cluster 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