cisco.nxos.nxos_snmp_user module – (deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.
Note
This module is part of the cisco.nxos collection (version 8.1.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 cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_snmp_user
.
New in cisco.nxos 1.0.0
DEPRECATED
- Removed in:
major release after 2024-01-01
- Why:
Updated modules released with more functionality
- Alternative:
nxos_snmp_server
Synopsis
Manages SNMP user configuration.
Aliases: snmp_user
Parameters
Parameter |
Comments |
---|---|
Authentication parameters for the user. Choices:
|
|
Enables AES-128 bit encryption when using privacy password. Choices:
|
|
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. |
|
Privacy password for the user. This is not idempotent |
|
Authentication password when using md5 or sha. This is not idempotent |
|
Manage the state of the resource. Choices:
|
|
Name of the user. |
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Limited Support for Cisco MDS
Authentication parameters not idempotent.
For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- cisco.nxos.nxos_snmp_user:
user: ntc
group: network-operator
authentication: md5
pwd: test_password
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
commands sent to the device Returned: always Sample: |
Status
This module will be removed in a major release after 2024-01-01. [deprecated]
For more information see DEPRECATED.