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

Class xen_health_monitor

java.lang.Object

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

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

Direct Known Subclasses:

xen_health_monitor_fan_speed, xen_health_monitor_misc, xen_health_monitor_temp, xen_health_monitor_voltage

public class xen_health_monitor
extends base_resource

Configuration for XenServer Health Monitor (IPMI Sensor) 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_monitor()

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_monitor resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen_health_monitor resources.
static long	count(nitro_service service) Use this API to count the xen_health_monitor resources configured on NetScaler SDX.
String	get_current_value() Current Value of the IPMI Sensor
static xen_health_monitor[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen_health_monitor resources.
static xen_health_monitor[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen_health_monitor resources.
String	get_host_ip_address() Host IP Address
String	get_name() IPMI Sensor Name
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_status() IPMI Sensor Status - OK/ERROR/NA
String	get_unit() Measurement Unit
static xen_health_monitor[]	get(nitro_service client) Use this operation to get the IPMI sensor data.
static xen_health_monitor	get(nitro_service client, xen_health_monitor resource) Use this operation to get the IPMI sensor data.
void	set_current_value(String current_value) Current Value of the IPMI Sensor
void	set_host_ip_address(String host_ip_address) Host IP Address
void	set_name(String name) IPMI Sensor Name
void	set_status(String status) IPMI Sensor Status - OK/ERROR/NA
void	set_unit(String unit) Measurement Unit
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_monitor

public xen_health_monitor()

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_unit

public void set_unit(String unit)

 Measurement Unit
 

get_unit

public String get_unit()

 Measurement Unit
 

set_current_value

public void set_current_value(String current_value)

 Current Value of the IPMI Sensor
 

get_current_value

public String get_current_value()

 Current Value of the IPMI Sensor
 

set_status

public void set_status(String status)

 IPMI Sensor Status - OK/ERROR/NA
 

get_status

public String get_status()

 IPMI Sensor Status - OK/ERROR/NA
 

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_name

public void set_name(String name)

 IPMI Sensor Name
 

get_name

public String get_name()

 IPMI Sensor Name
 

get

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

 Use this operation to get the IPMI sensor data.
 

Throws:

Exception

get

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

Use this operation to get the IPMI sensor data.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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