theforeman.foreman.webhook 模块 – Webhook 管理

注意

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

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

要安装它，请使用： ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定： theforeman.foreman.webhook。

theforeman.foreman 4.0.0 中的新增功能

摘要 

管理 Webhook

要求 

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

requests

参数 

参数	注释
enabled 布尔值	启用或禁用 Webhook 选项 `false` `true`
event 字符串	应触发 Webhook 的事件名称创建新的 Webhook 时必需
http_content_type 字符串	Webhook 的 HTTP 内容类型
http_headers 字符串	Webhook 的 HTTP 头
http_method 字符串	Webhook 中使用的 HTTP 方法选项 `"POST"` `"GET"` `"PUT"` `"DELETE"` `"PATCH"`
locations 列表 / 元素=字符串	应将实体分配到的位置列表
name 字符串 / 必需	Webhook 的名称
organizations 列表 / 元素=字符串	应将实体分配到的组织列表
password 字符串 / 必需	访问 Foreman 服务器的用户密码。如果任务中未指定此值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
proxy_authorization 布尔值	使用客户端证书授权并验证来自设置的 CA 选项 `false` `true`
server_url 字符串 / 必需	Foreman 服务器的 URL。如果任务中未指定此值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
ssl_ca_certs 字符串	以 PEM 格式连接的 X509 证书颁发机构
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
target_url 字符串	触发 Webhook 时要调用的 URL 创建新的 Webhook 时必需
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果任务中未指定此值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定此值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)
verify_ssl 布尔值	验证 Webhook 的 SSL 证书选项 `false` `true`
webhook_password 字符串	Webhook 密码（如果需要）
webhook_template 字符串	Webhook 模板名称
webhook_username 字符串	Webhook 用户名（如果需要）

属性 

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

示例 

- name: 'Create Webhook'
  theforeman.foreman.webhook:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'test-webhook'
    target_url: 'https://google.com'
    http_method: 'GET'
    event: 'actions.katello.content_view.promote_succeeded'
    enabled: true
    organizations:
      - 'MyOrg'
    locations:
      - 'DC1'

- name: 'Remove Webhook'
  theforeman.foreman.webhook:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'test-webhook'
    state: 'absent'

返回值 

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

键	描述
entity 字典	按类型分组的受影响实体的最终状态。返回：成功
webhooks 列表 / 元素=字典	Webhook 列表。返回：成功

作者

Griffin Sullivan (@Griffin-Sullivan)