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

Class xen

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

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

public class xen
extends host_device

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

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 resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen resources.
static long	count(nitro_service service) Use this API to count the xen resources configured on NetScaler SDX.
String	get_bios_version() BIOS Version
String	get_build_date() XenServer Build Date
String	get_build_number() XenServer Build Number
String	get_edition() XenServer Edition
String	get_expiry() XenServer Expiry
static xen[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen resources.
static xen[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen resources.
String	get_iscsi_iqn() iSCSI IQN
String	get_kernel_version() Kernel Version
Double	get_lan_in() LAN In (Mbps)
Double	get_lan_out() LAN Out (Mbps)
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_productcode() XenServer Product Code
String	get_serialnumber() XenServer Serial Number
String	get_supplemental_pack() Supplemental Pack installed on XenServer
String	get_version_long() XenServer Version (full text)
String	get_version_short() XenServer Version
Double	get_wan_in() WAN In (Mbps)
Double	get_wan_out() WAN Out (Mbps)
static xen[]	get(nitro_service client) Use this operation to get XenServers.
static xen	get(nitro_service client, xen resource) Use this operation to get XenServers.
static xen	reboot(nitro_service client, xen resource) Use this operation to reboot XenServer.
static xen[]	reboot(nitro_service client, xen[] resources) Use this operation to reboot XenServer in bulk.
static xen	stop(nitro_service client, xen resource) Use this operation to shutdown XenServer.
static xen[]	stop(nitro_service client, xen[] resources) Use this operation to shutdown XenServer in bulk.
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.host_device

get_cpu_usage, get_enabled, get_memory_free, get_memory_total, get_memory_usage, get_number_of_cpu, get_rx, get_ssl_cores_free, get_ssl_cores_total, get_tx, get_uptime, get_uuid, get

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

xen

public xen()

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 host_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 host_device

get_kernel_version

public String get_kernel_version()

 Kernel Version
 

get_version_short

public String get_version_short()

 XenServer Version
 

get_expiry

public String get_expiry()

 XenServer Expiry
 

get_supplemental_pack

public String get_supplemental_pack()

 Supplemental Pack installed on XenServer
 

get_productcode

public String get_productcode()

 XenServer Product Code
 

get_bios_version

public String get_bios_version()

 BIOS Version
 

get_build_date

public String get_build_date()

 XenServer Build Date
 

get_iscsi_iqn

public String get_iscsi_iqn()

 iSCSI IQN
 

get_version_long

public String get_version_long()

 XenServer Version (full text)
 

get_build_number

public String get_build_number()

 XenServer Build Number
 

get_edition

public String get_edition()

 XenServer Edition
 

get_serialnumber

public String get_serialnumber()

 XenServer Serial Number
 

get_wan_out

public Double get_wan_out()

 WAN Out (Mbps)
 

get_lan_out

public Double get_lan_out()

 LAN Out (Mbps)
 

get_wan_in

public Double get_wan_in()

 WAN In (Mbps)
 

get_lan_in

public Double get_lan_in()

 LAN In (Mbps)
 

reboot

public static xen reboot(nitro_service client,
         xen resource)
                  throws Exception

Use this operation to reboot XenServer.

Throws:

Exception

reboot

public static xen[] reboot(nitro_service client,
           xen[] resources)
                    throws Exception

 Use this operation to reboot XenServer in bulk.
 

Throws:

Exception

stop

public static xen stop(nitro_service client,
       xen resource)
                throws Exception

Use this operation to shutdown XenServer.

Throws:

Exception

stop

public static xen[] stop(nitro_service client,
         xen[] resources)
                  throws Exception

 Use this operation to shutdown XenServer in bulk.
 

Throws:

Exception

get

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

 Use this operation to get XenServers.
 

Throws:

Exception

get

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

Use this operation to get XenServers.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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

Parameters:

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

Throws:

Exception