dellemc.openmanage.ome_application_network_webserver 模块 – 更新 OpenManage Enterprise 上的 Web 服务器配置

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅要求了解详情。

要在 playbook 中使用它，请指定：dellemc.openmanage.ome_application_network_webserver。

dellemc.openmanage 2.1.0 中的新增功能

概要 

此模块允许在 OpenManage Enterprise 上配置网络 Web 服务器。

要求 

执行此模块的主机需要以下要求。

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=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。默认值： `443`
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` ← (默认)
webserver_port 整数	OpenManage Enterprise 用于建立安全服务器连接的端口号。警告端口号的更改会导致当前会话在超过一分钟的时间内失去连接。
webserver_timeout 整数	Web 用户界面会话自动断开连接之前的持续时间（以分钟为单位）。如果对会话超时进行了更改，则只有在下一次登录后才会生效。
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 的系统运行此模块。
此模块支持 check_mode。

示例 

---
- name: Update web server port and session time out
  dellemc.openmanage.ome_application_network_webserver:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    webserver_port: 9443
    webserver_timeout: 20

- name: Update session time out
  dellemc.openmanage.ome_application_network_webserver:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    webserver_timeout: 30

- name: Update web server port
  dellemc.openmanage.ome_application_network_webserver:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    webserver_port: 8443

返回值 

常见的返回值已在此处记录此处，以下是此模块独有的字段

键	描述
error_info 字典	HTTP 错误的详细信息。返回：HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "由于 PortNumber 的输入值缺失或无效，无法完成请求。", "MessageArgs": ["PortNumber"], "MessageId": "CGEN6002", "RelatedProperties": [], "Resolution": "输入有效值并重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。查看ExtendedInfo以获取更多信息。"}`
消息字符串	网络Web服务器配置更改的总体状态。返回值：始终示例： `"已成功更新网络Web服务器配置。"`
webserver_configuration 字典	更新的应用程序网络Web服务器配置。返回值：成功示例： `{"EnableWebServer": true, "PortNumber": 443, "TimeOut": 20}`

作者

Jagadeesh N V(@jagadeeshnv)