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.
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? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/trapReceiverService/listResponse 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
|
snmpV3PrivPassphrase String |
SNMP v3 password for encryption the protocol messages |
snmpV3PrivType SnmpV3PrivType |
SNMP v3 type of encryption the protocol messages
|
snmpV3UserName String |
SNMP v3 authentication user name |
snmpVersion SnmpVersionEnum |
SNMP version
|
snmpv3AuthMode SnmpV3AuthMode |
SNMP v3 security level
|
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://10.56.58.149/webacs/api/v1/op/trapReceiverService/list
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/trapReceiverService/list" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<trapReceiver>
<categoryFilters>
<categoryFilter>String value</categoryFilter>
<categoryFilter>Another 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>
<severityFilter>Another 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>
<trapReceiver>
<categoryFilters>
<categoryFilter>String value</categoryFilter>
<categoryFilter>Another string value</categoryFilter>
</categoryFilters>
<community>Another string value</community>
<id>12</id>
<name>Another string value</name>
<port>11</port>
<serverAddress>Another string value</serverAddress>
<severityFilters>
<severityFilter>String value</severityFilter>
<severityFilter>Another string value</severityFilter>
</severityFilters>
<snmpV3AuthMode>AuthNoPriv</snmpV3AuthMode>
<snmpV3AuthPassphrase>Another string value</snmpV3AuthPassphrase>
<snmpV3AuthType>HMACMD5</snmpV3AuthType>
<snmpV3PrivPassphrase>Another string value</snmpV3PrivPassphrase>
<snmpV3PrivType>DES</snmpV3PrivType>
<snmpV3UserName>Another string value</snmpV3UserName>
<snmpVersion>VERSION_2C</snmpVersion>
<transportType>Another string value</transportType>
</trapReceiver>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/trapReceiverService/list.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/trapReceiverService\/list",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"trapReceiver" : [{
"categoryFilters" : {
"categoryFilter" : ["String value",
"Another string value"]
},
"community" : "String value",
"id" : 2,
"name" : "String value",
"port" : 1,
"serverAddress" : "String value",
"severityFilters" : {
"severityFilter" : ["String value",
"Another string value"]
},
"snmpV3AuthMode" : "NoAuthNoPriv",
"snmpV3AuthPassphrase" : "String value",
"snmpV3AuthType" : "NONE",
"snmpV3PrivPassphrase" : "String value",
"snmpV3PrivType" : "NONE",
"snmpV3UserName" : "String value",
"snmpVersion" : "VERSION_1",
"transportType" : "String value"
},
{
"categoryFilters" : {
"categoryFilter" : ["String value",
"Another string value"]
},
"community" : "Another string value",
"id" : 12,
"name" : "Another string value",
"port" : 11,
"serverAddress" : "Another string value",
"severityFilters" : {
"severityFilter" : ["String value",
"Another string value"]
},
"snmpV3AuthMode" : "AuthNoPriv",
"snmpV3AuthPassphrase" : "Another string value",
"snmpV3AuthType" : "HMACMD5",
"snmpV3PrivPassphrase" : "Another string value",
"snmpV3PrivType" : "DES",
"snmpV3UserName" : "Another string value",
"snmpVersion" : "VERSION_2C",
"transportType" : "Another string value"
}]
}
}