community.network.pn_user module – CLI command to create/modify/delete user

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

Synopsis

  • This module can be used to create a user and apply a role, update a user and delete a user.

Parameters

Parameter

Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_initial_role

string

initial role for user.

pn_name

string

username.

pn_password

string

plain text password.

pn_scope

string

local or fabric.

Choices:

  • local

  • fabric

state

string / required

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

Choices:

  • present

  • absent

  • update

Examples

- name: Create user
  community.network.pn_user:
    pn_cliswitch: "sw01"
    state: "present"
    pn_scope: "fabric"
    pn_password: "foo123"
    pn_name: "foo"

- name: Delete user
  community.network.pn_user:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_name: "foo"

- name: Modify user
  community.network.pn_user:
    pn_cliswitch: "sw01"
    state: "update"
    pn_password: "test1234"
    pn_name: "foo"

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

Returned: on error

stdout

list / elements=string

set of responses from the user command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)