com.quantum.dxi.rest.notification

Class SnmpCommunities

java.lang.Object

Base

com.quantum.dxi.rest.notification.SnmpCommunities

public class SnmpCommunities
extends Base

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

The schema that defines the SnmpCommunities resource is defined below.

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

    <xs:element name="SnmpCommunity">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string"/>
                <xs:element name="IpAddress" type="xs:string"/>
                <xs:element name="Netmask" type="xs:string"/>
                <xs:element name="AccessType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Get"/>
                            <xs:enumeration value="GetSet"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Enabled" type="xs:boolean"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="SnmpCommunityColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Name"/>
            <xs:enumeration value="IpAddress"/>
            <xs:enumeration value="Netmask"/>
            <xs:enumeration value="AccessType"/>
            <xs:enumeration value="Enabled"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
SnmpCommunities()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addSnmpCommunity(javax.servlet.http.HttpServletRequest request, SnmpCommunity snmpCommunity, String errorType) POST /rest/SnmpCommunities
void	deleteSnmpCommunity(javax.servlet.http.HttpServletRequest request, String name, String errorType) DELETE /rest/SnmpCommunities/{name}
com.quantum.dxi.dao.types.SnmpCommunities	getSnmpCommunities(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString, String errorType) GET /rest/SnmpCommunities
NumericScalarType	getSnmpCommunitiesCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/SnmpCommunities/getRowCount
SnmpCommunity	getSnmpCommunity(javax.servlet.http.HttpServletRequest request, String name, String errorType) GET /rest/SnmpCommunities/{name}
javax.ws.rs.core.Response	updateSnmpCommunity(javax.servlet.http.HttpServletRequest request, String name, SnmpCommunity snmpCommunity, String errorType) PUT /rest/SnmpCommunities

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpCommunities

public SnmpCommunities()

Method Detail

getSnmpCommunitiesCount

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

GET /rest/SnmpCommunities/getRowCount

Get the number of SNMP Communities on the system.

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

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

Since:

1.1

getSnmpCommunities

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

GET /rest/SnmpCommunities

Get the SNMP Communities on the system.

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

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

Since:

1.1

getSnmpCommunity

public SnmpCommunity getSnmpCommunity(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      String name,
                                      String errorType)

GET /rest/SnmpCommunities/{name}

Get the SNMP Community on the system identified by {name}.

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

Since:

1.1

deleteSnmpCommunity

public void deleteSnmpCommunity(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String name,
                                String errorType)

DELETE /rest/SnmpCommunities/{name}

Remove the SNMP Community identified by {name} from the system.

Since:

1.1

updateSnmpCommunity

public javax.ws.rs.core.Response updateSnmpCommunity(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String name,
                                                     SnmpCommunity snmpCommunity,
                                                     String errorType)

PUT /rest/SnmpCommunities

Edit a SNMP Community on the system.

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

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

Since:

1.1

addSnmpCommunity

public javax.ws.rs.core.Response addSnmpCommunity(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  SnmpCommunity snmpCommunity,
                                                  String errorType)

POST /rest/SnmpCommunities

Add a SNMP Community on the system.

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

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

Since:

1.1