com.citrix.sdx.nitro.resource.config.xen

Class xen_health_ftw

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.xen.xen_health_ftw

public class xen_health_ftw
extends base_resource

Configuration for FTW Health resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
xen_health_ftw()

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 xen_health_ftw resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen_health_ftw resources.
static long	count(nitro_service service) Use this API to count the xen_health_ftw resources configured on NetScaler SDX.
static xen_health_ftw[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen_health_ftw resources.
static xen_health_ftw[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen_health_ftw resources.
String	get_host_ip_address() Host IP Address
String	get_mapped_port() Mapped Port Name Ex: eth0
String	get_mode() Mode
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.
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_pair_port() Pair Name
String	get_port() Port Name Ex: 10/1
String	get_state() State of the Interface - UP/DOWN
static xen_health_ftw[]	get(nitro_service client) Use this operation to get FTW Status.
void	set_host_ip_address(String host_ip_address) Host IP Address
void	set_mapped_port(String mapped_port) Mapped Port Name Ex: eth0
void	set_mode(String mode) Mode
void	set_pair_port(String pair_port) Pair Name
void	set_port(String port) Port Name Ex: 10/1
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

xen_health_ftw

public xen_health_ftw()

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

set_pair_port

public void set_pair_port(String pair_port)

 Pair Name
 

get_pair_port

public String get_pair_port()

 Pair Name
 

set_mode

public void set_mode(String mode)

 Mode
 

get_mode

public String get_mode()

 Mode
 

set_host_ip_address

public void set_host_ip_address(String host_ip_address)

 Host IP Address
 

get_host_ip_address

public String get_host_ip_address()

 Host IP Address
 

set_mapped_port

public void set_mapped_port(String mapped_port)

 Mapped Port Name Ex: eth0
 

get_mapped_port

public String get_mapped_port()

 Mapped Port Name Ex: eth0
 

set_port

public void set_port(String port)

 Port Name Ex: 10/1
 

get_port

public String get_port()

 Port Name Ex: 10/1
 

get_state

public String get_state()

 State of the Interface - UP/DOWN
 

get

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

 Use this operation to get FTW Status.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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