cisco.nxos.nxos_snmp_community module – (deprecated, removed after 2024-01-01) Manages SNMP community configs.

Note

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

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

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 community configuration.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

access

string

Access type for community.

Choices:

  • "ro"

  • "rw"

acl

string

ACL name to filter snmp requests or keyword ‘default’.

community

string / required

Case-sensitive community string.

group

string

Group to which the community belongs.

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 community is configured
- cisco.nxos.nxos_snmp_community:
    community: TESTING7
    group: network-operator
    state: present

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 community TESTING7 group network-operator"]

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)