cisco.nxos.nxos_snmp_user_module.rst

cisco.nxos.nxos_snmp_user

(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.

Version added: 1.0.0

• DEPRECATED
• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

DEPRECATED

:Removed in collection release after 2024-01-01 :Why: Updated modules released with more functionality :Alternative: nxos_snmp_server

Synopsis

• Manages SNMP user configuration.

Parameters

Parameter	Choices/Defaults	Comments
authentication string	Choices: md5 sha	Authentication parameters for the user.
encrypt boolean	Choices: no yes	Enables AES-128 bit encryption when using privacy password.
group string		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 string		Privacy password for the user. This is not idempotent
pwd string		Authentication password when using md5 or sha. This is not idempotent
state string	Choices: present ← absent	Manage the state of the resource.
user string / required		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.

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	Returned	Description
commands list	always	commands sent to the device Sample: ['snmp-server user ntc network-operator auth md5 test_password']

Status

• This module will be removed in a release after 2024-01-01. [deprecated]
• For more information see DEPRECATED.

Authors

• Jason Edelman (@jedelman8)