SNMP
URLs Summary
URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
/rest/v1/running/snmp-communities/{community-name} | Y | Y | N | N | Y |
/rest/v1/running/snmp-sources/{source-ip}/{udp-port}/{vrf-name} | Y | Y | N | N | Y |
/rest/v1/running/snmp-traps/{trap-type} | Y | N | N | Y | Y |
/rest/v1/running/snmp-users/{user-name} | Y | Y | N | N | Y |
Examples
Create a SNMP community
POST HTTPS://{switch IP}/rest/v1/running/snmp-communities
{
"community-name": "test"
}Create an SNMP source
POST HTTPS://{switch IP}/rest/v1/running/snmp-sources
{
"source-ip": "10.0.0.100",
"udp-port": "162",
"vrf-name": "default"
}Replace a SNMP trap
PUT HTTPS://{switch IP}/rest/v1/running/snmp-traps/v2c
{
"trap-ip": "10.50.1.2",
"udp-port": 163,
"vrf-name": "Vrftest1",
"community-name": "default"
}Create a SNMP user
POST rest/v1/running/snmp-users
{
"user-name": "test3",
"authen-mode": "SHA",
"authen-key": "123456789",
"privacy-mode": "AES",
"privacy-key": "987654321"
}Properties Descriptions
SNMP communities
Tree Diagrams
+--rw snmp-communities
| +--rw snmp-community* [community-name]
| +--rw community-nameTable of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
snmp-communities | M | | Path-only node, has no configurable value. |
community-name | M | string | (sub-property of snmp-communities) SNMP agent community configuration, "public" is the default value and is not allowed to be configured |
SNMP users
Tree Diagrams
+--rw snmp-users
| +--rw snmp-user* [user-name]
| +--rw user-name
| +--rw authen-mode?
| +--rw authen-key
| +--rw privacy-mode?
| +--rw privacy-key
| +--ro user-type?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
snmp-users | M | | Path-only node, has no configurable value. |
user-name | M | string | (sub-property of snmp-users) |
authen-mode | O | "MD5" "SHA" | (sub-property of snmp-users) Enables authentication of the user. |
authen-key | CM | a string of letters, digits, underscores, or hyphens (0 or more characters) | (sub-property of snmp-users) Only applicable when authen-mode. The key used in MD5 or SHA based authentication algorithms for user authentication. |
privacy-mode | CO | "DES" "AES" | (sub-property of snmp-users) Only applicable when authen-mode. Enables privacy of the user. |
privacy-key | CM | a string of letters, digits, underscores, or hyphens (0 or more characters) | (sub-property of snmp-users) Only applicable when privacy-mode. A secret key used by the DES or AES based encryption algorithm for authentication password. |
user-type | RO | "noAuthNoPriv" "AuthNoPriv" "Priv" | (sub-property of snmp-users) |
SNMP sources
Tree Diagrams
+--rw snmp-sources
| +--rw snmp-source* [source-ip udp-port vrf-name]
| +--rw source-ip
| +--rw udp-port
| +--rw vrf-nameTable of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
snmp-sources | M | | Path-only node, has no configurable value. |
source-ip | M | A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of snmp-sources) |
udp-port | M | 0..65535 | (sub-property of snmp-sources) Set snmp source udp port, default: 161 |
vrf-name | M | "default" vrf name | (sub-property of snmp-sources) Set snmp source vrf, default: default(if use default, will set '' in CONFIG_DB) |
SNMP traps
Tree Diagrams
+--rw snmp-traps
+--rw snmp-trap* [trap-type]
+--rw trap-type
+--rw trap-ip
+--rw vrf-name?
+--rw udp-port?
+--rw community-name?
+--rw user-nameTable of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
snmp-traps | M | | Path-only node, has no configurable value. |
trap-type | M | "v1" "v2c" "v3" | (sub-property of snmp-traps) |
trap-ip | M | A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of snmp-traps) |
vrf-name | O | "default" vrf name | (sub-property of snmp-traps) |
udp-port | O | 0..65535 | (sub-property of snmp-traps) Default value: 162 |
community-name | CO | string | (sub-property of snmp-traps) Only applicable when trap-type = "v1" or trap-type = "v2c". |
user-name | CM | string | (sub-property of snmp-traps) Only applicable when trap-type = "v3". |