pn_user – CLI command to create/modify/delete user

From Get docs
Ansible/docs/2.9/modules/pn user module


pn_user – CLI command to create/modify/delete user

New in version 2.8.


Synopsis

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

Parameters

Parameter Choices/Defaults 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
  • fabric

local or fabric.

state

string / required

  • present
  • absent
  • update

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



Examples

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

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

- name: Modify user
  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 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

on error

set of error responses from the user command.


stdout

list

always

set of responses from the user command.





Status

Authors

  • Pluribus Networks (@rajaspachipulusu17)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/pn_user_module.html