You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_snmp_location - Manages SNMP location configuration on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages SNMP location configurations on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
location	yes			Location information.
state	no	present	present absent	Manage the state of the resource.

Examples ¶

- name: CloudEngine snmp location 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 location"
    ce_snmp_location:
      state: present
      location: nanjing China
      provider: "{{ cli }}"

  - name: "Remove SNMP location"
    ce_snmp_location:
      state: absent
      location: nanjing China
      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
changed	check to see if a change was made on the device	always	boolean	True
end_state	k/v pairs of aaa params after module execution	always	dict	{'location': 'nanjing China'}
existing	k/v pairs of existing aaa server	always	dict	{}
proposed	k/v pairs of parameters passed into module	always	dict	{'state': 'present', 'location': 'nanjing China'}
updates	command sent to the device	always	list	['snmp-agent sys-info location nanjing China']

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.