Skip to content

Latest commit

 

History

History
392 lines (363 loc) · 15.7 KB

ansible.snmp.v3_usm_connection.rst

File metadata and controls

392 lines (363 loc) · 15.7 KB
Raw

ansible.snmp.v3_usm

Make SNMP v3 user-based security model (USM) connections to a device.

Version added: 1.0.0

Synopsis

  • Make SNMP v3 user-based security model (USM) connections to a device.

Requirements

The below requirements are needed on the local Ansible controller node that executes this connection.

  • python bindings for netsnmp

Parameters

Parameter Choices/Defaults Configuration Comments
auth_pass
string
ini entries:

[ansible.snmp]
context = VALUE

env:ANSIBLE_SNMP_AUTH_PASS
var: ansible_snmp_auth_pass
Specify the SNMP v3 authentication passphrase.
auth_proto
string
    Choices:
  • MD5 ←
  • SHA1
  • SHA-192
  • SHA-256
  • SHA-284
  • SHA-512
ini entries:

[ansible.snmp]
context = MD5

env:ANSIBLE_SNMP_AUTH_PROTO
var: ansible_snmp_auth_proto
Specify the SNMP v3 authentication protocol.
context
string
Default:
""
ini entries:

[ansible.snmp]
context =

env:ANSIBLE_SNMP_CONTEXT
var: ansible_snmp_context
Specify the SNMP v3 context name.
context_engine_id
string
ini entries:

[ansible.snmp]
sec_level = VALUE

env:ANSIBLE_SNMP_CONTEXT_ENGINE_ID
var: ansible_snmp_context_engine_id
Specify the SNMP v3 context engine ID.
Will be probed if not supplied.
host
string
Default:
"inventory_hostname"
var: ansible_host
Specifies the remote device FQDN or IP address for the SNMP connection to.
port
integer
Default:
161
ini entries:

[defaults]
remote_port = 161

env:ANSIBLE_REMOTE_PORT
var: ansible_port
Specifies the port on the remote device that listens for SNMP connections.
priv_pass
string
ini entries:

[ansible.snmp]
priv_proto = VALUE

env:ANSIBLE_SNMP_PRIV_PASS
var: ansible_snmp_priv_pass
Specify the SNMP v3 privacy passphrase.
priv_proto
string
    Choices:
  • DES ←
  • AES128
  • AES256
ini entries:

[ansible.snmp]
priv_proto = DES

env:ANSIBLE_SNMP_PRIV_PROTO
var: ansible_snmp_priv_proto
Specify the SNMP v3 privacy protocol.
retries
integer
Default:
3
ini entries:

[ansible.snmp]
retries = 3

env:ANSIBLE_SNMP_RETRIES
var: ansible_snmp_RETRIES
Specify the number retries before failure
sec_engine_id
string
ini entries:

[ansible.snmp]
sec_name = VALUE

env:ANSIBLE_SNMP_SEC_ENGINE_ID
var: ansible_snmp_sec_engine_id
Specify the SNMP v3 security engine ID.
Will be probed if not supplied.
sec_level
string
    Choices:
  • noAuthNoPriv ←
  • authNoPriv
  • authPriv
ini entries:

[ansible.snmp]
sec_level = noAuthNoPriv

env:ANSIBLE_SNMP_SEC_LEVEL
var: ansible_snmp_sec_level
Specify the SNMP v3 secutiry level.
sec_name
string
Default:
"initial"
ini entries:

[ansible.snmp]
sec_name = initial

env:ANSIBLE_SNMP_SEC_NAME
var: ansible_snmp_sec_name
Specify the SNMP v3 security name.
timeout
integer
Default:
500000
ini entries:

[ansible.snmp]
timeout = 500000

env:ANSIBLE_SNMP_TIMEOUT
var: ansible_snmp_timeout
Specify the number of micro-seconds before a retry
version
integer
    Choices:
  • 3 ←
Specify the SNMP version

Status

Authors

  • Bradley Thornton (@cidrblock)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.