Get

This implementation of the SNMP V1V2 community string gets the community string details.

URI

https://<ipaddress>:8111/cvp-config/snmp/community/<id>

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 community string details.

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

Authorization

Basic signaturevalue

Content-type

Application/XML or Application/JSON

Accept

Application/XML or Application/JSON

Parameters

In this implementation the user sends the identifier in the request path parameter.

‘

Response Data Structure

This XML body is passed as the first part of multipart/form-data.


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<community>
  <name>Public_Community</name>
  <snmpversion>V2C</snmpversion>
  <acceptfromanyhost>false</acceptfromanyhost>
  <hosts>
    <host>10.78.26.43</host>
  </hosts>
  <accessprivilege>ReadOnly</accessprivilege>
  <servers>
  </servers>
</community>

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.

Field Names and Data Types Used in the API Parameter
Field Name	Description	Data Type
name	Represents the community string name .	String
snmpversion	Represents the SNMP version information.	String
acceptfromanyhost	Represents Whether to accept requests from any host or not.	Boolean
hosts	Valid only if acceptfromanyhost=true.	Wrapper
host	Represents the management station host IP address.	Wrapper
accessprivilege	Represents the access privileges of the community string.	String
servers	Represents the list of CVP servers configured with this community String.	Wrapper
server	Represents the configured CVP Server IP address .	String