dellemc.openmanage.ome_application_network_settings 模块 – 此模块允许您配置会话不活动超时设置

注意

此模块是 dellemc.openmanage 集合(版本 9.9.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 中添加

包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。

hostname

字符串 / 必需

OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

如果未提供密码,则使用环境变量 OME_PASSWORD

示例:export OME_PASSWORD=密码

port

整数

OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。

默认值: 443

session_inactivity_timeout

字典

会话不活动超时设置。

api_sessions

整数

允许的最大 API 会话数。

api_timeout

浮点数

API 会话结束前的非活动持续时间(以分钟为单位)。

这与 universal_timeout 互斥。

enable_universal_timeout

布尔值

启用或禁用通用不活动超时。

选项

  • false

  • true

gui_sessions

整数

允许的最大 GUI 会话数。

gui_timeout

浮点数

图形用户界面 (GUI) 会话的 Web 界面结束前的非活动持续时间(以分钟为单位)。

这与 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_timeouttrue 时适用。

这与 api_timeoutgui_timeoutssh_timeoutserial_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 的系统运行此模块。

  • 要配置其他网络设置(例如网络地址、Web 服务器等),请参阅相应的 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": "API允许的最大并发会话数必须在1到100之间。", "MessageArgs": ["API", "1", "100"], "MessageId": "CUSR1233", "RelatedProperties": [], "Resolution": "输入正确范围内的值,然后重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关更多信息,请参见ExtendedInfo。"}}

msg

字符串

会话超时设置的总体状态。

返回: 始终

示例: "成功更新了会话超时设置。"

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)