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.

community.network.ce_snmp_location – Manages SNMP location configuration on HUAWEI CloudEngine switches.

Note

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

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_location.

Synopsis

• Manages SNMP location configurations on HUAWEI CloudEngine switches.

Parameters

Parameter	Comments
location string / required	Location information.
state string	Manage the state of the resource. Choices: present ← (default) absent

Notes

Note

• Recommended connection is network_cli.

• This module also works with local connections for legacy playbooks.

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"
    community.network.ce_snmp_location:
      state: present
      location: nanjing China
      provider: "{{ cli }}"

  - name: "Remove SNMP location"
    community.network.ce_snmp_location:
      state: absent
      location: nanjing China
      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: {“location”: “nanjing China”}
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: {“location”: “nanjing China”, “state”: “present”}
updates list / elements=string	command sent to the device Returned: always Sample: [“snmp-agent sys-info location nanjing China”]

Authors

• wangdezhuang (@QijunPan)