New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
aaa_local_user | Unique name to identify the local user. | |
acl_number | Access control list number. | |
auth_key | The authentication password. Password length, 8-255 characters. | |
auth_protocol |
| Authentication protocol. |
priv_key | The encryption password. Password length 8-255 characters. | |
priv_protocol |
| Encryption protocol. |
remote_engine_id | Remote engine id of the USM user. | |
user_group | Name of the group where user belongs to. | |
usm_user_name | Unique name to identify the USM user. |
- name: CloudEngine snmp user test hosts: cloudengine connection: local gather_facts: no vars: cli: host: "{{ inventory_hostname }}" port: "{{ ansible_ssh_port }}" username: "{{ username }}" password: "{{ password }}" transport: cli tasks: - name: "Config SNMP usm user" ce_snmp_user: state: present usm_user_name: wdz_snmp remote_engine_id: 800007DB03389222111200 acl_number: 2000 user_group: wdz_group provider: "{{ cli }}" - name: "Undo SNMP usm user" ce_snmp_user: state: absent usm_user_name: wdz_snmp remote_engine_id: 800007DB03389222111200 acl_number: 2000 user_group: wdz_group provider: "{{ cli }}" - name: "Config SNMP local user" ce_snmp_user: state: present aaa_local_user: wdz_user auth_protocol: md5 auth_key: huawei123 priv_protocol: des56 priv_key: huawei123 provider: "{{ cli }}" - name: "Config SNMP local user" ce_snmp_user: state: absent aaa_local_user: wdz_user auth_protocol: md5 auth_key: huawei123 priv_protocol: des56 priv_key: huawei123 provider: "{{ cli }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean | always | check to see if a change was made on the device Sample: True |
end_state dict | always | k/v pairs of aaa params after module execution Sample: {'snmp local user': {'local_user_info': []}, 'snmp usm user': {'usm_user_info': [{'userName': 'wdz_snmp', 'groupName': 'wdz_group', 'engineID': '800007DB03389222111200', 'aclNumber': '2000'}]}} |
existing dict | always | k/v pairs of existing aaa server Sample: {'snmp local user': {'local_user_info': []}, 'snmp usm user': {'usm_user_info': []}} |
proposed dict | always | k/v pairs of parameters passed into module Sample: {'remote_engine_id': '800007DB03389222111200', 'state': 'present', 'usm_user_name': 'wdz_snmp', 'acl_number': '2000', 'user_group': 'wdz_group'} |
updates list | always | command sent to the device Sample: ['snmp-agent remote-engineid 800007DB03389222111200 usm-user v3 wdz_snmp wdz_group acl 2000'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ce_snmp_user_module.html