W3cubDocs

/Ansible

community.network.pn_snmp_vacm – CLI command to create/modify/delete snmp-vacm

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

Synopsis

  • This module can be used to create View Access Control Models (VACM), modify VACM and delete VACM.

Parameters

Parameter Choices/Defaults Comments
pn_auth
boolean
    Choices:
  • no
  • yes
authentication required.
pn_cliswitch
string
Target switch to run the CLI on.
pn_oid_restrict
string
restrict OID.
pn_priv
boolean
    Choices:
  • no
  • yes
privileges.
pn_user_name
string
SNMP administrator name.
pn_user_type
string
    Choices:
  • rouser
  • rwuser
SNMP user type.
state
string / required
    Choices:
  • present
  • absent
  • update
State the action to perform. Use present to create snmp-vacm and absent to delete snmp-vacm and update to modify snmp-vacm.

Examples

- name: Create snmp vacm
  community.network.pn_snmp_vacm:
    pn_cliswitch: "sw01"
    state: "present"
    pn_user_name: "foo"
    pn_user_type: "rouser"

- name: Update snmp vacm
  community.network.pn_snmp_vacm:
    pn_cliswitch: "sw01"
    state: "update"
    pn_user_name: "foo"
    pn_user_type: "rwuser"

- name: Delete snmp vacm
  community.network.pn_snmp_vacm:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_user_name: "foo"

Return Values

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

Key Returned Description
changed
boolean
always
indicates whether the CLI caused changes on the target.
command
string
always
the CLI command run on the target node.
stderr
list / elements=string
on error
set of error responses from the snmp-vacm command.
stdout
list / elements=string
always
set of responses from the snmp-vacm command.


Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_snmp_vacm_module.html