New in version 2.4.
parameter | required | default | choices | comments |
---|---|---|---|---|
aaa_local_user |
no |
Unique name to identify the local user.
|
||
acl_number |
no |
Access control list number.
|
||
auth_key |
no |
The authentication password. Password length, 8-255 characters.
|
||
auth_protocol |
no |
|
Authentication protocol.
|
|
priv_key |
no |
The encryption password. Password length 8-255 characters.
|
||
priv_protocol |
no |
|
Encryption protocol.
|
|
remote_engine_id |
no |
Remote engine id of the USM user.
|
||
user_group |
no |
Name of the group where user belongs to.
|
||
usm_user_name |
no |
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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed |
check to see if a change was made on the device
|
always | boolean | True |
end_state |
k/v pairs of aaa params after module execution
|
always | dict | {'snmp local user': {'local_user_info': [{'userName': 'wdz_snmp', 'groupName': 'wdz_group', 'engineID': '800007DB03389222111200', 'aclNumber': '2000'}]}} |
existing |
k/v pairs of existing aaa server
|
always | dict | {'snmp local user': {'local_user_info': []}, 'snmp usm user': {'usm_user_info': []}} |
proposed |
k/v pairs of parameters passed into module
|
always | dict | {'remote_engine_id': '800007DB03389222111200', 'state': 'present', 'usm_user_name': 'wdz_snmp', 'acl_number': '2000', 'user_group': 'wdz_group'} |
updates |
command sent to the device
|
always | list | ['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.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.