Note
This plugin is part of the community.network collection.
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.ce_snmp_location.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| location string / required | Location information. | |
| state string |
| Manage the state of the resource. |
Note
network_cli.local connections for legacy playbooks.- 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 }}"
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: {'location': 'nanjing China'} |
| existing dictionary | always | k/v pairs of existing aaa server |
| proposed dictionary | always | k/v pairs of parameters passed into module Sample: {'location': 'nanjing China', 'state': 'present'} |
| updates list / elements=string | always | command sent to the device Sample: ['snmp-agent sys-info location nanjing China'] |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_snmp_location_module.html