community.general.onyx_snmp_users (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
users:
    description:
    - List of snmp users
    suboptions:
      auth_password:
        description:
        - The password needed to configure the hash type.
        type: str
      auth_type:
        choices:
        - md5
        - sha
        - sha224
        - sha256
        - sha384
        - sha512
        description:
        - Configures the hash type used to configure SNMP v3 security parameters.
        type: str
      capability_level:
        choices:
        - admin
        - monitor
        - unpriv
        - v_admin
        description:
        - Sets capability level for SET requests.
        type: str
      enabled:
        description:
        - Enables/Disables SNMP v3 access for the user.
        type: bool
      name:
        description:
        - Specifies the name of the user.
        required: true
        type: str
      require_privacy:
        description:
        - Enables/Disables the Require privacy (encryption) for requests from this user
        type: bool
      set_access_enabled:
        description:
        - Enables/Disables SNMP SET requests for the user.
        type: bool
    type: list

Outputs

commands:
  description: The list of configuration mode commands to send to the device.
  returned: always
  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>
  type: list