community.network.ce_snmp_user – Manages SNMP user configuration on HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 3.0.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 community.network
.
To use it in a playbook, specify: community.network.ce_snmp_user
.
Parameters
Parameter |
Comments |
---|---|
Unique name to identify the local user. |
|
Access control list number. |
|
The authentication password. Password length, 8-255 characters. |
|
Authentication protocol. Choices:
|
|
The encryption password. Password length 8-255 characters. |
|
Encryption protocol. Choices:
|
|
Remote engine id of the USM user. |
|
Name of the group where user belongs to. |
|
Unique name to identify the USM user. |
Notes
Note
This module requires the netconf system service be enabled on the remote device being managed.
Recommended connection is
netconf
.This module also works with
local
connections for legacy playbooks.
Examples
- 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"
community.network.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"
community.network.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"
community.network.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"
community.network.ce_snmp_user:
state: absent
aaa_local_user: wdz_user
auth_protocol: md5
auth_key: huawei123
priv_protocol: des56
priv_key: huawei123
provider: "{{ cli }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: true |
|
k/v pairs of aaa params after module execution Returned: always Sample: {“snmp local user”: {“local_user_info”: []}, “snmp usm user”: {“usm_user_info”: [{“aclNumber”: “2000”, “engineID”: “800007DB03389222111200”, “groupName”: “wdz_group”, “userName”: “wdz_snmp”}]}} |
|
k/v pairs of existing aaa server Returned: always Sample: {“snmp local user”: {“local_user_info”: []}, “snmp usm user”: {“usm_user_info”: []}} |
|
k/v pairs of parameters passed into module Returned: always Sample: {“acl_number”: “2000”, “remote_engine_id”: “800007DB03389222111200”, “state”: “present”, “user_group”: “wdz_group”, “usm_user_name”: “wdz_snmp”} |
|
command sent to the device Returned: always Sample: [“snmp-agent remote-engineid 800007DB03389222111200 usm-user v3 wdz_snmp wdz_group acl 2000”] |
Authors
wangdezhuang (@QijunPan)