W3cubDocs

/Ansible

ce_snmp_contact - Manages SNMP contact configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages SNMP contact configurations on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
contact
 yes
Contact information.
state
 no present
  • present
  • absent
Manage the state of the resource.

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"
    ce_snmp_contact:
      state: present
      contact: call Operator at 010-99999999
      provider: "{{ cli }}"

  - name: "Undo SNMP contact"
    ce_snmp_contact:
      state: absent
      contact: call Operator at 010-99999999
      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 {'contact': 'call Operator at 010-99999999'}
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 sys-info contact call Operator at 010-99999999']
proposed
k/v pairs of parameters passed into module
 always dict {'state': 'present', 'contact': 'call Operator at 010-99999999'}
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.

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ce_snmp_contact_module.html