com.citrix.sdx.nitro.resource.config.mps

Class host_device

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.mps.managed_device

com.citrix.sdx.nitro.resource.config.mps.host_device

Direct Known Subclasses:

xen

public class host_device
extends managed_device

Configuration for host resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
host_device()

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 host_device resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of host_device resources.
static long	count(nitro_service service) Use this API to count the host_device resources configured on NetScaler SDX.
Double	get_cpu_usage() CPU Usage (%) of host
Boolean	get_enabled() host State
static host_device[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of host_device resources.
static host_device[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of host_device resources.
Double	get_memory_free() Free memory available (MB) in host
Double	get_memory_total() Total memory of host in MB
Double	get_memory_usage() Memory Usage (%) of host
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_number_of_cpu() Number of total CPU of host
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
Double	get_rx() In Throughput (Mbps) of host
Integer	get_ssl_cores_free() Free SSL Cores available in XenServer
Integer	get_ssl_cores_total() Total SSL Cores available in host
Double	get_tx() Out Throughput (Mbps) of host
String	get_uptime() Uptime of host
String	get_uuid() UUID of host
static host_device[]	get(nitro_service client) Use this operation to get host.
static host_device	get(nitro_service client, host_device resource) Use this operation to get host.
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.config.mps.managed_device

add, add, delete, delete, get_act_id, get_description, get_device_family, get_gateway, get_hostname, get_id, get_instance_state, get_ip_address, get_name, get_netmask, get_ping_state, get_profile_name, get_profile_password, get_profile_username, get_reason, get_status, get_type, get_user_driven, get_version, set_description, set_device_family, set_gateway, set_hostname, set_id, set_ip_address, set_name, set_netmask, set_profile_name, set_profile_password, set_profile_username, set_type

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

host_device

public host_device()

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 managed_device

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Overrides:

get_object_id in class managed_device

get_tx

public Double get_tx()

 Out Throughput (Mbps) of host
 

get_memory_total

public Double get_memory_total()

 Total memory of host in MB
 

get_ssl_cores_total

public Integer get_ssl_cores_total()

 Total SSL Cores available in host
 

get_rx

public Double get_rx()

 In Throughput (Mbps) of host
 

get_memory_usage

public Double get_memory_usage()

 Memory Usage (%) of host
 

get_uuid

public String get_uuid()

 UUID of host
 

get_number_of_cpu

public Integer get_number_of_cpu()

 Number of total CPU of host
 

get_memory_free

public Double get_memory_free()

 Free memory available (MB) in host
 

get_uptime

public String get_uptime()

 Uptime of host
 

get_cpu_usage

public Double get_cpu_usage()

 CPU Usage (%) of host
 

get_enabled

public Boolean get_enabled()

 host State
 

get_ssl_cores_free

public Integer get_ssl_cores_free()

 Free SSL Cores available in XenServer
 

get

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

 Use this operation to get host.
 

Throws:

Exception

get

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

Use this operation to get host.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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

Overrides:

get_nitro_response in class managed_device

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.
 

Overrides:

get_nitro_bulk_response in class managed_device

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class managed_device

Parameters:

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

Throws:

Exception