модуль dellemc.openmanage.ome_application_network_settings — этот модуль позволяет настраивать время ожидания бездействия сеанса

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.ome_application_network_settings.

Новый модуль в dellemc.openmanage 4.4.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать время ожидания бездействия сеанса в OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
hostname строка / обязательный	IP-адрес или имя узла OpenManage Enterprise либо OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
session_inactivity_timeout словарь	Настройки времени ожидания бездействия сеанса.
api_sessions целое число	Максимально допустимое количество сеансов API.
api_timeout число с плавающей точкой	Продолжительность бездействия в минутах, по истечении которой сеанс API завершается. Этот параметр нельзя использовать одновременно с universal_timeout.
enable_universal_timeout логический	Включить или отключить универсальное время ожидания бездействия. Варианты: `false` `true`
gui_sessions целое число	Максимально допустимое количество сеансов GUI.
gui_timeout число с плавающей точкой	Продолжительность бездействия в минутах, по истечении которой завершается сеанс веб-интерфейса графического интерфейса пользователя (GUI). Этот параметр нельзя использовать одновременно с universal_timeout.
serial_sessions целое число	Максимально допустимое количество сеансов последовательной консоли. Применимо только к OpenManage Enterprise Modular.
serial_timeout число с плавающей точкой	Продолжительность бездействия в минутах, по истечении которой завершается сеанс последовательной консоли. Применимо только к OpenManage Enterprise Modular. Этот параметр нельзя использовать одновременно с universal_timeout.
ssh_sessions целое число	Максимально допустимое количество сеансов SSH. Применимо только к OME-M.
ssh_timeout число с плавающей точкой	Продолжительность бездействия в минутах, по истечении которой завершается сеанс SSH. Применимо только к OpenManage Enterprise Modular. Этот параметр нельзя использовать одновременно с universal_timeout.
universal_timeout число с плавающей точкой	Продолжительность бездействия в минутах, по истечении которой завершаются все сеансы. Применяется, когда параметр enable_universal_timeout имеет значение `true`. Этот параметр нельзя использовать одновременно с api_timeout, gui_timeout, ssh_timeout и serial_timeout.
timeout целое число добавлен в dellemc.openmanage 5.0.0	Время ожидания на уровне сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs логический добавлен в dellemc.openmanage 5.0.0	Если `false`, проверка сертификатов SSL выполняться не будет. Настраивайте `false` только на сайтах под личным контролем, где используются самозаверяющие сертификаты. До версии коллекции `5.0.0` параметр validate_certs по умолчанию имел значение `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлен в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise или OpenManage Enterprise Modular.
Для настройки других параметров сети, таких как сетевой адрес, веб-сервер и т. д., см. соответствующие модули настройки сети приложения OpenManage Enterprise.
Этот модуль поддерживает check_mode.

Примеры

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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
error_info словарь	Сведения об ошибке HTTP. Возвращается: при ошибке HTTP Пример: `{"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."}}`
msg строка	Общий статус настроек времени ожидания сеанса. Возвращается: всегда Пример: `"Successfully updated the session timeout settings."`
session_inactivity_setting словарь	Возвращается, если настройки времени ожидания бездействия сеанса успешно обновлены. Возвращается: при успешном выполнении Пример: [{"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"}]

Авторы

Sachin Apagundi(@sachin-apa)
Sapana Gupta (@sapana05)

Ссылки на коллекцию

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