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

Class xen_health_interface

java.lang.Object

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

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

public class xen_health_interface
extends base_resource

Configuration for XenServer Interface 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_interface()

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_interface resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen_health_interface resources.
static long	count(nitro_service service) Use this API to count the xen_health_interface resources configured on NetScaler SDX.
static xen_health_interface[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen_health_interface resources.
static xen_health_interface[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen_health_interface resources.
String	get_host_ip_address() Host IP Address
String	get_mapped_port() Mapped Port Name Ex: eth0
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_port() Port Name Ex: 10/1
Double	get_rx_bytes() Received bytes
Double	get_rx_errors() Receiving errors
Double	get_rx_packets() Received packets
String	get_state() State of the Interface - UP/DOWN
Double	get_tx_bytes() Transmitted bytes
Double	get_tx_errors() Transmission errors
Double	get_tx_packets() Transmitted packets
Integer	get_vf_assigned() Assigned Virtual Functions
Integer	get_vf_total() Total Virtual Functions
static xen_health_interface[]	get(nitro_service client) Use this operation to get health and virtual function statistics for the interface.
static xen_health_interface	get(nitro_service client, xen_health_interface resource) Use this operation to get health and virtual function statistics for the interface.
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_port(String port) Port Name Ex: 10/1
void	set_rx_bytes(Double rx_bytes) Received bytes
void	set_rx_errors(Double rx_errors) Receiving errors
void	set_rx_packets(Double rx_packets) Received packets
void	set_tx_bytes(Double tx_bytes) Transmitted bytes
void	set_tx_errors(Double tx_errors) Transmission errors
void	set_tx_packets(Double tx_packets) Transmitted packets
void	set_vf_assigned(Integer vf_assigned) Assigned Virtual Functions
void	set_vf_total(Integer vf_total) Total Virtual Functions
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_interface

public xen_health_interface()

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_rx_packets

public void set_rx_packets(Double rx_packets)

 Received packets
 

get_rx_packets

public Double get_rx_packets()

 Received packets
 

set_rx_errors

public void set_rx_errors(Double rx_errors)

 Receiving errors
 

get_rx_errors

public Double get_rx_errors()

 Receiving errors
 

set_tx_bytes

public void set_tx_bytes(Double tx_bytes)

 Transmitted bytes
 

get_tx_bytes

public Double get_tx_bytes()

 Transmitted bytes
 

set_rx_bytes

public void set_rx_bytes(Double rx_bytes)

 Received bytes
 

get_rx_bytes

public Double get_rx_bytes()

 Received bytes
 

set_tx_packets

public void set_tx_packets(Double tx_packets)

 Transmitted packets
 

get_tx_packets

public Double get_tx_packets()

 Transmitted packets
 

set_tx_errors

public void set_tx_errors(Double tx_errors)

 Transmission errors
 

get_tx_errors

public Double get_tx_errors()

 Transmission errors
 

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_vf_total

public void set_vf_total(Integer vf_total)

 Total Virtual Functions
 

get_vf_total

public Integer get_vf_total()

 Total Virtual Functions
 

set_port

public void set_port(String port)

 Port Name Ex: 10/1
 

get_port

public String get_port()

 Port Name Ex: 10/1
 

set_vf_assigned

public void set_vf_assigned(Integer vf_assigned)

 Assigned Virtual Functions
 

get_vf_assigned

public Integer get_vf_assigned()

 Assigned Virtual Functions
 

get_state

public String get_state()

 State of the Interface - UP/DOWN
 

get

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

 Use this operation to get health and virtual function statistics for the interface.
 

Throws:

Exception

get

public static xen_health_interface get(nitro_service client,
                       xen_health_interface resource)
                                throws Exception

Use this operation to get health and virtual function statistics for the interface.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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