community.network.pn_snmp_community module – CLI command to create/modify/delete snmp-community

Note

This module is part of the community.network collection (version 4.0.1).

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

Synopsis

  • This module can be used to create SNMP communities for SNMPv1 or delete SNMP communities for SNMPv1 or modify SNMP communities for SNMPv1.

Parameters

Parameter

Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_community_string

string

community name.

pn_community_type

string

community type.

Choices:

  • read-only

  • read-write

state

string / required

State the action to perform. Use present to create snmp-community and absent to delete snmp-community update to update snmp-community.

Choices:

  • present

  • absent

  • update

Examples

- name: Create snmp community
  community.network.pn_snmp_community:
    pn_cliswitch: "sw01"
    state: "present"
    pn_community_string: "foo"
    pn_community_type: "read-write"

- name: Delete snmp community
  community.network.pn_snmp_community:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_community_string: "foo"

- name: Modify snmp community
  community.network.pn_snmp_community:
    pn_cliswitch: "sw01"
    state: "update"
    pn_community_string: "foo"
    pn_community_type: "read-only"

Return Values

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

Key

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the snmp-community command.

Returned: on error

stdout

list / elements=string

set of responses from the snmp-community command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)