cloudscale_ch.cloud.load_balancer_health_monitor 模块 – 管理 cloudscale.ch IaaS 服务上的负载均衡器

注意

此模块是 cloudscale_ch.cloud 集合（版本 2.4.0）的一部分。

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

要安装它，请使用： ansible-galaxy collection install cloudscale_ch.cloud。

要在 playbook 中使用它，请指定：cloudscale_ch.cloud.load_balancer_health_monitor。

cloudscale_ch.cloud 2.3.0 中的新增功能

概要 

在 cloudscale.ch IaaS 服务上获取、创建、更新、删除健康监视器。

参数 

参数	注释
api_timeout 整数	调用 cloudscale.ch API 的超时时间（以秒为单位）。也可以在 `CLOUDSCALE_API_TIMEOUT` 环境变量中传递此值。默认值： `45`
api_token 字符串 / 必需	cloudscale.ch API 令牌。也可以在 `CLOUDSCALE_API_TOKEN` 环境变量中传递此值。
api_url 字符串在 cloudscale_ch.cloud 1.3.0 中添加	cloudscale.ch API URL。也可以在 `CLOUDSCALE_API_URL` 环境变量中传递此值。默认值： `"https://api.cloudscale.ch/v1"`
delay_s 整数	两次连续检查之间的延迟时间（以秒为单位）。
down_threshold 整数	池成员的 monitor_status 变为“down”之前需要失败的检查次数。
http 字典	类型为“http”或“https”的健康监视器的高级选项。
expected_codes 列表 / 元素=字符串	HTTP 状态代码允许检查被认为是成功的。有关详细信息，请参阅 [API 文档](https://www.cloudscale.ch/en/api/v1#http-attribute-specification)。
host 字符串	检查中使用的 HTTP Host 标头中的服务器名称。要求将 version 设置为“1.1”。
method 字符串	用于检查的 HTTP 方法。
url_path 字符串	用于检查的 URL。
version 字符串	用于检查的 HTTP 版本。
pool 字符串	健康监视器的池。
state 字符串	负载均衡器健康监视器的状态。选项 `"present"` ←（默认） `"absent"`
tags 字典	与负载均衡器关联的标签。将此设置为 `{}` 以清除所有标签。
timeout_s 整数	单个检查允许的最大时间（以秒为单位）。
type 字符串	健康监视器的类型。有关允许的选项，请参阅 [API 文档](https://www.cloudscale.ch/en/api/v1#create-a-health-monitor)。
up_threshold 整数	池成员的 monitor_status 变为“up”之前需要成功的检查次数。
uuid 字符串	负载均衡器健康监视器的 UUID。

说明 

注意

健康监视器没有名称。 uuid 用于引用健康监视器。
所有操作均使用 cloudscale.ch 公共 API v1 执行。
有关详细信息，请参阅完整的 API 文档：https://www.cloudscale.ch/en/api/v1。
所有操作都需要有效的 API 令牌。您可以使用 https://control.cloudscale.ch 上的 cloudscale.ch 控制面板创建任意数量的令牌。

示例 

# Create a simple health monitor for a pool
- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'swimming-pool'
    load_balancer: '3d41b118-f95c-4897-ad74-2260fea783fc'
    algorithm: 'round_robin'
    protocol: 'tcp'
    api_token: xxxxxx
  register: load_balancer_pool

- name: Create a load balancer health monitor (ping)
  cloudscale_ch.cloud.load_balancer_health_monitor:
    pool: '{{ load_balancer_pool.uuid }}'
    type: 'ping'
    api_token: xxxxxx
  register: load_balancer_health_monitor

# Get load balancer health monitor facts by UUID
- name: Get facts of a load balancer health monitor by UUID
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor.uuid }}'
    api_token: xxxxxx

# Update a health monitor
- name: Update HTTP method of a load balancer health monitor from GET to CONNECT
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor_http.uuid }}'
    delay_s: 2
    timeout_s: 1
    up_threshold: 2
    down_threshold: 3
    type: 'http'
    http:
      expected_codes:
        - 200
        - 202
      method: 'CONNECT'
      url_path: '/'
      version: '1.1'
      host: 'host1'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer_health_monitor

返回值 

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

键	描述
created_at 字符串	负载均衡器健康监视器的创建日期和时间返回：当 state != absent 时成功示例： `"2023-02-22T09:55:38.285018Z"`
delay_s 整数	两次连续检查之间的延迟时间（以秒为单位）返回：当 state != absent 时成功示例： `2`
down_threshold 整数	池成员的 monitor_status 变为“down”之前需要失败的检查次数返回：当 state != absent 时成功示例： `3`
href 字符串	API URL 以获取有关此负载均衡器健康监视器的详细信息返回：当 state != absent 时成功示例： `"https://api.cloudscale.ch/v1/load-balancers/health-monitors/ee4952d4-2eba-4dec-8957-7911b3ce245b"`
http 字典	类型为“http”或“https”的健康监视器的高级选项返回：当 state != absent 时成功示例： `[{"expected_codes": ["200"], "host": null, "method": "GET", "url_path": "/", "version": "1.0"}]`
pool 字典	健康监视器的池返回：当 state != absent 时成功示例: `[{"href": "https://api.cloudscale.ch/v1/load-balancers/pools/618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"uuid": "618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"name": "swimming pool"}]`
tags 字典	与负载均衡器关联的标签返回: 成功示例: `{"project": "my project"}`
timeout_s 整数	单个检查允许的最大时间（以秒为单位）返回：当 state != absent 时成功示例: `1`
type 字符串	健康监控的类型返回：当 state != absent 时成功
up_threshold 整数	池成员的 monitor_status 变为“up”之前需要成功的检查次数返回：当 state != absent 时成功示例： `2`
uuid 字符串	此负载均衡器健康监控的唯一标识符返回: 成功示例: `"ee4952d4-2eba-4dec-8957-7911b3ce245b"`

作者

Gaudenz Steinlin (@gaudenz)
Kenneth Joss (@k-304)