W3cubDocs

/Ansible

community.network.ce_snmp_community – Manages SNMP community 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_community.

Synopsis

  • Manages SNMP community configuration on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
access_right
string
    Choices:
  • read
  • write
Access right read or write.
acl_number
string
Access control list number.
community_mib_view
string
Mib view name.
community_name
string
Unique name to identify the community.
group_name
string
Unique name to identify the SNMPv3 group.
notify_view
string
Mib view name for notification.
read_view
string
Mib view name for read.
security_level
string
    Choices:
  • noAuthNoPriv
  • authentication
  • privacy
Security level indicating whether to use authentication and encryption.
state
string
    Choices:
  • present ←
  • absent
Manage the state of the resource.
write_view
string
Mib view name for write.

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 community 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 community"
    community.network.ce_snmp_community:
      state: present
      community_name: Wdz123456789
      access_right: write
      provider: "{{ cli }}"

  - name: "Undo SNMP community"
    community.network.ce_snmp_community:
      state: absent
      community_name: Wdz123456789
      access_right: write
      provider: "{{ cli }}"

  - name: "Config SNMP group"
    community.network.ce_snmp_community:
      state: present
      group_name: wdz_group
      security_level: noAuthNoPriv
      acl_number: 2000
      provider: "{{ cli }}"

  - name: "Undo SNMP group"
    community.network.ce_snmp_community:
      state: absent
      group_name: wdz_group
      security_level: noAuthNoPriv
      acl_number: 2000
      provider: "{{ cli }}"

Return Values

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
dictionary
always
k/v pairs of aaa params after module execution

Sample:
{'snmp v3 group': {'snmp_group': ['wdz_group', 'noAuthNoPriv', '2000']}}
existing
dictionary
always
k/v pairs of existing aaa server
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'acl_number': '2000', 'group_name': 'wdz_group', 'security_level': 'noAuthNoPriv', 'state': 'present'}
updates
list / elements=string
always
command sent to the device

Sample:
['snmp-agent group v3 wdz_group noauthentication acl 2000']


Authors

  • wangdezhuang (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_snmp_community_module.html