W3cubDocs

/Ansible

nxos_snmp_user - Manages SNMP users for monitoring.

New in version 2.2.

Synopsis

Manages SNMP user configuration.

Options

parameter required default choices comments
auth
 no
  • md5
  • sha
Auth parameters for the user.
encrypt
 no
  • true
  • false
Enables AES-128 bit encryption when using privacy password.
group
 yes
Group to which the user will belong to.
host
 yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
 no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
privacy
 no
Privacy password for the user.
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
pwd
 no
Auth password when using md5 or sha.
ssh_keyfile
 no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
 no present
  • present
  • absent
Manage the state of the resource.
transport
 yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
user
 yes
Name of the user.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

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

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

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

Notes

Note

Authentication parameters not idempotent.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_snmp_user_module.html