W3cubDocs

/Ansible 2.11

community.network.ce_snmp_contact – Manages SNMP contact configuration on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_snmp_contact.

Synopsis

  • Manages SNMP contact configurations on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
contact
string / required
Contact information.
state
string
    Choices:
  • present ←
  • absent
Manage the state of the resource.

Notes

Note

  • Recommended connection is network_cli.
  • This module also works with local connections for legacy playbooks.

Examples

- name: CloudEngine snmp contact 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 contact"
    community.network.ce_snmp_contact:
      state: present
      contact: call Operator at 010-99999999
      provider: "{{ cli }}"

  - name: "Undo SNMP contact"
    community.network.ce_snmp_contact:
      state: absent
      contact: call Operator at 010-99999999
      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:
{'contact': 'call Operator at 010-99999999'}
existing
dictionary
always
k/v pairs of existing aaa server
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'contact': 'call Operator at 010-99999999', 'state': 'present'}
updates
list / elements=string
always
command sent to the device

Sample:
['snmp-agent sys-info contact call Operator at 010-99999999']


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/2.11/collections/community/network/ce_snmp_contact_module.html