List

This implementation of SNMP notification destination fetches the list of all destination details based on the search string.

The following table lists the parameters for both SNMP V1V2 and V3 Notification Destination.

URI

For SNMP V1V2 Notification Destination:

/cvp-config/snmp/destination/v1v2c?q=name:<pattern>*&startindex=<number>&resultsperpage=<number>

For SNMP V3 Notification Destination:

/cvp-config/snmp/destination/v3?q=name:<pattern>*&startindex=<number>&resultsperpage=<number>

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 gets the SNMP v1v2c Notification destination details.

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

The GET operation on the Service endpoint gets the SNMP v3 Notification Destination details.

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

Authorization

Basic signaturevalue

Content-type

Application/XML or Application/JSON

Accept

Application/XML or Application/JSON

Parameters

Identifier in the request path parameter.

Response Data Structure


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <destinations>
        <destination>
            <destname>Public_Dest</destname>
            <ipaddr>127.0.0.1</ipaddr>
            <port>615</port>
               <communityOrUserRef>Public_Community</communityOrUserRef>
            <servers>
                <server>10.78.26.43</server>
            </servers>
        </destination>
    </destinations>
    <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
Content-Length: 0
Date: Mon, 26 Aug 2013 09:15:27 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.

Field Names and Data Types Used in the API Parameter
Field Name	Description	Data Type	UTF-8
destname	This represents the notification destination name.	String	Yes
ipaddr	This represents the ipv4 address of the notification destination host.	String	No
port	This represents the port number of the notification destination host.	Number	No
communityOrUserRef	If the URI ends with v1v2c, specify a valid SNMP community string. If the URI ends with v3, specify a valid SNMP v3 user name.	String	Yes
servers	If this field is empty, the API deploys to all the CVP servers configured.	Wrapper	—
server	This represents the configured CVP Server IP address.	String	No

For more information on code snippets, see Unified CVP API Client Sample Code.