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.2).
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 |
---|---|
Target switch to run the CLI on. |
|
initial role for user. |
|
username. |
|
plain text password. |
|
local or fabric. Choices:
|
|
State the action to perform. Use Choices:
|
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 |
---|---|
indicates whether the CLI caused changes on the target. Returned: always |
|
the CLI command run on the target node. Returned: always |
|
set of error responses from the user command. Returned: on error |
|
set of responses from the user command. Returned: always |