ansible.builtin.nxos_snmp_user (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manages SNMP user configuration.

Usage examples

Scanned by Steampunk Spotter

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

- nxos_snmp_user:
    user: ntc
    group: network-operator
    auth: md5
    pwd: test_password
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Inputs

    
pwd:
    default: null
    description:
    - Auth password when using md5 or sha.
    required: false

auth:
    choices:
    - md5
    - sha
    default: null
    description:
    - Auth parameters for the user.
    required: false

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

group:
    description:
    - Group to which the user will belong to.
    required: true

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

encrypt:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Enables AES-128 bit encryption when using privacy password.
    required: false

privacy:
    default: null
    description:
    - Privacy password for the user.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs configuration vtp after module execution
  returned: always
  sample:
    authentication: md5
    encrypt: none
    group:
    - network-operator
    user: ntc
  type: dict
existing:
  description:
  - k/v pairs of existing configuration
  returned: always
  sample:
    authentication: 'no'
    encrypt: none
    group:
    - network-operator
    user: ntc
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    authentication: md5
    group: network-operator
    pwd: test_password
    user: ntc
  type: dict
updates:
  description: command sent to the device
  returned: always
  sample:
  - snmp-server user ntc network-operator auth md5 test_password
  type: list