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

Class managed_device

java.lang.Object

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

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

Direct Known Subclasses:

host_device, vm_device

public class managed_device
extends base_resource

Configuration for Managed Device resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
managed_device()

Method Summary

Methods

Modifier and Type	Method and Description
static managed_device	add(nitro_service client, managed_device resource) Use this operation to add managed device.
static managed_device[]	add(nitro_service client, managed_device[] resources) Use this operation to add managed device in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of managed_device resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of managed_device resources.
static long	count(nitro_service service) Use this API to count the managed_device resources configured on NetScaler SDX.
static managed_device	delete(nitro_service client, managed_device resource) Use this operation to delete managed device.
static managed_device[]	delete(nitro_service client, managed_device[] resources) Use this operation to delete managed device in bulk.
String	get_act_id() Activity Id
String	get_description() Description of managed device
String	get_device_family() Device family
static managed_device[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of managed_device resources.
static managed_device[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of managed_device resources.
String	get_gateway() Default Gateway of managed device
String	get_hostname() Assign hostname to managed device, if this is not provided, name will be set as host name
String	get_id() Id is system generated key for all the managed devices
String	get_instance_state() State of device, UP only if device accessible
String	get_ip_address() IP Address for this managed device
String	get_name() Name of managed device
String	get_netmask() Netmask of managed device
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.
Integer	get_ping_state() PING State of managed device, 0 is not pinging
String	get_profile_name() Device Profile Name that is attached with this managed device
String	get_profile_password() Password specified by the user for this Netscaler.
String	get_profile_username() User Name specified by the user for this Netscaler Instance.
String	get_reason() Reason of failure for this managed device
String	get_status() Status of managed device
String	get_type() Type of device, (Xen | NS)
Boolean	get_user_driven() True if this managed device is specified by user or discovered internally
String	get_version() Device Version
static managed_device[]	get(nitro_service client) Use this operation to get managed devices.
void	set_description(String description) Description of managed device
void	set_device_family(String device_family) Device family
void	set_gateway(String gateway) Default Gateway of managed device
void	set_hostname(String hostname) Assign hostname to managed device, if this is not provided, name will be set as host name
void	set_id(String id) Id is system generated key for all the managed devices
void	set_ip_address(String ip_address) IP Address for this managed device
void	set_name(String name) Name of managed device
void	set_netmask(String netmask) Netmask of managed device
void	set_profile_name(String profile_name) Device Profile Name that is attached with this managed device
void	set_profile_password(String profile_password) Password specified by the user for this Netscaler.
void	set_profile_username(String profile_username) User Name specified by the user for this Netscaler Instance.
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

managed_device

public managed_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 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

get_user_driven

public Boolean get_user_driven()

 True if this managed device is specified by user or discovered internally
 

set_gateway

public void set_gateway(String gateway)

 Default Gateway of managed device
 

get_gateway

public String get_gateway()

 Default Gateway of managed device
 

get_status

public String get_status()

 Status of managed device
 

set_hostname

public void set_hostname(String hostname)

 Assign hostname to managed device, if this is not provided, name will be set as host name 
 

get_hostname

public String get_hostname()

 Assign hostname to managed device, if this is not provided, name will be set as host name 
 

set_netmask

public void set_netmask(String netmask)

 Netmask of managed device
 

get_netmask

public String get_netmask()

 Netmask of managed device
 

set_id

public void set_id(String id)

 Id is system generated key for all the managed devices
 

get_id

public String get_id()

 Id is system generated key for all the managed devices
 

set_ip_address

public void set_ip_address(String ip_address)

 IP Address for this managed device
 

get_ip_address

public String get_ip_address()

 IP Address for this managed device
 

get_instance_state

public String get_instance_state()

 State of device, UP only if device accessible
 

get_ping_state

public Integer get_ping_state()

 PING State of managed device, 0 is not pinging
 

set_device_family

public void set_device_family(String device_family)

 Device family
 

get_device_family

public String get_device_family()

 Device family
 

get_version

public String get_version()

 Device Version
 

get_reason

public String get_reason()

 Reason of failure for this managed device
 

set_name

public void set_name(String name)

 Name of managed device
 

get_name

public String get_name()

 Name of managed device
 

set_description

public void set_description(String description)

 Description of managed device
 

get_description

public String get_description()

 Description of managed device
 

set_type

public void set_type(String type)

 Type of device, (Xen | NS)
 

get_type

public String get_type()

 Type of device, (Xen | NS)
 

set_profile_name

public void set_profile_name(String profile_name)

 Device Profile Name that is attached with this managed device
 

get_profile_name

public String get_profile_name()

 Device Profile Name that is attached with this managed device
 

get_act_id

public String get_act_id()

 Activity Id
 

set_profile_username

public void set_profile_username(String profile_username)

 User Name specified by the user for this Netscaler Instance.
 

get_profile_username

public String get_profile_username()

 User Name specified by the user for this Netscaler Instance.
 

set_profile_password

public void set_profile_password(String profile_password)

 Password specified by the user for this Netscaler.
 

get_profile_password

public String get_profile_password()

 Password specified by the user for this Netscaler.
 

add

public static managed_device add(nitro_service client,
                 managed_device resource)
                          throws Exception

 Use this operation to add managed device.
 

Throws:

Exception

add

public static managed_device[] add(nitro_service client,
                   managed_device[] resources)
                            throws Exception

 Use this operation to add managed device in bulk.
 

Throws:

Exception

delete

public static managed_device delete(nitro_service client,
                    managed_device resource)
                             throws Exception

 Use this operation to delete managed device.
 

Throws:

Exception

delete

public static managed_device[] delete(nitro_service client,
                      managed_device[] resources)
                               throws Exception

 Use this operation to delete managed device in bulk.
 

Throws:

Exception

get

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

 Use this operation to get managed devices.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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

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