theforeman.foreman.http_proxy 模块 – 管理 HTTP 代理

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要更多要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：theforeman.foreman.http_proxy。

theforeman.foreman 1.1.0 中新增

概要 

创建、更新和删除 HTTP 代理

要求 

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

requests

参数 

参数	注释
locations 列表 / 元素=字符串	实体应分配到的位置列表
name 字符串 / 必需	HTTP 代理名称
organizations 列表 / 元素=字符串	实体应分配到的组织列表
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
proxy_password 字符串	用于向 HTTP 代理进行身份验证的密码设置此参数后，模块将不具有幂等性。
proxy_username 字符串	用于向 HTTP 代理进行身份验证的用户名
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
url 字符串	HTTP 代理的 URL 创建新的 HTTP 代理时必需。
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全	可以在 check_mode 下运行，并返回更改状态预测而不修改实体
diff_mode	支持：完全	在 diff 模式下运行时，将返回有关已更改（或可能需要在 check_mode 下更改）的内容的详细信息

示例 

- name: create example.org proxy
  theforeman.foreman.http_proxy:
    name: "example.org"
    url: "http://example.org:3128"
    locations:
      - "Munich"
    organizations:
      - "ACME"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

返回值 

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

键	描述
entity 字典	受影响实体的最终状态，按其类型分组。已返回：成功
http_proxies 列表 / 元素=字典	HTTP 代理列表。已返回：成功

作者

Evgeni Golov (@evgeni)