com.quantum.dxi.rest.notification

Class SnmpTrapDestinations

java.lang.Object

Base

com.quantum.dxi.rest.notification.SnmpTrapDestinations

public class SnmpTrapDestinations
extends Base

The SnmpTrapDestinations resource represents SNMP TrapDestinations configued on the system. The SnmpTrapDestinations interface includes services for adding, modifying, deleting, and getting SNMP TrapDestinations.

The schema that defines the SnmpTrapDestinations resource is defined below.

 
    <xs:element name="SnmpTrapDestinations">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="SnmpTrapDestination" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SnmpTrapDestination">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="IpAddress" type="xs:string"/>
                <xs:element name="Name" type="xs:string"/>
                <xs:element name="FailureTrapEnabled" type="xs:boolean"/>
                <xs:element name="WarningTrapEnabled" type="xs:boolean"/>
                <xs:element name="InformationalTrapEnabled" type="xs:boolean"/>
                <xs:element name="AvailableTrapEnabled" type="xs:boolean"/>
                <xs:element name="UnavailableTrapEnabled" type="xs:boolean"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="SnmpTrapDestinationColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="IpAddress"/>
            <xs:enumeration value="Name"/>
            <xs:enumeration value="FailureTrapEnabled"/>
            <xs:enumeration value="WarningTrapEnabled"/>
            <xs:enumeration value="InformationalTrapEnabled"/>
            <xs:enumeration value="AvailableTrapEnabled"/>
            <xs:enumeration value="UnavailableTrapEnabled"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
SnmpTrapDestinations()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addSnmpTrapDestination(javax.servlet.http.HttpServletRequest request, SnmpTrapDestination snmpTrapDestination, java.lang.String errorType) POST /rest/SnmpTrapDestinations
void	deleteSnmpTrapDestination(javax.servlet.http.HttpServletRequest request, java.lang.String ipAddress, java.lang.String errorType) DELETE /rest/SnmpTrapDestinations/{ipAddress}
SnmpTrapDestination	getSnmpTrapDestination(javax.servlet.http.HttpServletRequest request, java.lang.String ipAddress, java.lang.String errorType) GET /rest/SnmpTrapDestinations/{ipAddress}
com.quantum.dxi.dao.types.SnmpTrapDestinations	getSnmpTrapDestinations(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/SnmpTrapDestinations
NumericScalarType	getSnmpTrapDestinationsCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString, java.lang.String errorType) GET /rest/SnmpTrapDestinations/getRowCount
javax.ws.rs.core.Response	testSnmpTrapDestination(javax.servlet.http.HttpServletRequest request, java.lang.String ipAddress, java.lang.String errorType) POST /rest/SnmpTrapDestinations/test/{ipAddress}
javax.ws.rs.core.Response	updateSnmpTrapDestination(javax.servlet.http.HttpServletRequest request, java.lang.String ipAddress, SnmpTrapDestination snmpTrapDestination, java.lang.String errorType) PUT /rest/SnmpTrapDestinations

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnmpTrapDestinations

public SnmpTrapDestinations()

Method Detail

getSnmpTrapDestinationsCount

public NumericScalarType getSnmpTrapDestinationsCount(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      int start,
                                                      int limit,
                                                      java.lang.String filterString,
                                                      java.lang.String errorType)

GET /rest/SnmpTrapDestinations/getRowCount

Get the number of SNMP TrapDestinations on the system.

getSnmpTrapDestinationsCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="SnmpTrapDestinationColumnNameType">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getSnmpTrapDestinations

public com.quantum.dxi.dao.types.SnmpTrapDestinations getSnmpTrapDestinations(@Context
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              int start,
                                                                              int limit,
                                                                              java.lang.String sortColumn,
                                                                              java.lang.String sortDirection,
                                                                              java.lang.String filterString,
                                                                              java.lang.String errorType)

GET /rest/SnmpTrapDestinations

Get the SNMP TrapDestinations on the system.

Response Entity type: <xs:element name="SnmpTrapDestinations">

<xs:element name="SnmpTrapDestinations"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="SnmpTrapDestinationColumnNameType">

Since:

1.1

getSnmpTrapDestination

public SnmpTrapDestination getSnmpTrapDestination(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String ipAddress,
                                                  java.lang.String errorType)

GET /rest/SnmpTrapDestinations/{ipAddress}

Get the SNMP TrapDestination on the system identified by {ipAddress}.

Response Entity type: <xs:element name="SnmpTrapDestination">

Since:

1.1

deleteSnmpTrapDestination

public void deleteSnmpTrapDestination(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      java.lang.String ipAddress,
                                      java.lang.String errorType)

DELETE /rest/SnmpTrapDestinations/{ipAddress}

Remove the SNMP TrapDestination identified by {ipAddress} from the system.

Since:

1.1

updateSnmpTrapDestination

public javax.ws.rs.core.Response updateSnmpTrapDestination(@Context
                                                           javax.servlet.http.HttpServletRequest request,
                                                           java.lang.String ipAddress,
                                                           SnmpTrapDestination snmpTrapDestination,
                                                           java.lang.String errorType)

PUT /rest/SnmpTrapDestinations

Edit a SNMP TrapDestination on the system.

Request Entity type: <xs:element name="SnmpTrapDestination">

Response Entity type: <xs:element name="SnmpTrapDestination">

Since:

1.1

addSnmpTrapDestination

public javax.ws.rs.core.Response addSnmpTrapDestination(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        SnmpTrapDestination snmpTrapDestination,
                                                        java.lang.String errorType)

POST /rest/SnmpTrapDestinations

Add a SNMP TrapDestination on the system.

Request Entity type: <xs:element name="SnmpTrapDestination">

Response Entity type: <xs:element name="SnmpTrapDestination">

Since:

1.1

testSnmpTrapDestination

public javax.ws.rs.core.Response testSnmpTrapDestination(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         java.lang.String ipAddress,
                                                         java.lang.String errorType)

POST /rest/SnmpTrapDestinations/test/{ipAddress}

Send a test SNMP trap from the system to the trap destination identified by {ipAddress}.

Since:

1.1