Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT trapReceiverService/receiver

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not update receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release.

Updates an existing northbound trap receiver destination and the associated notification policy.

Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions:

  • The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the policy is associated with any other receiver, then an explicit error will be thrown, and the receiver will not be updated.

  • When the notification receiver is updated, then one additional policy may be created, depending on the provided alarm category filters:

    If the policy does not currently have default or "System" alarm categories, and they are added, an additional policy will be created. The notification policy will contain a filter on the event types which are in the selected alarm categories and have a severity matching the severities filter. The name of the policy is the same as the notification receiver name.

    If the policy does not currently have product family categories, and they are added, an additional policy will be created for notification receiver. This notification policy will contain filters on the selected product families and alarm severities. The name of the policy is the notification receiver name plus the "_PF" suffix.

    Note that after the update, the notification receiver won't be supported by the other Trap Receiver APIs if it is associated with two notification policies.
  • The notification receiver name must be unique. Created notification policy has the same name as notification receiver's therefore there should not be existing notification policy with this name.

  • The "Clear" severity was deprecated. It will be silently ignored if passed in.

Since Product Version: 3.0

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Resource URL

/webacs/api/v2/op/trapReceiverService/receiver

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

categoryFilters String[]

The list of event categories to be processed

community String

The SNMP Community name

id long

The internal id of the trap receiver

name String

The server name

port int

Port Number

serverAddress String

The IP address of the server

severityFilters String[]

The list of event severity to be processed

snmpV3AuthPassphrase String

SNMP v3 authentication password

snmpV3AuthType SnmpV3AuthType

SNMP v3 authentication type

  • NONE
  • HMACMD5
  • HMACSHA

snmpV3PrivPassphrase String

SNMP v3 password for encryption the protocol messages

snmpV3PrivType SnmpV3PrivType

SNMP v3 type of encryption the protocol messages

  • NONE
  • DES
  • AES128
  • AES192
  • AES256

snmpV3UserName String

SNMP v3 authentication user name

snmpVersion SnmpVersionEnum

SNMP version

  • VERSION_1
  • VERSION_2C
  • VERSION_3

snmpv3AuthMode SnmpV3AuthMode

SNMP v3 security level

  • NoAuthNoPriv
  • AuthNoPriv
  • AuthPriv

transportType String

Receiver notification type: TCP or UDP

Response Parameters

Attribute Description

result String

The operation result message

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://localhost/webacs/api/v2/op/trapReceiverService/receiver

<?xml version="1.0" ?>
<trapReceiver>
  <categoryFilters>
    <categoryFilter>String value</categoryFilter>
  </categoryFilters>
  <community>String value</community>
  <id>2</id>
  <name>String value</name>
  <port>1</port>
  <serverAddress>String value</serverAddress>
  <severityFilters>
    <severityFilter>String value</severityFilter>
  </severityFilters>
  <snmpV3AuthMode>NoAuthNoPriv</snmpV3AuthMode>
  <snmpV3AuthPassphrase>String value</snmpV3AuthPassphrase>
  <snmpV3AuthType>NONE</snmpV3AuthType>
  <snmpV3PrivPassphrase>String value</snmpV3PrivPassphrase>
  <snmpV3PrivType>NONE</snmpV3PrivType>
  <snmpV3UserName>String value</snmpV3UserName>
  <snmpVersion>VERSION_1</snmpVersion>
  <transportType>String value</transportType>
</trapReceiver>

Sample JSON Request Payload

https://localhost/webacs/api/v2/op/trapReceiverService/receiver.json

{
  "trapReceiver" : {
    "categoryFilters" : {
      "categoryFilter" : [ "String value" ]
    },
    "community" : "String value",
    "id" : 2,
    "name" : "String value",
    "port" : 1,
    "serverAddress" : "String value",
    "severityFilters" : {
      "severityFilter" : [ "String value" ]
    },
    "snmpV3AuthMode" : "NoAuthNoPriv",
    "snmpV3AuthPassphrase" : "String value",
    "snmpV3AuthType" : "NONE",
    "snmpV3PrivPassphrase" : "String value",
    "snmpV3PrivType" : "NONE",
    "snmpV3UserName" : "String value",
    "snmpVersion" : "VERSION_1",
    "transportType" : "String value"
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v2/op/trapReceiverService/receiver

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/trapReceiverService/receiver" rootUrl="https://localhost/webacs/api/v2/op">
  <trapReceiverOutput>
    <result>String value</result>
  </trapReceiverOutput>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v2/op/trapReceiverService/receiver.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v2/op/trapReceiverService/receiver",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v2/op",
    "trapReceiverOutput" : [ {
      "result" : "String value"
    } ]
  }
}