.. _vyos.vyos.vyos_snmp_server_module:
**************************
vyos.vyos.vyos_snmp_server
**************************
**Manages snmp_server resource module**
Version added: 2.7.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module manages the snmp server attributes of Vyos network devices
Parameters
----------
.. raw:: html
Parameter |
Choices/Defaults |
Comments |
config
dictionary
|
|
SNMP server configuration.
|
|
communities
list
/ elements=dictionary
|
|
Community name configuration.
|
|
|
authorization_type
string
|
|
Authorization type (rw or ro)
|
|
|
clients
list
/ elements=string
|
|
IP address of SNMP client allowed to contact system
|
|
|
name
string
|
|
Community name
|
|
|
networks
list
/ elements=string
|
|
Subnet of SNMP client(s) allowed to contact system
|
|
contact
string
|
|
Person to contact about the system.
|
|
description
string
|
|
Description information
|
|
listen_addresses
list
/ elements=dictionary
|
|
IP address to listen for incoming SNMP requests
|
|
|
address
string
|
|
IP address to listen for incoming SNMP requests.
|
|
|
port
integer
|
|
Port for SNMP service
|
|
location
string
|
|
Location information
|
|
smux_peer
string
|
|
Register a subtree for SMUX-based processing.
|
|
snmp_v3
dictionary
|
|
Simple Network Management Protocol (SNMP) v3
|
|
|
engine_id
string
|
|
Specifies the EngineID as a hex value
|
|
|
groups
list
/ elements=dictionary
|
|
Specifies the group with name groupname
|
|
|
|
group
string
|
|
Specifies the group with name groupname
|
|
|
|
mode
string
|
|
Defines the read/write access
|
|
|
|
seclevel
string
|
|
Defines security level
|
|
|
|
view
string
|
|
Defines the name of view
|
|
|
trap_targets
list
/ elements=dictionary
|
|
Defines SNMP target for inform or traps for IP
|
|
|
|
address
string
|
|
IP/IPv6 address of trap target
|
|
|
|
authentication
dictionary
|
|
Defines the authentication
|
|
|
|
|
encrypted_key
string
|
|
Defines the encrypted password for authentication
|
|
|
|
|
plaintext_key
string
|
|
Defines the clear text password for authentication
|
|
|
|
|
type
string
|
|
Defines the protocol using for authentication
|
|
|
|
engine_id
string
|
|
Defines the engineID.
|
|
|
|
port
integer
|
|
Specifies the TCP/UDP port of a destination for SNMP traps/informs.
|
|
|
|
privacy
dictionary
|
|
Defines the privacy
|
|
|
|
|
encrypted_key
string
|
|
Defines the encrypted password for privacy
|
|
|
|
|
plaintext_key
string
|
|
Defines the clear text password for privacy
|
|
|
|
|
type
string
|
|
Defines the protocol using for privacy
|
|
|
|
protocol
string
|
|
Defines protocol for notification between TCP and UDP
|
|
|
|
type
string
|
|
Specifies the type of notification between inform and trap
|
|
|
tsm
dictionary
|
|
Specifies that the snmpd uses encryption
|
|
|
|
local_key
string
|
|
Defines the server certificate fingerprint or key-file name.
|
|
|
|
port
integer
|
|
Defines the port for tsm.
|
|
|
users
list
/ elements=dictionary
|
|
Defines username for authentication
|
|
|
|
authentication
dictionary
|
|
Defines the authentication
|
|
|
|
|
encrypted_key
string
|
|
Defines the encrypted password for authentication
|
|
|
|
|
plaintext_key
string
|
|
Defines the clear text password for authentication
|
|
|
|
|
type
string
|
|
Defines the protocol using for authentication
|
|
|
|
engine_id
string
|
|
Defines the engineID.
|
|
|
|
group
string
|
|
Specifies group for user name
|
|
|
|
mode
string
|
|
Specifies the mode for access rights of user, read only or write
|
|
|
|
privacy
dictionary
|
|
Defines the privacy
|
|
|
|
|
encrypted_key
string
|
|
Defines the encrypted password for privacy
|
|
|
|
|
plaintext_key
string
|
|
Defines the clear text password for privacy
|
|
|
|
|
type
string
|
|
Defines the protocol using for privacy
|
|
|
|
tsm_key
string
|
|
Specifies finger print or file name of TSM certificate.
|
|
|
|
user
string
|
|
Specifies the user with name username
|
|
|
views
list
/ elements=dictionary
|
|
Specifies the view with name viewname
|
|
|
|
exclude
string
|
|
Exclude is optional argument.
|
|
|
|
mask
string
|
|
Defines a bit-mask that is indicating which subidentifiers of the associated subtree OID should be regarded as significant.
|
|
|
|
oid
string
|
|
Specify oid
|
|
|
|
view
string
|
|
view name
|
|
trap_source
string
|
|
SNMP trap source address
|
|
trap_target
dictionary
|
|
Address of trap target
|
|
|
address
string
|
|
Address of trap target
|
|
|
community
string
|
|
Community used when sending trap information
|
|
|
port
integer
|
|
Destination port used for trap notification
|
running_config
string
|
|
The state the configuration should be left in.
The states replaced and overridden have identical behaviour for this module.
Please refer to examples for more details.
|
state
string
|
Choices:
merged ←
- replaced
- overridden
- deleted
- gathered
- parsed
- rendered
|
The state the configuration should be left in
|