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

Class snmp_alarm_config

java.lang.Object

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

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

public class snmp_alarm_config
extends base_resource

Configuration for SNMP Alarm Configurations 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_alarm_config()

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 snmp_alarm_config resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of snmp_alarm_config resources.
static long	count(nitro_service service) Use this API to count the snmp_alarm_config resources configured on NetScaler SDX.
Boolean	get_enable() Enable Alarm
static snmp_alarm_config[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of snmp_alarm_config resources.
static snmp_alarm_config[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of snmp_alarm_config resources.
String	get_name() Alarm 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_severity() Alarm severity.
static snmp_alarm_config[]	get(nitro_service client) Use this operation to get snmp alarm configuration.
static snmp_alarm_config	get(nitro_service client, snmp_alarm_config resource) Use this operation to get snmp alarm configuration.
void	set_enable(Boolean enable) Enable Alarm
void	set_name(String name) Alarm Name
void	set_severity(String severity) Alarm severity.
static snmp_alarm_config	update(nitro_service client, snmp_alarm_config resource) Use this operation to modify snmp alarm configuration.
static snmp_alarm_config[]	update(nitro_service client, snmp_alarm_config[] resources) Use this operation to modify snmp alarm configuration 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_alarm_config

public snmp_alarm_config()

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_enable

public void set_enable(Boolean enable)

 Enable Alarm
 

get_enable

public Boolean get_enable()

 Enable Alarm
 

set_name

public void set_name(String name)

 Alarm Name
 

get_name

public String get_name()

 Alarm Name
 

set_severity

public void set_severity(String severity)

 Alarm severity. Supported values: Critical, Major, Minor, Warning, Informational 
 

get_severity

public String get_severity()

 Alarm severity. Supported values: Critical, Major, Minor, Warning, Informational 
 

get

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

 Use this operation to get snmp alarm configuration.
 

Throws:

Exception

get

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

Use this operation to get snmp alarm configuration.

Throws:

Exception

update

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

 Use this operation to modify snmp alarm configuration.
 

Throws:

Exception

update

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

 Use this operation to modify snmp alarm configuration in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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