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

Comments

users

list / elements=string

List of snmp users

auth_password

string

The password needed to configure the hash type.

auth_type

string

Configures the hash type used to configure SNMP v3 security parameters.

Choices:

  • md5

  • sha

  • sha224

  • sha256

  • sha384

  • sha512

capability_level

string

Sets capability level for SET requests.

Choices:

  • admin

  • monitor

  • unpriv

  • v_admin

enabled

boolean

Enables/Disables SNMP v3 access for the user.

Choices:

  • no

  • yes

name

string / required

Specifies the name of the user.

require_privacy

boolean

Enables/Disables the Require privacy (encryption) for requests from this user

Choices:

  • no

  • yes

set_access_enabled

boolean

Enables/Disables SNMP SET requests for the user.

Choices:

  • no

  • yes

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

Sample: [“snmp-server user \u003cuser_name\u003e v3 enable”, “no snmp-server user \u003cuser_name\u003e v3 enable”, “snmp-server user \u003cuser_name\u003e v3 enable sets”, “no snmp-server user \u003cuser_name\u003e v3 enable sets”, “snmp-server user \u003cuser_name\u003e v3 require-privacy”, “no snmp-server user \u003cuser_name\u003e v3 require-privacy”, “snmp-server user \u003cuser_name\u003e v3 capability \u003ccapability_level\u003e”, “snmp-server user \u003cuser_name\u003e v3 auth \u003chash_type\u003e \u003cpassword\u003e”]

Authors

  • Sara Touqan (@sarato)