Try SpotterThis module allows you to configure the session inactivity timeout settings
| "added in version" 4.4.0 of dellemc.openmanage"
Authors: Sachin Apagundi(@sachin-apa)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows you to configure the session inactivity timeout settings on OpenManage Enterprise and OpenManage Enterprise Modular.
---
- name: Configure universal inactivity timeout
ome_application_network_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
session_inactivity_timeout:
enable_universal_timeout: true
universal_timeout: 30
api_sessions: 90
gui_sessions: 5
ssh_sessions: 2
serial_sessions: 1
- name: Configure API and GUI timeout and sessions
ome_application_network_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
session_inactivity_timeout:
api_timeout: 20
api_sessions: 100
gui_timeout: 25
gui_sessions: 5
- name: Configure timeout and sessions for all parameters
ome_application_network_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
session_inactivity_timeout:
api_timeout: 20
api_sessions: 100
gui_timeout: 15
gui_sessions: 5
ssh_timeout: 30
ssh_sessions: 2
serial_timeout: 35
serial_sessions: 1
- name: Disable universal timeout and configure timeout and sessions for other parameters
ome_application_network_settings:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
session_inactivity_timeout:
enable_universal_timeout: false
api_timeout: 20
api_sessions: 100
gui_timeout: 15
gui_sessions: 5
ssh_timeout: 30
ssh_sessions: 2
serial_timeout: 35
serial_sessions: 1
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
session_inactivity_timeout:
description: Session inactivity timeout settings.
suboptions:
api_sessions:
description:
- The maximum number of API sessions to be allowed.
type: int
api_timeout:
description:
- Duration of inactivity in minutes after which the API session ends.
- This is mutually exclusive with I(universal_timeout).
type: float
enable_universal_timeout:
description:
- Enable or disable the universal inactivity timeout.
type: bool
gui_sessions:
description:
- The maximum number of GUI sessions to be allowed.
type: int
gui_timeout:
description:
- Duration of inactivity in minutes after which the web interface of Graphical
User Interface (GUI) session ends.
- This is mutually exclusive with I(universal_timeout).
type: float
serial_sessions:
description:
- The maximum number of serial console sessions to be allowed.
- This is applicable only for OpenManage Enterprise Modular.
type: int
serial_timeout:
description:
- Duration of inactivity in minutes after which the serial console session ends.
- This is applicable only for OpenManage Enterprise Modular.
- This is mutually exclusive with I(universal_timeout).
type: float
ssh_sessions:
description:
- The maximum number of SSH sessions to be allowed.
- This is applicable to OME-M only.
type: int
ssh_timeout:
description:
- Duration of inactivity in minutes after which the SSH session ends.
- This is applicable only for OpenManage Enterprise Modular.
- This is mutually exclusive with I(universal_timeout).
type: float
universal_timeout:
description:
- Duration of inactivity in minutes after which all sessions end.
- This is applicable when I(enable_universal_timeout) is C(true).
- This is mutually exclusive with I(api_timeout), I(gui_timeout), I(ssh_timeout)
and I(serial_timeout).
type: float
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: The number of allowed concurrent sessions for API must be between
1 and 100 sessions.
MessageArgs:
- API
- '1'
- '100'
MessageId: CUSR1233
RelatedProperties: []
Resolution: Enter values in the correct range and retry the operation.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Overall status of the Session timeout settings.
returned: always
sample: Successfully updated the session timeout settings.
type: str
session_inactivity_setting:
description: Returned when session inactivity timeout settings are updated successfully.
returned: success
sample:
- MaxSessionTimeout: 86400000
MaxSessions: 32
MaxSessionsAllowed: 100
MaxSessionsConfigurable: true
MinSessionTimeout: 60000
MinSessionsAllowed: 1
SessionTimeout: 99600
SessionTimeoutConfigurable: true
SessionType: API
- MaxSessionTimeout: 7200000
MaxSessions: 6
MaxSessionsAllowed: 6
MaxSessionsConfigurable: true
MinSessionTimeout: 60000
MinSessionsAllowed: 1
SessionTimeout: 99600
SessionTimeoutConfigurable: true
SessionType: GUI
- MaxSessionTimeout: 10800000
MaxSessions: 4
MaxSessionsAllowed: 4
MaxSessionsConfigurable: true
MinSessionTimeout: 60000
MinSessionsAllowed: 1
SessionTimeout: 99600
SessionTimeoutConfigurable: true
SessionType: SSH
- MaxSessionTimeout: 86400000
MaxSessions: 1
MaxSessionsAllowed: 1
MaxSessionsConfigurable: false
MinSessionTimeout: 60000
MinSessionsAllowed: 1
SessionTimeout: 99600
SessionTimeoutConfigurable: true
SessionType: Serial
- MaxSessionTimeout: 86400000
MaxSessions: 0
MaxSessionsAllowed: 0
MaxSessionsConfigurable: false
MinSessionTimeout: -1
MinSessionsAllowed: 0
SessionTimeout: -1
SessionTimeoutConfigurable: true
SessionType: UniversalTimeout
type: dict