community.network.pn_user – CLI command to create/modify/delete user
community.network.pn_user – CLI command to create/modify/delete user
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_user
.
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 or fabric. |
state string / required |
|
State the action to perform. Use |
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 | 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 user command.
|
stdout list / elements=string |
always |
set of responses from the user 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_user_module.html