snmpTrapReceiver

Last Updated : Oct 09, 2020 |
This API is used to configure SNMP Trap Receivers.
Prolog information
Syntax
snmpTrapReceiver list
snmpTrapReceiver add -enabled [true|false] -port [port number] -snmpversion [2c|3] -securityname [name] -authProtocol [None|MD5|SHA] -authPassword [password]-privacyProtocol [None|DES|AES] -privacyPassword [password] -ipaddr [ipaddress]
snmpTrapReceiver modify -id [id retrieved using list function] -enabled [true|false] -port [port no.] -snmpversion [2c|3] -securityname [name] -authProtocol [None|MD5|SHA] -authPassword [password]-privacyProtocol [None|DES|AES] -privacyPassword [password] -ipaddr [ipaddress]
snmpTrapReceiver delete -id [id retrieved using list function]
snmpTrapReceiver generate-agent-authfail-traps [true|false]
For example, snmpTrapReceiver add -enabled true -port 162 -snmpversion 3 -securityname snmpTrap1 -authProtocol SHA -authPassword abcd1234 -privacyProtocol AES -privacyPassword abcd1234 -ipaddr 127.0.0.1
where:
Argument
Description
list
Lists all the configured snmp trap receivers.
add
Adds a new snmp trap receiver.
modify
Modifies an already configured snmp trap receiver.
delete
Deletes a snmp trap receiver.
generate-agent-authfail-traps
Generates agent authentication failure trap.
Return codes:
Return code
Description
4
SNMP version can either be 2c or 3.
5
Version 2c is selected. Authorization protocol or privacy protocol are not applicable.
6
Password is required if protocol is not none.
7
<Parameter name> invalid value .
8
Auth protocol can only be either 'None', 'MD5', or 'SHA'.
9
Password length cannot be less than 6 characters.
10
Privacy protocol can only be either 'None', 'DES' 'AES’.
11
Authorization protocol and password are required.
12
Switch to root user to execute the scrip.
13
Failed to restart service <service name>.
14
<Script name> script failed.