Documentation

ce_snmp_community - Manages SNMP community configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages SNMP community configuration on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
access_right
no
  • read
  • write
Access right read or write.
acl_number
no
Access control list number.
community_mib_view
no
Mib view name.
community_name
no
Unique name to identify the community.
group_name
no
Unique name to identify the SNMPv3 group.
notify_view
no
Mib view name for notification.
read_view
no
Mib view name for read.
security_level
no
  • noAuthNoPriv
  • authentication
  • privacy
Security level indicating whether to use authentication and encryption.
state
no present
  • present
  • absent
Manage the state of the resource.
write_view
no
Mib view name for write.

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

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

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

  - name: "Undo SNMP group"
    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 Return Values, the following are the fields unique to this module:

name description returned type sample
end_state k/v pairs of aaa params after module execution always dict {'snmp v3 group': {'snmp_group': ['wdz_group', 'noAuthNoPriv', '2000']}}
changed check to see if a change was made on the device always boolean True
updates command sent to the device always list ['snmp-agent group v3 wdz_group noauthentication acl 2000']
proposed k/v pairs of parameters passed into module always dict {'state': 'present', 'group_name': 'wdz_group', 'acl_number': '2000', 'security_level': 'noAuthNoPriv'}
existing k/v pairs of existing aaa server always dict {}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.