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

Class vm_template

java.lang.Object

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

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

Direct Known Subclasses:

br_vm_template, ns_vm_template

public class vm_template
extends base_resource

Configuration for VM Template resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
vm_template()

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 vm_template resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of vm_template resources.
static long	count(nitro_service service) Use this API to count the vm_template resources configured on NetScaler SDX.
String	get_description() Description of vm_template
String	get_device_family() Device family
static vm_template[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of vm_template resources.
static vm_template[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of vm_template resources.
String	get_id() Id is system generated key for all the VM Templates
String	get_name() Template 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_type() Type of device, (Xen | NS)
String	get_uuid() UUID of Template
static vm_template[]	get(nitro_service client) Use this operation to get VM Template.
static vm_template	get(nitro_service client, vm_template resource) Use this operation to get VM Template.
void	set_device_family(String device_family) Device family
void	set_id(String id) Id is system generated key for all the VM Templates
void	set_name(String name) Template Name
void	set_type(String type) Type of device, (Xen | NS)
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

vm_template

public vm_template()

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_device_family

public void set_device_family(String device_family)

 Device family
 

get_device_family

public String get_device_family()

 Device family
 

set_name

public void set_name(String name)

 Template Name
 

get_name

public String get_name()

 Template Name
 

get_description

public String get_description()

 Description of vm_template
 

get_uuid

public String get_uuid()

 UUID of Template
 

set_id

public void set_id(String id)

 Id is system generated key for all the VM Templates
 

get_id

public String get_id()

 Id is system generated key for all the VM Templates
 

set_type

public void set_type(String type)

 Type of device, (Xen | NS)
 

get_type

public String get_type()

 Type of device, (Xen | NS)
 

get

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

 Use this operation to get VM Template.
 

Throws:

Exception

get

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

Use this operation to get VM Template.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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