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

Class snmp_trap

java.lang.Object

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

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

public class snmp_trap
extends base_resource

Configuration for SNMP Trap Destinations 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_trap()

Method Summary

Methods

Modifier and Type	Method and Description
static snmp_trap	add(nitro_service client, snmp_trap resource) Use this operation to add snmp trap destination.
static snmp_trap[]	add(nitro_service client, snmp_trap[] resources) Use this operation to add snmp trap destination in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of snmp_trap resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of snmp_trap resources.
static long	count(nitro_service service) Use this API to count the snmp_trap resources configured on NetScaler SDX.
static snmp_trap	delete(nitro_service client, snmp_trap resource) Use this operation to delete snmp trap destination.
static snmp_trap[]	delete(nitro_service client, snmp_trap[] resources) Use this operation to delete snmp trap destination in bulk.
String	get_community() Community Name
Integer	get_dest_port() Destination Port
String	get_dest_server() Trap Destination Server Address
static snmp_trap[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of snmp_trap resources.
static snmp_trap[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of snmp_trap resources.
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.
static snmp_trap[]	get(nitro_service client) Use this operation to get snmp trap destination details.
static snmp_trap	get(nitro_service client, snmp_trap resource) Use this operation to get snmp trap destination details.
void	set_community(String community) Community Name
void	set_dest_port(Integer dest_port) Destination Port
void	set_dest_server(String dest_server) Trap Destination Server Address
static snmp_trap	update(nitro_service client, snmp_trap resource) Use this operation to modify snmp trap destination.
static snmp_trap[]	update(nitro_service client, snmp_trap[] resources) Use this operation to modify snmp trap destination 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_trap

public snmp_trap()

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_community

public void set_community(String community)

 Community Name
 

get_community

public String get_community()

 Community Name
 

set_dest_server

public void set_dest_server(String dest_server)

 Trap Destination Server Address
 

get_dest_server

public String get_dest_server()

 Trap Destination Server Address
 

set_dest_port

public void set_dest_port(Integer dest_port)

 Destination Port
 

get_dest_port

public Integer get_dest_port()

 Destination Port
 

add

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

 Use this operation to add snmp trap destination.
 

Throws:

Exception

add

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

 Use this operation to add snmp trap destination in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete snmp trap destination.
 

Throws:

Exception

delete

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

 Use this operation to delete snmp trap destination in bulk.
 

Throws:

Exception

get

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

 Use this operation to get snmp trap destination details.
 

Throws:

Exception

get

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

Use this operation to get snmp trap destination details.

Throws:

Exception

update

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

 Use this operation to modify snmp trap destination.
 

Throws:

Exception

update

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

 Use this operation to modify snmp trap destination in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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