W3cubDocs

/Ansible

cisco.nxos.nxos_snmp_location module – (deprecated, removed after 2024-01-01) Manages SNMP location information.

Note

This module is part of the cisco.nxos collection (version 9.4.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 cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_snmp_location.

New in cisco.nxos 1.0.0

DEPRECATED

Removed in:

major release after 2024-01-01

Why:

Updated modules released with more functionality

Alternative:

nxos_snmp_server

Synopsis

  • Manages SNMP location configuration.

Parameters

Parameter

Comments

location

string / required

Location information.

state

string

Manage the state of the resource.

Choices:

  • "present" ← (default)
  • "absent"

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • Limited Support for Cisco MDS
  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

# ensure snmp location is configured
- cisco.nxos.nxos_snmp_location:
    location: Test
    state: present

# ensure snmp location is not configured
- cisco.nxos.nxos_snmp_location:
    location: Test
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

commands sent to the device

Returned: always

Sample: ["snmp-server location New_Test"]

Status

  • This module will be removed in a major release after 2024-01-01. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_snmp_location_module.html