community.network.ce_snmp_community module – Manages SNMP community configuration on HUAWEI CloudEngine switches.

Note

This module is part of the community.network collection (version 4.0.1).

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

Comments

access_right

string

Access right read or write.

Choices:

  • read

  • 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

Security level indicating whether to use authentication and encryption.

Choices:

  • noAuthNoPriv

  • authentication

  • privacy

state

string

Manage the state of the resource.

Choices:

  • present ← (default)

  • absent

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

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of aaa params after module execution

Returned: always

Sample: {“snmp v3 group”: {“snmp_group”: [“wdz_group”, “noAuthNoPriv”, “2000”]}}

existing

dictionary

k/v pairs of existing aaa server

Returned: always

Sample: {}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {“acl_number”: “2000”, “group_name”: “wdz_group”, “security_level”: “noAuthNoPriv”, “state”: “present”}

updates

list / elements=string

command sent to the device

Returned: always

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

Authors

  • wangdezhuang (@QijunPan)