Create a trap destination configuration
Since Product Version: 3.0
Resource URL
/webacs/api/v1/op/trapReceiverService/receiverRequest Payload Parameters
Type | Attribute Name | Description |
---|---|---|
String[] |
categoryFilters |
The list of event categories to be processed |
String |
community |
The SNMP Community name |
long |
id |
The internal id of the trap receiver |
String |
name |
The server name |
int |
port |
Port Number |
String |
serverAddress |
The IP address of the server |
String[] |
severityFilters |
The list of event severity to be processed |
String |
snmpV3AuthPassphrase |
SNMP v3 authentication password |
SnmpV3AuthType |
snmpV3AuthType |
SNMP v3 authentication type Allowed values:
|
String |
snmpV3PrivPassphrase |
SNMP v3 password for encryption the protocol messages |
SnmpV3PrivType |
snmpV3PrivType |
SNMP v3 type of encryption the protocol messages Allowed values:
|
String |
snmpV3UserName |
SNMP v3 authentication user name |
SnmpVersionEnum |
snmpVersion |
SNMP version Allowed values:
|
SnmpV3AuthMode |
snmpv3AuthMode |
SNMP v3 security level Allowed values:
|
String |
transportType |
Receiver notification type: TCP or UDP |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
result |
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://172.25.123.114/webacs/api/v1/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://172.25.123.114/webacs/api/v1/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://172.25.123.114/webacs/api/v1/op/trapReceiverService/receiver
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <trapReceiverOutput> <result>String value</result> </trapReceiverOutput> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/trapReceiverService/receiver.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/trapReceiverService\/receiver", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "trapReceiverOutput" : { "result" : "String value" } } }