community.network.pn_role – CLI command to create/delete/modify role

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_role.

Synopsis
Parameters
Examples
Return Values

Synopsis

This module can be used to create, delete and modify user roles.

Parameters

Parameter	Choices/Defaults	Comments
pn_access string	read-only read-write	type of access.
pn_cliswitch string		Target switch to run the CLI on.
pn_delete_from_users boolean	no yes	delete from users.
pn_name string / required		role name.
pn_running_config boolean	no yes	display running configuration of switch.
pn_scope string	local fabric	local or fabric.
pn_shell boolean	no yes	allow shell command.
pn_sudo boolean	no yes	allow sudo from shell.
state string / required	present absent update	State the action to perform. Use `present` to create role and `absent` to delete role and `update` to modify role.

Examples

- name: Role create
  community.network.pn_role:
    pn_cliswitch: 'sw01'
    state: 'present'
    pn_name: 'foo'
    pn_scope: 'local'
    pn_access: 'read-only'

- name: Role delete
  community.network.pn_role:
    pn_cliswitch: 'sw01'
    state: 'absent'
    pn_name: 'foo'

- name: Role modify
  community.network.pn_role:
    pn_cliswitch: 'sw01'
    state: 'update'
    pn_name: 'foo'
    pn_access: 'read-write'
    pn_sudo: true
    pn_shell: true

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 role command.
stdout list / elements=string	always	set of responses from the role 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/2.11/collections/community/network/pn_role_module.html