dellemc.openmanage.ome_application_network_settings модуль — Этот модуль позволяет настроить параметры тайм-аута неактивности сеанса

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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=пароль
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=имя_пользователя
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)

Ссылки на сборку

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