dellemc.openmanage.ome_application_network_proxy 模块 – 更新 OpenManage Enterprise 上的代理配置

注意

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

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

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

要在 playbook 中使用它,请指定:dellemc.openmanage.ome_application_network_proxy

dellemc.openmanage 2.1.0 中的新增功能

概要

  • 此模块允许在 OpenManage Enterprise 上配置网络代理。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

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

enable_authentication

布尔值

启用或禁用代理身份验证。

如果 enable_authentication 为 true,则必须提供 proxy_usernameproxy_password

如果 enable_authentication 为 false,则代理用户名和密码将设置为其默认值。

选项

  • false

  • true

enable_proxy

布尔值 / 必需

启用或禁用 HTTP 代理配置。

如果 enable proxy 为 false,则 HTTP 代理配置将设置为其默认值。

选项

  • false

  • true

hostname

字符串 / 必需

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

ignore_certificate_validation

别名:ssl_check_disabled

布尔值

在 dellemc.openmanage 9.5.0 中添加

此选项将忽略集成的证书检查,例如用于保修和目录更新的检查。

true 忽略证书验证。

false 不忽略证书验证。

选项

  • false ← (默认)

  • true

ip_address

字符串

代理服务器地址。

enable_proxy 为 true 时,此选项是必需的。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

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

示例:export OME_PASSWORD=password

port

整数

OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。

默认值: 443

proxy_exclusion_list

列表 / 元素=字符串

在 dellemc.openmanage 9.5.0 中添加

可以绕过代理服务器直接访问设备的 IPv4 地址、IPv6 地址或域名列表。

proxy_password

字符串

代理服务器密码。

enable_authentication 为 true 时,此选项是必需的。

proxy_port

整数

代理服务器的端口号。

enable_proxy 为 true 时,此选项是必需的。

proxy_username

字符串

代理服务器用户名。

enable_authentication 为 true 时,此选项是必需的。

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

以秒为单位的套接字级别超时。

默认值: 30

update_password

布尔值

在 dellemc.openmanage 9.5.0 中添加

此标志用于更新 proxy_password

这仅在 enable_authenticationtrue 时适用。

true 将更新 proxy_password

false 将不更新 proxy_password

选项

  • false ← (默认)

  • true

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

  • 此模块支持 check_mode

  • 此模块支持 IPv4 和 IPv6 地址。

示例

---
- name: Update proxy configuration and enable authentication
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: true
    proxy_username: "proxy_username"
    proxy_password: "proxy_password"

- name: Reset proxy authentication
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: false

- name: Reset proxy configuration
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: false

- name: Add IPv4, IPv6 and domain names of devices in proxy exclusion list
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: false
    proxy_exclusion_list:
      - 192.168.1.0
      - 191.187.2.0
      - www.*.com
      - 191.1.168.1/24

- name: Clear the proxy exclusion list
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    proxy_exclusion_list: []

- name: Ignore the certificate validation
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    ignore_certificate_validation: true

返回值

常见的返回值记录在这里,以下是此模块特有的字段

描述

error_info

字典

HTTP 错误的详细信息。

返回: 在 HTTP 错误时

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "由于端口号的输入值缺失或输入了无效值,无法完成请求。", "MessageArgs": ["PortNumber"], "MessageId": "CGEN6002", "RelatedProperties": [], "Resolution": "输入一个有效值并重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。请查看ExtendedInfo以获取更多信息。"}}

msg

字符串

网络代理配置更改的总体状态。

返回: 始终

示例: "成功更新网络代理配置。"

proxy_configuration

字典

更新后的应用程序网络代理配置。

返回: 成功配置网络代理设置时

示例: {"EnableAuthentication": true, "EnableProxy": true, "IpAddress": "192.168.0.2", "Password": null, "PortNumber": 444, "ProxyExclusionList": ["192.168.0.1", "www.*.com", "172.1.1.1/24"], "SslCheckDisabled": false, "Username": "root"}

作者

  • Sajna Shetty(@Sajna-Shetty)

  • Rajshekar P(@rajshekarp87)