ansible.builtin.nxos_snmp_user (v2.5.10) — module

Manages SNMP users for monitoring.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.5.10

Description

Manages SNMP user configuration.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nxos_snmp_user:
    user: ntc
    group: network-operator
    authentication: md5
    pwd: test_password

Inputs

    
pwd:
    description:
    - Authentication password when using md5 or sha. This is not idempotent

user:
    description:
    - Name of the user.
    required: true

group:
    description:
    - Group to which the user will belong to. If state = present, and the user is existing,
      the group is added to the user. If the user is not existing, user entry is created
      with this group argument. If state = absent, only the group is removed from the
      user entry. However, to maintain backward compatibility, if the existing user belongs
      to only one group, and if group argument is same as the existing user's group, then
      the user entry also is deleted.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Manage the state of the resource.

encrypt:
    description:
    - Enables AES-128 bit encryption when using privacy password.
    type: bool

privacy:
    description:
    - Privacy password for the user. This is not idempotent

authentication:
    choices:
    - md5
    - sha
    description:
    - Authentication parameters for the user.

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - snmp-server user ntc network-operator auth md5 test_password
  type: list