openstack.cloud.lb_health_monitor 模块 – 管理 OpenStack 负载均衡池中的健康监视器

注意

此模块是 openstack.cloud 集合 (版本 2.3.0) 的一部分。

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

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

要在 playbook 中使用它，请指定：openstack.cloud.lb_health_monitor。

概要

  • 在 OpenStack 云中添加、更新或删除负载均衡池的健康监视器。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的身份验证，则应在此处指示插件的名称，并相应地更新 auth 参数的内容。

ca_cert

别名：cacert

字符串

CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。

client_cert

别名：cert

字符串

客户端证书的路径，用作 SSL 事务的一部分。

client_key

别名：key

字符串

客户端密钥的路径，用作 SSL 事务的一部分。

cloud

任何

要操作的命名云或云配置。如果 cloud 是字符串，则它引用 OpenStack clouds.yaml 文件中定义的命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。

delay

整数

健康检查之间的间隔（以秒为单位）。

当 state 为 present 时是必需的。

expected_codes

字符串

成员响应中声明其健康状况的预期 HTTP 状态代码列表。指定以下值之一。

例如，expected_codes 可以是单个值，例如 200，列表，例如 200, 202 或范围，例如 200-204。

Octavia 的 expected_codes 默认值为 200。

health_monitor_timeout

别名：resp_timeout

整数

健康检查超时的时间（以秒为单位）。

必须小于 delay。

当 state 为 present 时是必需的。

http_method

字符串

健康监视器用于请求的 HTTP 方法。

例如，http_method 可以是 CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT 或 TRACE。

Octavia 的 http_method 默认值为 GET。

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

is_admin_state_up

别名：admin_state_up

布尔值

健康监视器是开启还是关闭。

选择

  • false

  • true

max_retries

整数

在将成员的运行状态更改为 ONLINE 之前成功检查的次数。

当 state 为 present 时是必需的。

max_retries_down

整数

允许在将成员的操作状态更改为 ERROR 之前发生的检查失败次数。有效值介于 1 到 10 之间。

name

string / required

必须赋予健康监视器的名称。

此属性无法更新。

pool

字符串

要由健康监视器监控的池的名称或 ID。

当 state 为 present 时是必需的。

此属性无法更新。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 的日志文件的路径。如果为空，则不写入日志

state

字符串

资源应该是存在还是不存在。

选择

  • "present" ← (默认)

  • "absent"

timeout

整数

Ansible 应该等待请求的资源多长时间。

默认值： 180

type

字符串

健康监视器的类型。

例如，type 可以是 HTTP、HTTPS、PING、SCTP、TCP、TLS-HELLO 或 UDP-CONNECT。

此属性无法更新。

默认值： "HTTP"

url_path

字符串

监视器发送的用于测试后端成员健康状况的 HTTP URL 路径。

必须是以正斜杠 (/) 开头的字符串。

Octavia 的默认 URL 路径是 /。

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，此值默认为 true。

选择

  • false

  • true

wait

布尔值

Ansible 是否应等待直到请求的资源完成。

选择

  • false

  • true ← (默认)

注释

注意

  • 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create a load-balancer health monitor
  openstack.cloud.lb_health_monitor:
    cloud: devstack
    delay: 10
    expected_codes: '200'
    health_monitor_timeout: 5
    http_method: GET
    is_admin_state_up: true
    max_retries: 3
    max_retries_down: 4
    name: healthmonitor01
    pool: lb_pool
    state: present
    url_path: '/status'

- name: Delete a load-balancer health monitor
  openstack.cloud.lb_health_monitor:
    cloud: devstack
    name: healthmonitor01
    state: absent

返回值

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

键

描述

health_monitor

字典

描述负载均衡器健康监视器的字典。

返回：当 state 为 present 时，成功返回。

created_at

字符串

创建资源时的 UTC 日期和时间戳。

返回：成功

delay

整数

向成员发送探测之间的时间间隔（以秒为单位）。

返回：成功

expected_codes

字符串

预期从成员响应中返回以声明其健康的 HTTP 状态代码列表。

返回：成功

http_method

字符串

健康监视器用于请求的 HTTP 方法。

返回：成功

id

字符串

健康监视器 UUID。

返回：成功

is_admin_state_up

布尔值

资源的管理状态。

返回：成功

max_retries

整数

在将成员的运行状态更改为 ONLINE 之前成功检查的次数。

返回：成功

max_retries_down

整数

允许在将成员的操作状态更改为 ERROR 之前发生的检查失败次数。

返回：成功

name

字符串

资源的人类可读名称。

返回：成功

operating_status

字符串

资源的操作状态。

返回：成功

pool_id

字符串

池的 ID。

返回：成功

pools

list / elements=string

关联的池 ID 列表。

返回：成功

project_id

字符串

拥有此资源的项目的 ID。

返回：成功

provisioning_status

字符串

资源的配置状态。

返回：成功

tags

list / elements=string

关联的标签列表。

返回：成功

timeout

整数

监视器在超时之前等待连接的最长时间（以秒为单位）。

返回：成功

type

字符串

健康监视器的类型。

返回：成功

updated_at

字符串

资源上次更新时的 UTC 日期和时间戳。

返回：成功

url_path

字符串

监视器发送的用于测试后端成员健康状况的 HTTP URL 路径。

返回：成功

作者

  • OpenStack Ansible SIG