W3cubDocs

/Ansible

mellanox.onyx.onyx_snmp_users – Configures SNMP User parameters

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_snmp_users.

New in version 0.2.0: of mellanox.onyx

Synopsis

  • This module provides declarative management of SNMP Users protocol params on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
users
list / elements=string
List of snmp users
auth_password
string
The password needed to configure the hash type.
auth_type
string
    Choices:
  • md5
  • sha
  • sha224
  • sha256
  • sha384
  • sha512
Configures the hash type used to configure SNMP v3 security parameters.
capability_level
string
    Choices:
  • admin
  • monitor
  • unpriv
  • v_admin
Sets capability level for SET requests.
enabled
boolean
    Choices:
  • no
  • yes
Enables/Disables SNMP v3 access for the user.
name
string / required
Specifies the name of the user.
require_privacy
boolean
    Choices:
  • no
  • yes
Enables/Disables the Require privacy (encryption) for requests from this user
set_access_enabled
boolean
    Choices:
  • no
  • yes
Enables/Disables SNMP SET requests for the user.

Examples

- name: Enables snmp user
  onyx_snmp_users:
    users:
       - name: sara
         enabled: true

- name: Enables snmp set requests
  onyx_snmp_users:
    users:
       - name: sara
         set_access_enabled: yes

- name: Enables user require privacy
  onyx_snmp_users:
    users:
       - name: sara
         require_privacy: true

- name: Configures user hash type
  onyx_snmp_users:
    users:
       - auth_type: md5
         auth_password: 1297sara1234sara

- name: Configures user capability_level
  onyx_snmp_users:
    users:
        - name: sara
          capability_level: admin

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device.

Sample:
['snmp-server user <user_name> v3 enable', 'no snmp-server user <user_name> v3 enable', 'snmp-server user <user_name> v3 enable sets', 'no snmp-server user <user_name> v3 enable sets', 'snmp-server user <user_name> v3 require-privacy', 'no snmp-server user <user_name> v3 require-privacy', 'snmp-server user <user_name> v3 capability <capability_level>', 'snmp-server user <user_name> v3 auth <hash_type> <password>']


Authors

  • Sara Touqan (@sarato)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/mellanox/onyx/onyx_snmp_users_module.html