Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET trapReceiverService/list

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not list 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.

Retrieves certain existing northbound trap receiver destinations with the associated notification policy.

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

  • The API will return 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 the API won't return it. Trap receivers that do not meet these restrictions won't be included to the response.

  • Notification Policies provide a more flexible way to configure category, device group, and severity filters.

    When any event type is selected in an alarm category, then the API will include this event category in the list of category filters.

    When any device type is selected under a device product family group, then the API will include this product family in the list of category filters.

    The API returns severity filters as a superset of all of the event type and alarm category severities selected in the notification policy.

  • The "Clear" severity was removed and will no longer be returned by the API.

Since Product Version: 3.0

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v2/op/trapReceiverService/list

Unmodified

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

Response 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

Allowed values:

  • NONE
  • HMACMD5
  • HMACSHA

snmpV3PrivPassphrase String

SNMP v3 password for encryption the protocol messages

snmpV3PrivType SnmpV3PrivType

SNMP v3 type of encryption the protocol messages

Allowed values:

  • NONE
  • DES
  • AES128
  • AES192
  • AES256

snmpV3UserName String

SNMP v3 authentication user name

snmpVersion SnmpVersionEnum

SNMP version

Allowed values:

  • VERSION_1
  • VERSION_2C
  • VERSION_3

snmpv3AuthMode SnmpV3AuthMode

SNMP v3 security level

Allowed values:

  • NoAuthNoPriv
  • AuthNoPriv
  • AuthPriv

transportType String

Receiver notification type: TCP or UDP

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 Response Payload

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

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/trapReceiverService/list" rootUrl="https://localhost/webacs/api/v2/op">
  <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>
</mgmtResponse>

Sample JSON Response Payload

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

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v2/op/trapReceiverService/list",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v2/op",
    "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"
    } ]
  }
}