dellemc.openmanage.ome_application_network_settings module – This module allows you to configure the session inactivity timeout settings
Note
This module is part of the dellemc.openmanage collection (version 9.8.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 dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_application_network_settings.
New in dellemc.openmanage 4.4.0
Synopsis
This module allows you to configure the session inactivity timeout settings on OpenManage Enterprise and OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Session inactivity timeout settings. |
|
The maximum number of API sessions to be allowed. |
|
Duration of inactivity in minutes after which the API session ends. This is mutually exclusive with universal_timeout. |
|
Enable or disable the universal inactivity timeout. Choices:
|
|
The maximum number of GUI sessions to be allowed. |
|
Duration of inactivity in minutes after which the web interface of Graphical User Interface (GUI) session ends. This is mutually exclusive with universal_timeout. |
|
The maximum number of serial console sessions to be allowed. This is applicable only for OpenManage Enterprise Modular. |
|
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 universal_timeout. |
|
The maximum number of SSH sessions to be allowed. This is applicable to OME-M only. |
|
Duration of inactivity in minutes after which the SSH session ends. This is applicable only for OpenManage Enterprise Modular. This is mutually exclusive with universal_timeout. |
|
Duration of inactivity in minutes after which all sessions end. This is applicable when enable_universal_timeout is This is mutually exclusive with api_timeout, gui_timeout, ssh_timeout and serial_timeout. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise or OpenManage Enterprise Modular.
To configure other network settings such as network address, web server, and so on, refer to the respective OpenManage Enterprise application network setting modules.
This module supports
check_mode.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the Session timeout settings. Returned: always Sample: |
|
Returned when session inactivity timeout settings are updated successfully. Returned: success Sample: |