List

This implementation of SNMP V1V2 community string lists the community string details based on the search string in Unified CVP.

URL

/cvp-config/snmp/community?q=name:<search string begins with>

/cvp-config/snmp/community?q=name:public*&resultsPerPage=50&startIndex=2

/cvp-config/snmp/community (Lists All)

HTTP Method

GET

Input/Output Format

XML or JSON

Throttled

Yes

For more information on throttling, see Unified CVP REST Request Throttling.

Authentication

Yes

Note	To authenticate a request, user must use valid credentials that are configured in the Operations Console, as anonymous requests are rejected.

API Type

Synchronous

Request

The GET operation on the service endpoint lists all the SNMP community string matching the query criteria .

GET https://api.cvp.com:8111/cvp-config/snmp/community/<id>

The following request lists all the community strings

GET https://api.cvp.com:8111/cvp-config/snmp/community

Authorization

Basic signaturevalue

Content-type

Application/XML or Application/JSON

Accept

Application/XML or Application/JSON

Response Data Structure


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <communities>
        <community>
            <name>Public_Community</name>
            <snmpversion>V2C</snmpversion>
            <acceptfromanyhost>false</acceptfromanyhost>
            <hosts>
                <host>10.78.26.43</host>
            </hosts>
            <accessprivilege>readOnly</accessprivilege>
            <servers>
                <server>10.78.26.43</server>
            </servers>
        </community>
    </communities>
    <pageinfo>
        <resultsPerPage>25</resultsPerPage>
        <startIndex>0</startIndex>
        <totalResults>1</totalResults>
    </pageinfo>
</results>

Response Header


Response headers:
HTTP/1.1 200 OK
....
Content-Type: application/xml;charset=utf-8
Date: Mon, 26 Aug 2013 10:53:54 GMT

Response Code

400- Bad request. If the request body is invalid.

400- API error . If the object either does not exist or is stale.

401- Authorization Failure(for example, the user is not authenticated in the web session)

404- Not Found (for example, the resource is deleted and is not found )

406- Not Acceptable(for example, the accept headers sent in the request is not acceptable.

500- Internal Server Error( for example, the connection is broken with the database server or ORM or any other component.

503 Service Unavailable. When the request processing threshold is reached.

For more information on error codes and their descriptions, see Unified CVP API Error Codes.

Security Constraints

Only a Serviceability administrator can perform this operation.