Update

This implementation of SNMP V1V2 community string updates the SNMP community string entity in Unified CVP.

URI

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

HTTP Method

PUT

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 PUT operation on the service endpoint updates the Syslog configuration of the device. You can only modify the attributes in the entity other than the community name. In case the user changes the list of servers, then the Community String will be updates the servers mentioned in the list and removes the devices not mentioned in the entity's list.

PUT 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

Response Data Structure


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

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

Response Header


HTTP/1.1 200 OK
....
Content-Type: application/xml;charset=utf-8
Date: Mon, 26 Aug 2013 09:51:47 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	Size	UTF-8	Required Field	Possible Values	Additional Validations
name	Represents the community String name.	String	1-128	Yes	Yes	Alphanumeric	Alphanumeric Dot, underscore and hyphens are allowed.
snmpversion	Represents the SNMP version Information.	String	—	No	No	V1 (default), V2C	Only V1 or V2C
acceptfromanyhost	Represents whether to accept requests from any host or not.	Boolean	—	No	No	TRUE(default), FALSE	Only true or false Not case sensitive
hosts	Represents the wrapper for multiple host fields	—	—	—	No	—	Accepted only if acceptfromanyhost=false
host	Represents the management station host IP address	String	—	No	No	—	A valid ip4 address
accessprivilege	Represents the access privileges of the community string.	String	—	No	No	ReadOnly(default), ReadWrite	ReadOnly or ReadWrite Not case sensitive
servers	Represents the Wrapper.	—	—	No	—	—	If empty or null, deploys to all the CVP servers configured.
server	Represents the configured CVP Server IP address.	String	—	No	No	—	A valid ip4 address