Print Download PDF Send Feedback

Previous

Next

Configuring SNMP - Gaia Clish

For detailed information, see sk90860: How to configure SNMP on Gaia OS.

Description

Configure SNMP.

Syntax for set commands

set snmp agent {on | off}

 

set snmp agent-version {any | v3-Only}

 

set snmp mode {default | vs}

 

set snmp community <String> {read-only | read-write}

 

set snmp contact <Contact Information>

 

set snmp location <Location Information>

 

set snmp usm user <UserName> security-level authPriv auth-pass-phrase <Pass Phrase> privacy-pass-phrase <Privacy Pass Phrase> privacy-protocol {DES | AES} authentication-protocol {MD5 | SHA1}

 

set snmp usm user <UserName> security-level authPriv auth-pass-phrase-hashed <Hashed Pass Phrase> privacy-pass-phrase <Privacy Pass Phrase> privacy-protocol {DES | AES} authentication-protocol {MD5 | SHA1}

 

set snmp usm user <UserName> security-level authNoPriv auth-pass-phrase <Pass Phrase> authentication-protocol {MD5 | SHA1}

 

set snmp usm user <UserName> security-level authNoPriv auth-pass-phrase-hashed <Hashed Pass Phrase>

 

set snmp usm user <UserName> {usm-read-only | usm-read-write}

 

set snmp usm user <UserName> vsid {all | <IDs of allowed Virtual Devices>}

 

set snmp clear-trap interval <Value> retries <Value>

 

set snmp custom-trap <Custom Trap Name> <Property> <Value>

 

set snmp vs-direct-access {on | off}

 

set snmp traps coldStart-threshold <Seconds>

 

set snmp traps polling-frequency <Seconds>

 

set snmp traps receiver <IPv4 address> version {v1 | v2 | v3} community <String>

 

set snmp traps trap {authorizationError | biosFailure | coldStart | configurationChange | configurationSave | fanFailure | highVoltage | linkUpLinkDown | lowDiskSpace | lowVoltage | overTemperature | powerSupplyFailure | raidVolumeState | vrrpv2AuthFailure | vrrpv2NewMaster | vrrpv3NewMaster | vrrpv3ProtoError}

 

set snmp traps trap-user <UserName>

Where:

Command

Description

set snmp agent {on | off}

Enables (on) or disables (off) the SNMP Agent.

set snmp agent-version {any | v3-Only}

Configures the supported SNMP version:

  • all - support SNMP v1, v2 and v3
  • v3-Only - support SNMP v3 only

set snmp mode {default | vs}

Configures how to run the SNMP daemon:

  • default
    • On non-VSX Gateway, this is the only supported mode
    • On VSX Gateway, SNMP daemon runs only in the context of VS0
  • vs
    • For VSX Gateway only
    • Each Virtual Device has a separate SNMP daemon running in the context of that Virtual Device

set snmp community <String> {read-only | read-write}

Configures the SNMP community password and if this password lets you only read the values of SNMP objects (read-only), or set the values as well (read-write)

set snmp contact ...

Configures the contact name for the SNMP community

set snmp location ...

Configures the contact location for the SNMP community

set snmp usm user <UserName> ...

Configures the SNMPv3 USM user

set snmp clear-trap ...

Configures the indication of a custom SNMP trap termination

set snmp custom-trap ...

Configures the custom SNMP trap

set snmp vs-direct-access {on | off}

Enables (on) and disables (off) the SNMP direct queries on the IP address of a Virtual System (not only VS0), or Virtual Router
This mode works only when SNMP vs mode is enabled
See the R80.20 VSX Administration Guide

set snmp traps coldStart-threshold <Seconds>

Configures the threshold for the SNMP coldStart trap

set snmp traps polling-frequency <Seconds>

Configures the polling interval for the SNMP traps

set snmp traps receiver ...

Configures the IPv4 address of the SNMP Trap Sink

set snmp traps trap ...

Configures the Gaia built-in SNMP traps

set snmp traps trap-user <UserName>

Configures the user, which will generate the SNMP traps

Syntax for add commands

add snmp interface <Name of Interface>

 

add snmp traps receiver <IPv4 address> version {v1 | v2 | v3} community <String>

 

add snmp custom-trap <Custom Trap Name> oid <Value> operator <Logical Operator> threshold <Value> frequency <Value> message <Text>

 

add snmp usm user <UserName> security-level authPriv auth-pass-phrase <Pass Phrase> privacy-pass-phrase <Privacy Pass Phrase> privacy-protocol {DES | AES} authentication-protocol {MD5 | SHA1}

 

add snmp usm user <UserName> security-level authPriv auth-pass-phrase-hashed <Hashed Pass Phrase> privacy-pass-phrase <Privacy Pass Phrase> privacy-protocol {DES | AES} authentication-protocol {MD5 | SHA1}

 

add snmp usm user <UserName> security-level authNoPriv auth-pass-phrase <Pass Phrase> authentication-protocol {MD5 | SHA1}

 

add snmp usm user <UserName> security-level authNoPriv auth-pass-phrase-hashed <Hashed Pass Phrase>

Where:

Command

Description

add snmp interface ...

Adds a local interface to the list of local interfaces, on which the SNMP daemon listens

add snmp traps receiver ...

Adds a SNMP Trap Sink

add snmp custom-trap ...

Adds a customer SNMP trap

add snmp usm user ...

Adds an SNMPv3 USM user

Syntax for delete commands

delete snmp community <String>

 

delete snmp interface <Name of Interface>

 

delete snmp contact <Contact Information>

 

delete snmp location <Location Information>

 

delete snmp usm user <UserName>

 

delete snmp clear-trap

 

delete snmp traps coldStart-threshold

 

delete snmp traps polling-frequency

 

delete snmp traps receiver <IPv4 address>

 

delete snmp traps trap-user <UserName>

 

delete snmp custom-trap <Custom Trap Name>

Where:

Command

Description

delete snmp community <String>

Removes the SNMP community password

delete snmp interface <Name of Interface>

Removes the local interface from the list of local interfaces, on which the SNMP daemon listens

delete snmp contact ...

Removes the contact name for the SNMP community

delete snmp location ...

Removes the contact location for the SNMP community

delete snmp usm user <UserName>

Removes the SNMPv3 USM user

delete snmp clear-trap

Removes the indication of a custom SNMP trap termination

delete snmp traps coldStart-threshold

Removes the threshold for the SNMP coldStart trap

delete snmp traps polling-frequency

Removes the polling interval for the SNMP traps

delete snmp traps receiver <IPv4 address>

Removes the IPv4 address of the SNMP Trap Sink

delete snmp traps trap-user <UserName>

Removes the user, which will generate the SNMP traps

delete snmp custom-trap <Custom Trap Name>

Removes the custom SNMP trap

Best Practice

For commands that include auth-pass-phrase, privacy-pass-phrase, or both, use the hashed commands.

To get the hashed password, run: show configuration snmp