community.network.pn_admin_session_timeout – CLI command to modify admin-session-timeout
Note
This plugin is part of the community.network collection (version 3.0.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_admin_session_timeout
.
Parameters
Parameter |
Comments |
---|---|
Target switch to run the CLI on. |
|
Maximum time to wait for user activity before terminating login session. Minimum should be 60s. |
|
State the action to perform. Choices:
|
Examples
- name: Admin session timeout functionality
community.network.pn_admin_session_timeout:
pn_cliswitch: "sw01"
state: "update"
pn_timeout: "61s"
- name: Admin session timeout functionality
community.network.pn_admin_session_timeout:
pn_cliswitch: "sw01"
state: "update"
pn_timeout: "1d"
- name: Admin session timeout functionality
community.network.pn_admin_session_timeout:
pn_cliswitch: "sw01"
state: "update"
pn_timeout: "10d20m3h15s"
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 admin-session-timeout command. Returned: on error |
|
set of responses from the admin-session-timeout command. Returned: always |
Authors
Pluribus Networks (@rajaspachipulusu17)