Update

This implementation of SNMP notification destination updates the SNMP Notification Destination Entity in Unified CVP.

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

Parameters of SNMP Notification Destination Update

URL

For SNMP V1V2 Notification Destination:

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

For SNMP V3 Notification Destination:

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

HTTP Method

PUT

Input/Output Format

XML or JSON

Throttled

Yes.

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

Authentication

Basic signaturevalue

API Type

Synchronous

Request

The PUT operation on the service endpoint updates the SNMP v1v2c Notification Destination in specified devices.

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

The PUT operation on the service endpoint creates the SNMP v3 Notification Destination in specified devices .

PUT 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.

Request Data Structure 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<destination>
    <destname>Public_Dest</destname>
    <ipaddr>127.0.0.1</ipaddr>
    <port>614</port>
    <communityOrUserRef>Public_Community</communityOrUserRef>
    <servers>
        <server>10.78.26.43</server>
    </servers>
</destination>

Response Headers 


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

Size

UTF-8

Required Field

Possible Values

Additional Validations

destname

Represents the notification destination name.

String

1-128

Yes

Yes

Any alphanumerics with dot, underscore and hyphen

Must be alphanumeric

Only dot,underscore and hyphen are special chars allowed.

infrastructure

Represents the server infrastructure section.

String

—

No

Yes

ipv4 address

Must be a valid ip4 address.

primary

Represents the primary Syslog Server.

Number

—

No

No

162 (Default), any valid port numbers

Must be between 1 and 65535

active

Represents the active Syslog Server.

String

—

Yes

Yes

ReadOnly(default), ReadWrite

Must be ReadOnly or ReadWrite

backup

Represents the backup Syslog Server.

Wrapper

—

—

—

—

—

host

Represents the Syslog host name of IP address.

String

3- 50

No

No

—

Must be a valid ip4 address.

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