SNMP Server
The nv unset commands remove the configuration you set with the equivalent nv set commands. This guide only describes an nv unset command if it differs from the nv set command.
In Cumulus Linux 5.10 and earlier, nv set system snmp-server commands are nv set service snmp-server commands.
nv set system snmp-server
Configures SNMP settings on the switch.
nv set system snmp-server state
Turns the SNMP server on or off. You can specify enabled or disabled.
In Cumulus Linux 5.10 and earlier, this command is nv set service snmp-server enable on and nv set service snmp-server enable off.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server state enabled
nv set system snmp-server listening-address <listening-address-id>
Configures the IP address on which the SNMP agent listens. You can set multiple IP addresses.
For security reasons, the listening address is the localhost by default so that the SNMP agent only responds to requests originating on the switch itself.
You can configure an IPv4 or an IPv6 address. To configure the snmpd daemon to listen on all interfaces for either IPv4 or IPv6 UDP port 161 SNMP requests, you can specify a value of all.
Command Syntax
| Syntax | Description |
|---|---|
<listening-address-id> |
The IP address on which the SNMP agent listens. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server listening-address all
nv set system snmp-server listening-address <listening-address-id> vrf <vrf-name>
Configures the VRF for the SNMP listening address.
Command Syntax
| Syntax | Description |
|---|---|
<listening-address-id> |
The IP address on which the SNMP agent listens. |
<vrf-name> |
The VRF for the specified IP address. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server listening-address localhost vrf default
nv set system snmp-server mibs
Configures the SNMP server MIBs. You can specify cumulus-sensor-mib or cumulus-status-mib.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server mibs cumulus-status-mib
nv set system snmp-server readonly-community <readonly-community-id>
Configures the SNMP readonly community string for SNMP requests.
Cumulus Linux disables SNMP authentication for SNMPv1 and SNMPv2c by default. To enable authentication, provide a password (community string) for SNMPv1 or SNMPv2c environments so that the snmpd daemon can respond to requests. By default, this provides access to the full OID tree for such requests, regardless of their source. Cumulus Linux does not set a default password so snmpd does not respond to any requests that arrive unless you set the readonly community password.
nv set system snmp-server readonly-community <readonly-community-id> access <access-id>
Configures the source IP address of the host or network to which you want to restrict requests.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv4 address of the host or network to which you want to restrict access. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community simplepassword access 192.168.200.10/24
nv set system snmp-server readonly-community <readonly-community-id> access <access-id> oid <oid>
Configures the OID tree for which you want to restrict access.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv4 address of the host or network to which you want to restrict access. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community simplepassword access 192.168.200.10/24 oid 1.3.6.1.2.1
nv set system snmp-server readonly-community <readonly-community-id> access <access-id> view <view>
Configures the view (the subset of the OID tree) to which you want to restrict viewing access.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv4 address of the host or network to which you want to restrict access. |
<view> |
The view (subset of the OID tree). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community simplepassword access 192.168.200.10/24 view mysystem
nv set system snmp-server readonly-community-v6 <readonly-community-id>
Configures the SNMP readonly community string for SNMP requests for IPv6.
nv set system snmp-server readonly-community-v6 <readonly-community-id> access <access-id>
Configures the source IPv6 address of the host or network to which you want to restrict requests.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv6 address of the host or network to which you want to restrict access. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community-v6 simplepassword access 2001:db8:1::100/32
nv set system snmp-server readonly-community-v6 <readonly-community-id> access <access-id> oid <oid>
Configures the OID tree for which you want to restrict access for IPv6.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv6 address of the host or network to which you want to restrict access. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community-v6 simplepassword access 2001:db8:1::100/32 oid 1.3.6.1.2.1
nv set system snmp-server readonly-community-v6 <readonly-community-id> access <access-id> view <value>
Configures the view (the subset of the OID tree) to which you want to restrict viewing access for IPv6.
Command Syntax
| Syntax | Description |
|---|---|
<readonly-community-id> |
The SNMP readonly community string. |
<access-id> |
The IPv6 address of the host or network to which you want to restrict access. |
<view> |
The view (subset of the OID tree). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server readonly-community-v6 simplepassword access 2001:db8:1::100/32 view mysystem
nv set system snmp-server system-contact <value>
Configures the username and email address of the contact person for this managed node.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server system-contact myemail@example.com
nv set system snmp-server system-location
Configures the system physical location for the node in the SNMPv2-MIB system table.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server system-location my-private-bunker
nv set system snmp-server system-name
Configures a name for the managed node. Typically, this is the fully qualified domain name of the node.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server system-name CumulusBox-1,543,567
nv set system snmp-server trap-cpu-load-average
Configures the switch to generate SNMP trap notifications for CPU load average thresholds.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-cpu-load-average
nv set system snmp-server trap-cpu-load-average one-minute <one-minute-id>
Configures SNMP to generate a trap when the one-minute interval reaches a specific threshold. You can only use integers or floating point numbers.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-cpu-load-average one-minute 5
nv set system snmp-server trap-cpu-load-average one-minute <one-minute-id> five-minute <five-minute-id>
Configures SNMP to generate a trap when the one-minute or the five-minute intervals reach a specific threshold. You can only use integers or floating point numbers.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-cpu-load-average one-minute 12 five-minute 10
nv set system snmp-server trap-cpu-load-average one-minute <one-minute-id> five-minute <five-minute-id> fifteen-minute <fifteen-minute-id>
Configures SNMP to generate a trap when the one-minute, the five-minute, or fifteen-minute intervals reach a specific threshold. You can only use integers or floating point numbers.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-cpu-load-average one-minute 12 five-minute 10 fifteen-minute 5
nv set system snmp-server trap-link-down
Configures the switch to generate notifications when the operational status of the link changes to down.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-link-down
nv set system snmp-server trap-link-down check-frequency
Configures how often in seconds to check if the link is down to trigger notifications when the operational status of the link changes. You can specify a value between 5 and 300.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-link-down check-frequency 10
nv set system snmp-server trap-link-up
Configures the switch to generate notifications when the operational status of the link changes to up.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-link-up
nv set system snmp-server trap-link-up check-frequency
Configures how often in seconds to check if the link is up to trigger notifications when the operational status of the link changes. You can specify a value between 5 and 300.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-link-up check-frequency 10
nv set system snmp-server trap-destination <trap-destination-id>
Configures the trap receiver IP address for SNMPv1 and SNMPv2c traps. For SNMP versions 1 and 2c, you must set at least one SNMP trap destination IP address; multiple destinations can exist. Removing all settings disables SNMP traps. The default version is SNMPv2c. You must include a VRF name with the IP address to force traps to send in a non-default VRF table.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the trap receiver IP address for SNMPv1 and SNMPv2c traps. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost
nv set system snmp-server trap-destination <trap-destination-id> community-password <community-password-id>
Configures the trap receiver IP address for SNMPv1 and SNMPv2c traps and the community password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<community-password-id> |
The community password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost community-password mynotsosecretpassword
nv set system snmp-server trap-destination <trap-destination-id> community-password <community-password-id> version
Configures the trap receiver IP address for SNMPv1 and SNMPv2c traps, the community password, and the SNMP version (1 or 2c). The default version is SNMPv2c.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<community-password-id> |
The community password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost community-password mynotsosecretpassword version 1
nv set system snmp-server trap-destination <trap-destination-id> username <username-id>
Configures the SNMP trap receiver IP address and SNMP username.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id>
Configures the SNMP trap receiver IP address, and the SNMP username and MD5 authentication password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the MD5 authentication password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id>
Configures the SNMP trap receiver IP address, and the SNMP username and MD5 authentication password, and the DES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password encrypt-des mydessecret2
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the MD5 authentication password, the DES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password encrypt-des mydessecret2 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id>
Configures the SNMP trap receiver IP address, and the SNMP username and MD5 authentication password, and the AES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password encrypt-aes myaessecret2
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the MD5 authentication password, the AES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-md5 myauthmd5password encrypt-aes myaessecret2 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id>
Configures the SNMP trap receiver IP address, and the SNMP username and SHA authentication password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the DES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1 encrypt-des myencryptsecret
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, the DES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1 encrypt-des myencryptsecret engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the AES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1 encrypt-aes myencryptsecret
nv set system snmp-server trap-destination <trap-destination-id> username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, the AES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost username myv3user auth-sha SHApassword1 encrypt-aes myencryptsecret engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps. For SNMP versions 1 and 2c, you must set at least one SNMP trap destination IP address; multiple destinations can exist. Removing all settings disables SNMP traps. The default version is SNMPv2c. You must include a VRF name with the IP address to force traps to send in a non-default VRF table.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the trap receiver IP address for SNMPv1 and SNMPv2c traps. |
<vrf-name> |
The VRF name. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> community-password <community-password-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, and the community password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<community-password-id> |
The community password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED community-password mynotsosecretpassword
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> community-password <community-password-id> version
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the community password, and the SNMP version (1 or 2c). The default version is 2c.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<community-password-id> |
The community password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED community-password mynotsosecretpassword version 1
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, and the SNMP username.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the MD5 authentication password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5password
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the MD5 authentication password, and the trap server Engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<engine-id> |
The trap server engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5passwor engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and MD5 authentication password, and the DES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5password encrypt-des user3encryption
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and MD5 authentication password, the DES encryption password, and the trap server engine ID.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5passwor encrypt-des user3encryption engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and MD5 authentication password, and the AES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5passwor encrypt-aes myaessecret2
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and MD5 authentication password, the AES encryption password, and the trap server engine ID.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-md5 myauthmd5password encrypt-aes user3encryption engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<engine-id> |
The trap server engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the DES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1 encrypt-des mydessecret2
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id> engine-id <engine-id> inform
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, the DES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1 encrypt-des mydessecret2 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id>
Configures the trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, and the AES encryption password.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1 encrypt-aes myaessecret1
nv set system snmp-server trap-destination <trap-destination-id> vrf <vrf-name> username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id> engine-id <engine-id> inform
Configures the SNMP trap receiver IP address and VRF for SNMPv1 and SNMPv2c traps, the SNMP username and the SHA authentication password, the AES encryption password, and the engine ID.
The SNMP trap receiving daemon must have usernames, authentication passwords, and encryption passwords created with its own EngineID. You must configure this trap server EngineID in the switch snmpd daemon sending the trap and inform messages.
Command Syntax
| Syntax | Description |
|---|---|
<trap-destination-id> |
The IP address of the SNMP trap destination or localhost. |
<vrf-name> |
The VRF name. |
<username-id> |
The SNMP username. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
<engine-id> |
The engine ID. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-destination localhost vrf RED username myv3user auth-sha SHApassword1 encrypt-aes myaessecret1 engine-id 0x80001f888070939b14a514da5a00000000 inform
nv set system snmp-server trap-snmp-auth-failures
Configures the switch to generate SNMP trap notifications for every SNMP authentication failure.
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server trap-snmp-auth-failures
nv set system snmp-server username <username-id>
Configures the SNMPv3 username for authentication.
NVIDIA recommends you use an SNMPv3 username and password instead of the readonly community; SNMPv3 does not expose the password in the GetRequest and GetResponse packets and can also encrypt packet contents. You can configure multiple usernames for different user roles with different levels of access to various MIBs.
The default snmpd.conf file contains the default user _snmptrapusernameX. You cannot use this username for authentication. SNMP traps require this username.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1
nv set system snmp-server username <username-id> auth-md5 <auth-id>
Configures MD5 authentication for the specified SNMP user.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id>
Configures the DES encryption password for MD5 authentication for the specified SNMP user to encrypt the contents of the request and response packets.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-des myencryptsecret
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id> oid <oid>
Configures the setting to restrict a user with a specific MD5 authentication password and DES encryption password to a particular OID tree. The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-des myencryptsecret oid 1.3.6.1.2.1.1
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-des <encrypt-id> view <view>
Configures the setting to restrict a user with a specific MD5 authentication password and DES encryption password to a defined view (subnet). Any SNMP request with that username and password must have a source IP address within the configured subnet.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The DES encryption password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-des myencryptsecret view cumulusOnly
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id>
Configures the AES encryption password for MD5 authentication for the specified SNMP user to encrypt the contents of the request and response packets.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-aes myencryptsecret
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id> oid <oid>
Configures the setting to restrict a user with a specific MD5 authentication password and AES encryption password to a particular OID tree. The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-aes myencryptsecret oid 1.3.6.1.2.1.1
nv set system snmp-server username <username-id> auth-md5 <auth-id> encrypt-aes <encrypt-id> view <value>
Configures the setting to restrict a user with a specific MD5 authentication password and AES encryption password to a defined view. Any SNMP request with that username and password must have a source IP address within the configured subnet.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<encrypt-id> |
The AES encryption password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password encrypt-aes myencryptsecret view cumulusOnly
nv set system snmp-server username <username-id> auth-md5 <auth-id> oid <oid>
Configures SNMP to restrict a specific user with the specified password to a particular OID tree.
The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password oid 1.3.6.1.2.1
nv set system snmp-server username <username-id> auth-md5 <auth-id> view <value>
Configures SNMP to restrict a specific user with the specified MD5 password to a view so that any SNMP request with that username and password must have a source IP address within the configured subnet.
You can define a specific view multiple times and fine tune to provide or restrict access using the included or excluded command to specify branches of certain MIB trees.
By default, the snmpd.conf file contains many views within the systemonly view.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The MD5 authentication password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-md5 myauthmd5password view cumulusOnly
nv set system snmp-server username <username-id> auth-none
Configures the SNMP username to not require a password for authentication.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-none
nv set system snmp-server username <username-id> auth-none oid <oid>
Configures SNMP to restrict a user with no password authentication to a particular OID tree.
The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-none oid 1.3.6.1.2.1
nv set system snmp-server username <username-id> auth-none view <view>
Configures MIB tree exposure restriction. You can define a view for the SNMPv3 username and a host from a restricted subnet so that any SNMP request with that username must have a source IP address within the configured subnet.
You can define a specific view multiple times and fine tune to provide or restrict access using the included or excluded command to specify branches of certain MIB trees.
By default, the snmpd.conf file contains many views within the systemonly view.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-none view cumulusOnly
nv set system snmp-server username <username-id> auth-sha <auth-id>
Configures SHA authentication for the specified SNMP user.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id>
Configures the DES encryption password for SHA authentication for the specified SNMP user to encrypt the contents of the request and response packets.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-des myencryptsecret
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id> oid <oid>
Configures the setting to restrict a user with a specific SHA authentication password and DES encryption password to a particular OID tree. The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-des myencryptsecret oid 1.3.6.1.2.1.1
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-des <encrypt-id> view <value>
Configures the setting to restrict a user with a specific SHA authentication password and DES encryption password to a defined view (subnet). Any SNMP request with that username and password must have a source IP address within the configured subnet.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The DES encryption password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-des myencryptsecret view cumulusOnly
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id>
Configures the AES encryption password for SHA authentication for the specified SNMP user to encrypt the contents of the request and response packets.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-aes myencryptsecret
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id> oid <oid>
Configures SNMP to restrict a user with a specific SHA authentication password and AES encryption password to a particular OID tree. The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-aes myencryptsecret oid 1.3.6.1.2.1.1
nv set system snmp-server username <username-id> auth-sha <auth-id> encrypt-aes <encrypt-id> view <value>
Configures SNMP to restrict a user with a specific SHA authentication password and AES encryption password to a defined view (subnet). Any SNMP request with that username and password must have a source IP address within the configured subnet.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<encrypt-id> |
The AES encryption password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 encrypt-aes myencryptsecret view cumulusOnly
nv set system snmp-server username <username-id> auth-sha <auth-id> oid <oid>
Configures SNMP to restrict a specific user with the specified SHA authentication password to a particular OID tree.
The OID can be either a string of decimal numbers separated by periods or a unique text string that identifies an SNMP MIB object. The MIBs that Cumulus Linux includes are in the /usr/share/snmp/mibs/ directory. If the MIB you want to use does not install by default, you can install it with the latest Debian snmp-mibs-downloader package.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<oid> |
The OID tree that identifies an SNMP MIB object. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 oid 1.3.6.1.2.1
nv set system snmp-server username <username-id> auth-sha <auth-id> view <value>
Configures SNMP to restrict a specific user with the specified SHA authentication password to a particular SNMP view (subnet) so that any SNMP request with that username and SHA authentication password must have a source IP address within the configured subnet.
You can define a specific view multiple times and fine tune to provide or restrict access using the included or excluded command to specify branches of certain MIB trees.
By default, the snmpd.conf file contains many views within the systemonly view.
Command Syntax
| Syntax | Description |
|---|---|
<username-id> |
The SNMP username for authentication. |
<auth-id> |
The SHA authentication password. |
<view> |
The SNMP view (subnet). |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server username testuser1 auth-sha SHApassword1 view cumulusOnly
nv set system snmp-server viewname <viewname-id>
Configures the view names that restrict MIB tree exposure.
nv set system snmp-server viewname <viewname-id> excluded <snmp-branch>
Configures the SNMP tree branches to exclude.
Command Syntax
| Syntax | Description |
|---|---|
<viewname-id> |
The SNMP view (subnet) name. |
<snmp-branch> |
SNMP tree branch to exclude. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server viewname cumulusOnly excluded .1.3.6.1.4.1.40310
nv set system snmp-server viewname <viewname-id> included <snmp-branch>
Configures the SNMP tree branches to include.
Command Syntax
| Syntax | Description |
|---|---|
<viewname-id> |
The SNMP view (subnet) name. |
<snmp-branch> |
SNMP tree branch to include. |
Version History
Introduced in Cumulus Linux 5.3.0
Example
cumulus@switch:~$ nv set system snmp-server viewname cumulusOnly included .1.3.6.1.4.1.40310.2