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

Note

This module is part of the community.network collection (version 3.3.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_role.

Synopsis

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

Parameters

Parameter

Comments

pn_access

string

type of access.

Choices:

  • read-only

  • read-write

pn_cliswitch

string

Target switch to run the CLI on.

pn_delete_from_users

boolean

delete from users.

Choices:

  • no

  • yes

pn_name

string / required

role name.

pn_running_config

boolean

display running configuration of switch.

Choices:

  • no

  • yes

pn_scope

string

local or fabric.

Choices:

  • local

  • fabric

pn_shell

boolean

allow shell command.

Choices:

  • no

  • yes

pn_sudo

boolean

allow sudo from shell.

Choices:

  • no

  • yes

state

string / required

State the action to perform. Use present to create role and absent to delete role and update to modify role.

Choices:

  • present

  • absent

  • update

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

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 role command.

Returned: on error

stdout

list / elements=string

set of responses from the role command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)