W3cubDocs

/Ansible

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

Note

This module is part of the community.network collection (version 5.1.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.

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

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

Aliases: network.netvisor.pn_admin_session_timeout

Parameters

Parameter

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

State the action to perform. update to modify the admin-session-timeout.

Choices:

  • "update"

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

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the admin-session-timeout command.

Returned: on error

stdout

list / elements=string

set of responses from the admin-session-timeout command.

Returned: always

Status

  • This module will be removed in version 6.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_admin_session_timeout_module.html