ansible.builtin.pn_admin_session_timeout (v2.9.27) — module

CLI command to modify admin-session-timeout

| "added in version" 2.8 of ansible.builtin"

Authors: Pluribus Networks (@rajaspachipulusu17)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module can be used to modify admin session timeout.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: admin session timeout functionality
  pn_admin_session_timeout:
    pn_cliswitch: "sw01"
    state: "update"
    pn_timeout: "61s"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: admin session timeout functionality
  pn_admin_session_timeout:
    pn_cliswitch: "sw01"
    state: "update"
    pn_timeout: "1d"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: admin session timeout functionality
  pn_admin_session_timeout:
    pn_cliswitch: "sw01"
    state: "update"
    pn_timeout: "10d20m3h15s"

Inputs

    
state:
    choices:
    - update
    description:
    - State the action to perform. C(update) to modify the admin-session-timeout.
    required: true
    type: str

pn_timeout:
    description:
    - Maximum time to wait for user activity before terminating login session. Minimum
      should be 60s.
    required: false
    type: str

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error responses from the admin-session-timeout command.
  returned: on error
  type: list
stdout:
  description: set of responses from the admin-session-timeout command.
  returned: always
  type: list