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

Class device_profile

java.lang.Object

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

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

Direct Known Subclasses:

br_device_profile, ns_device_profile

public class device_profile
extends base_resource

Configuration for Device Profile resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
device_profile()

Method Summary

Methods

Modifier and Type	Method and Description
static device_profile	add(nitro_service client, device_profile resource) Use this operation to add device profile.
static device_profile[]	add(nitro_service client, device_profile[] resources) Use this operation to add device profile in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of device_profile resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of device_profile resources.
static long	count(nitro_service service) Use this API to count the device_profile resources configured on NetScaler SDX.
static device_profile	delete(nitro_service client, device_profile resource) Use this operation to delete device profile(s).
static device_profile[]	delete(nitro_service client, device_profile[] resources) Use this operation to delete device profile(s) in bulk.
static device_profile[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of device_profile resources.
static device_profile[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of device_profile resources.
String	get_id() Id is system generated key for all the device profiles
Boolean	get_is_default() True, if this profile is system generated and can not be deleted
String	get_name() Profile 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_password() Password for this profile
String	get_snmpauthpassword() SNMP v3 auth password for this profile
String	get_snmpauthprotocol() SNMP v3 auth protocol for this profile
String	get_snmpcommunity() SNMP community for this profile
String	get_snmpprivpassword() SNMP v3 priv password for this profile
String	get_snmpprivprotocol() SNMP v3 priv protocol for this profile
String	get_snmpsecuritylevel() SNMP v3 security level for this profile
String	get_snmpsecurityname() SNMP v3 security name for this profile
String	get_snmpversion() SNMP version for this profile
String	get_type() Profile Type, This must be with in specified supported profiles (NS / Xen)
String	get_username() User Name for this profile
static device_profile[]	get(nitro_service client) Use this operation to get device profiles.
static device_profile	get(nitro_service client, device_profile resource) Use this operation to get device profiles.
void	set_id(String id) Id is system generated key for all the device profiles
void	set_name(String name) Profile Name
void	set_password(String password) Password for this profile
void	set_snmpauthpassword(String snmpauthpassword) SNMP v3 auth password for this profile
void	set_snmpauthprotocol(String snmpauthprotocol) SNMP v3 auth protocol for this profile
void	set_snmpcommunity(String snmpcommunity) SNMP community for this profile
void	set_snmpprivpassword(String snmpprivpassword) SNMP v3 priv password for this profile
void	set_snmpprivprotocol(String snmpprivprotocol) SNMP v3 priv protocol for this profile
void	set_snmpsecuritylevel(String snmpsecuritylevel) SNMP v3 security level for this profile
void	set_snmpsecurityname(String snmpsecurityname) SNMP v3 security name for this profile
void	set_snmpversion(String snmpversion) SNMP version for this profile
void	set_type(String type) Profile Type, This must be with in specified supported profiles (NS / Xen)
void	set_username(String username) User Name for this profile
static device_profile	update(nitro_service client, device_profile resource) Use this operation to modify device profile.
static device_profile[]	update(nitro_service client, device_profile[] resources) Use this operation to modify device profile 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.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

device_profile

public device_profile()

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_is_default

public Boolean get_is_default()

 True, if this profile is system generated and can not be deleted
 

set_name

public void set_name(String name)

 Profile Name
 

get_name

public String get_name()

 Profile Name
 

set_type

public void set_type(String type)

 Profile Type, This must be with in specified supported profiles (NS / Xen)
 

get_type

public String get_type()

 Profile Type, This must be with in specified supported profiles (NS / Xen)
 

set_id

public void set_id(String id)

 Id is system generated key for all the device profiles
 

get_id

public String get_id()

 Id is system generated key for all the device profiles
 

set_snmpauthprotocol

public void set_snmpauthprotocol(String snmpauthprotocol)

 SNMP v3 auth protocol for this profile
 

get_snmpauthprotocol

public String get_snmpauthprotocol()

 SNMP v3 auth protocol for this profile
 

set_snmpsecurityname

public void set_snmpsecurityname(String snmpsecurityname)

 SNMP v3 security name for this profile
 

get_snmpsecurityname

public String get_snmpsecurityname()

 SNMP v3 security name for this profile
 

set_snmpprivprotocol

public void set_snmpprivprotocol(String snmpprivprotocol)

 SNMP v3 priv protocol for this profile
 

get_snmpprivprotocol

public String get_snmpprivprotocol()

 SNMP v3 priv protocol for this profile
 

set_username

public void set_username(String username)

 User Name for this profile
 

get_username

public String get_username()

 User Name for this profile
 

set_password

public void set_password(String password)

 Password for this profile
 

get_password

public String get_password()

 Password for this profile
 

set_snmpsecuritylevel

public void set_snmpsecuritylevel(String snmpsecuritylevel)

 SNMP v3 security level for this profile
 

get_snmpsecuritylevel

public String get_snmpsecuritylevel()

 SNMP v3 security level for this profile
 

set_snmpcommunity

public void set_snmpcommunity(String snmpcommunity)

 SNMP community for this profile
 

get_snmpcommunity

public String get_snmpcommunity()

 SNMP community for this profile
 

set_snmpprivpassword

public void set_snmpprivpassword(String snmpprivpassword)

 SNMP v3 priv password for this profile
 

get_snmpprivpassword

public String get_snmpprivpassword()

 SNMP v3 priv password for this profile
 

set_snmpversion

public void set_snmpversion(String snmpversion)

 SNMP version for this profile
 

get_snmpversion

public String get_snmpversion()

 SNMP version for this profile
 

set_snmpauthpassword

public void set_snmpauthpassword(String snmpauthpassword)

 SNMP v3 auth password for this profile
 

get_snmpauthpassword

public String get_snmpauthpassword()

 SNMP v3 auth password for this profile
 

add

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

 Use this operation to add device profile.
 

Throws:

Exception

add

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

 Use this operation to add device profile in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete device profile(s).
 

Throws:

Exception

delete

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

 Use this operation to delete device profile(s) in bulk.
 

Throws:

Exception

get

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

 Use this operation to get device profiles.
 

Throws:

Exception

get

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

Use this operation to get device profiles.

Throws:

Exception

update

public static device_profile update(nitro_service client,
                    device_profile resource)
                             throws Exception

 Use this operation to modify device profile.
 

Throws:

Exception

update

public static device_profile[] update(nitro_service client,
                      device_profile[] resources)
                               throws Exception

 Use this operation to modify device profile in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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