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

Class snmp_user

java.lang.Object

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

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

public class snmp_user
extends base_resource

Configuration for SNMP User resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
snmp_user()

Method Summary

Methods

Modifier and Type	Method and Description
static snmp_user	add(nitro_service client, snmp_user resource) Use this operation to add SNMP User.
static snmp_user[]	add(nitro_service client, snmp_user[] resources) Use this operation to add SNMP User in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of snmp_user resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of snmp_user resources.
static long	count(nitro_service service) Use this API to count the snmp_user resources configured on NetScaler SDX.
static snmp_user	delete(nitro_service client, snmp_user resource) Use this operation to delete SNMP User.
static snmp_user[]	delete(nitro_service client, snmp_user[] resources) Use this operation to delete SNMP User in bulk.
String	get_auth_password() Authentication Password of SNMP User
String	get_auth_protocol_str() Authentication Protocol of SNMP User in string format.(Only for GET request)
Integer	get_auth_protocol() Authentication Protocol of SNMP User.
static snmp_user[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of snmp_user resources.
static snmp_user[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of snmp_user resources.
String	get_name() Name of SNMP User
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_privacy_password() Privacy Password of SNMP User
String	get_privacy_protocol_str() Privacy Protocol of SNMP User in string format.(Only for GET request)
Integer	get_privacy_protocol() Privacy Protocol of SNMP User.
String	get_security_level_str() Security Level of SNMP User in string format.(Only for GET request)
Integer	get_security_level() Security Level of SNMP User.
String	get_view_name() SNMP View Name attached to the SNMP User
static snmp_user[]	get(nitro_service client) Use this operation to get SNMP User details.
static snmp_user	get(nitro_service client, snmp_user resource) Use this operation to get SNMP User details.
void	set_auth_password(String auth_password) Authentication Password of SNMP User
void	set_auth_protocol_str(String auth_protocol_str) Authentication Protocol of SNMP User in string format.(Only for GET request)
void	set_auth_protocol(Integer auth_protocol) Authentication Protocol of SNMP User.
void	set_name(String name) Name of SNMP User
void	set_privacy_password(String privacy_password) Privacy Password of SNMP User
void	set_privacy_protocol_str(String privacy_protocol_str) Privacy Protocol of SNMP User in string format.(Only for GET request)
void	set_privacy_protocol(Integer privacy_protocol) Privacy Protocol of SNMP User.
void	set_security_level_str(String security_level_str) Security Level of SNMP User in string format.(Only for GET request)
void	set_security_level(Integer security_level) Security Level of SNMP User.
void	set_view_name(String view_name) SNMP View Name attached to the SNMP User
static snmp_user	update(nitro_service client, snmp_user resource) Use this operation to modify SNMP User.
static snmp_user[]	update(nitro_service client, snmp_user[] resources) Use this operation to modify SNMP User 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

snmp_user

public snmp_user()

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_security_level

public void set_security_level(Integer security_level)

 Security Level of SNMP User. Values: 0: noAuthNoPriv, 1: authNoPriv, 2: authPriv
 

get_security_level

public Integer get_security_level()

 Security Level of SNMP User. Values: 0: noAuthNoPriv, 1: authNoPriv, 2: authPriv
 

set_auth_password

public void set_auth_password(String auth_password)

 Authentication Password of SNMP User
 

get_auth_password

public String get_auth_password()

 Authentication Password of SNMP User
 

set_privacy_protocol

public void set_privacy_protocol(Integer privacy_protocol)

 Privacy Protocol of SNMP User. Values: 0:noValue, 1: DES, 2: AES
 

get_privacy_protocol

public Integer get_privacy_protocol()

 Privacy Protocol of SNMP User. Values: 0:noValue, 1: DES, 2: AES
 

set_name

public void set_name(String name)

 Name of SNMP User
 

get_name

public String get_name()

 Name of SNMP User
 

set_privacy_password

public void set_privacy_password(String privacy_password)

 Privacy Password of SNMP User
 

get_privacy_password

public String get_privacy_password()

 Privacy Password of SNMP User
 

set_view_name

public void set_view_name(String view_name)

 SNMP View Name attached to the SNMP User
 

get_view_name

public String get_view_name()

 SNMP View Name attached to the SNMP User
 

set_auth_protocol

public void set_auth_protocol(Integer auth_protocol)

 Authentication Protocol of SNMP User. Values: 0:noValue, 1: MD5, 2: SHA1
 

get_auth_protocol

public Integer get_auth_protocol()

 Authentication Protocol of SNMP User. Values: 0:noValue, 1: MD5, 2: SHA1
 

set_security_level_str

public void set_security_level_str(String security_level_str)

 Security Level of SNMP User in string format.(Only for GET request)
 

get_security_level_str

public String get_security_level_str()

 Security Level of SNMP User in string format.(Only for GET request)
 

set_privacy_protocol_str

public void set_privacy_protocol_str(String privacy_protocol_str)

 Privacy Protocol of SNMP User in string format.(Only for GET request)
 

get_privacy_protocol_str

public String get_privacy_protocol_str()

 Privacy Protocol of SNMP User in string format.(Only for GET request)
 

set_auth_protocol_str

public void set_auth_protocol_str(String auth_protocol_str)

 Authentication Protocol of SNMP User in string format.(Only for GET request)
 

get_auth_protocol_str

public String get_auth_protocol_str()

 Authentication Protocol of SNMP User in string format.(Only for GET request)
 

add

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

 Use this operation to add SNMP User.
 

Throws:

Exception

add

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

 Use this operation to add SNMP User in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete SNMP User.
 

Throws:

Exception

delete

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

 Use this operation to delete SNMP User in bulk.
 

Throws:

Exception

get

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

 Use this operation to get SNMP User details.
 

Throws:

Exception

get

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

Use this operation to get SNMP User details.

Throws:

Exception

update

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

 Use this operation to modify SNMP User.
 

Throws:

Exception

update

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

 Use this operation to modify SNMP User in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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