W3cubDocs

/Ansible 2.11

community.network.pn_admin_session_timeout – CLI command to modify admin-session-timeout

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

Synopsis

  • This module can be used to modify admin session timeout.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_timeout
string
Maximum time to wait for user activity before terminating login session. Minimum should be 60s.
state
string / required
    Choices:
  • update
State the action to perform. update to modify the admin-session-timeout.

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 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 admin-session-timeout command.

stdout
list / elements=string
always
set of responses from the admin-session-timeout 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_admin_session_timeout_module.html