snmp
----
.. osdx:cfgcmd:: service snmp
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Enable Simple Network Management Protocol (SNMP)
.. osdx:cfgcmd:: service snmp community
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Create a new community
:arg txt:
Community name (1-32)
:instances: Multiple
.. osdx:cfgcmd:: service snmp community client
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg ipv4:
IP address of SNMP client allowed to contact system
:arg ipv6:
IP address of SNMP client allowed to contact system
:arg ipv4net:
IP address of SNMP client allowed to contact system
:arg ipv6net:
IP address of SNMP client allowed to contact system
:instances: Multiple
.. osdx:cfgcmd:: service snmp community notify-traps
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Set notify traps for this community
.. osdx:cfgcmd:: service snmp community notify-traps advisor
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg id:
Advisors to be notified for this community
:instances: Multiple
.. osdx:cfgcmd:: service snmp community notify-traps alarm
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg id:
Alarms to be notified for this community
:instances: Multiple
.. osdx:cfgcmd:: service snmp community notify-traps link-down
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Link-down notification for this community. Reports an error in one of the router interfaces
.. osdx:cfgcmd:: service snmp community notify-traps link-up
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Link-up notification for this community. Notifies that the down interface is now up and operating again
.. osdx:cfgcmd:: service snmp community notify-traps mtc-probe
.. raw:: html
M10-Smart
M2
Atlas840
RS420
AresC640
Power-switch (MTC+) notification for this community
.. osdx:cfgcmd:: service snmp community notify-traps mtc-track
.. raw:: html
M10-Smart
M2
Atlas840
RS420
AresC640
Power-switch (MTC+) notification for this community
.. osdx:cfgcmd:: service snmp community read-write
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Enable read-write access for this community. If this configuration isn't set, the community will only be able to read.
.. osdx:cfgcmd:: service snmp community view
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Set a view for this community
:ref Reference: service snmp view *
.. osdx:cfgcmd:: service snmp engine-id
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Set Engine ID (SNMPv3)
:arg txt:
Hex value (e.g., 0x80000009010a0101c1)
.. osdx:cfgcmd:: service snmp listen
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Endpoints to listen for incoming SNMP requests (by default, on all interfaces on port 161)
.. osdx:cfgcmd:: service snmp listen address
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg ipv4:
IPv4/IPv6 address to listen for incoming requests
:arg ipv6:
IPv4/IPv6 address to listen for incoming requests
:Local IP address:
:instances: Multiple
.. osdx:cfgcmd:: service snmp listen address port
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Port to listen for incoming requests
:arg u32:
Numeric IP port (1-32767)
:arg u32:
Numeric IP port (60000-65535)
:instances: Multiple
.. osdx:cfgcmd:: service snmp listen port
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Port to listen for incoming requests (on all interfaces)
:arg u32:
Numeric IP port (1-32767)
:arg u32:
Numeric IP port (60000-65535)
:instances: Multiple
.. osdx:cfgcmd:: service snmp local-address
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Local IP address used to generate notifications
:arg ipv4:
IP address
:arg ipv6:
IPv6 address
:Local IP address:
.. osdx:cfgcmd:: service snmp local-vrf
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Bind to local Virtual Routing and Forwarding domain name
:ref Reference: system vrf *
.. osdx:cfgcmd:: service snmp log-level
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
SNMP log-level
:arg emerg:
Emergency messages
:arg alert:
Urgent messages
:arg crit:
Critical messages
:arg err:
Error messages
:arg warning:
Warning messages
:arg notice:
Messages for further investigation
:arg info:
Informational messages
:arg debug:
Debug messages
.. osdx:cfgcmd:: service snmp trap-target
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Address of notification target
:arg ipv4:
IPv4 address
:arg ipv6:
IPv6 address
:arg fqdn:
Hostname
:instances: Multiple
:ref Required:
.. osdx:cfgcmd:: service snmp trap-target version
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Version of SNMP to use
:instances: Unique
.. osdx:cfgcmd:: service snmp trap-target version v1
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Use SNMPv1 (only traps notifications)
:ref Required: service snmp community *
:ref Required:
.. osdx:cfgcmd:: service snmp trap-target version v1 community
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Community used when sending notification information
:ref Reference: service snmp community *
.. osdx:cfgcmd:: service snmp trap-target version v1 port
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Destination port used for notification
:arg u32:
Numeric IP port (1-65535)
.. osdx:cfgcmd:: service snmp trap-target version v1 source
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg ipv4:
Local IP address to use as source for notifications
:arg ipv6:
Local IP address to use as source for notifications
:Local IP address:
.. osdx:cfgcmd:: service snmp trap-target version v2c
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Use SNMPv2c
:ref Required: service snmp community *
.. osdx:cfgcmd:: service snmp trap-target version v2c community
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Community used when sending notification information
:ref Reference: service snmp community *
.. osdx:cfgcmd:: service snmp trap-target version v2c port
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Destination port used for notification
:arg u32:
Numeric IP port (1-65535)
.. osdx:cfgcmd:: service snmp trap-target version v2c type
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Type of this notification
:arg trap:
Traps are one-way communication
:arg inform:
Informs imply receiver acknowledgement
.. osdx:cfgcmd:: service snmp trap-target version v3
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Use SNMPv3
:ref Required: service snmp user *
.. osdx:cfgcmd:: service snmp trap-target version v3 port
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Destination port used for notification
:arg u32:
Numeric IP port (1-65535)
.. osdx:cfgcmd:: service snmp trap-target version v3 type
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Type of this notification
:arg trap:
Traps are one-way communication
:arg inform:
Informs imply receiver acknowledgement
.. osdx:cfgcmd:: service snmp trap-target version v3 user
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
SNMPv3 user used when sending notification information
:ref Reference: service snmp user *
.. osdx:cfgcmd:: service snmp user
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Create a new SNMPv3 user
:arg txt:
Username (1-32)
:instances: Multiple
.. osdx:cfgcmd:: service snmp user authentication
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Enable authentication
:ref Required:
:ref Required:
.. osdx:cfgcmd:: service snmp user authentication encrypted-password
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg password:
Encrypted authentication key
.. osdx:cfgcmd:: service snmp user authentication password
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Authentication key
:arg txt:
Passphrase (between 8 and 32 characters) (8-32)
.. osdx:cfgcmd:: service snmp user authentication protocol
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg txt:
Authentication protocol
.. osdx:cfgcmd:: service snmp user notify-traps
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Set notify traps for this user
.. osdx:cfgcmd:: service snmp user notify-traps advisor
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg id:
Advisors to be notified for this user
:instances: Multiple
.. osdx:cfgcmd:: service snmp user notify-traps alarm
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg id:
Alarms to be notified for this user
:instances: Multiple
.. osdx:cfgcmd:: service snmp user notify-traps link-down
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Link-down notification for this user. Reports an error in one of the router interfaces
.. osdx:cfgcmd:: service snmp user notify-traps link-up
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Link-up notification for this user. Notifies that the down interface is now up and operating again
.. osdx:cfgcmd:: service snmp user notify-traps mtc-probe
.. raw:: html
M10-Smart
M2
Atlas840
RS420
AresC640
Power-switch (MTC+) notification for this user
.. osdx:cfgcmd:: service snmp user notify-traps mtc-track
.. raw:: html
M10-Smart
M2
Atlas840
RS420
AresC640
Power-switch (MTC+) notification for this user
.. osdx:cfgcmd:: service snmp user privacy
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Enable privacy
:ref Required:
:ref Required:
.. osdx:cfgcmd:: service snmp user privacy encrypted-password
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg password:
Encrypted text password
.. osdx:cfgcmd:: service snmp user privacy password
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Privacy key
:arg txt:
Passphrase (between 8 and 32 characters) (8-32)
.. osdx:cfgcmd:: service snmp user privacy protocol
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg txt:
Privacy protocol
.. osdx:cfgcmd:: service snmp user read-write
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Enable read-write access for this user. If this configuration isn't set, the user will only be able to read.
.. osdx:cfgcmd:: service snmp user view
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Set a view for this user
:ref Reference: service snmp view *
.. osdx:cfgcmd:: service snmp view
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Create a subset of the overall OID tree
:arg txt:
View name (1-32)
:instances: Multiple
:ref Required:
.. osdx:cfgcmd:: service snmp view oid
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
OID to include/exclude from the view
:arg txt:
OID (e.g., 1.2.1.2)
:instances: Multiple
.. osdx:cfgcmd:: service snmp view oid mask
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
Bit-mask to set significant subidentifiers for this OID
:arg txt:
OID bit-mask (e.g., 00:0f:aa)
.. osdx:cfgcmd:: service snmp view oid type
.. raw:: html
SDE
M10-Smart
M2
Atlas840
RS420
AresC640
:arg txt:
Include/exclude this OID