openstack.cloud.lb_listener 模块 – 在 OpenStack 云中管理负载均衡器监听器

注意

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

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

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

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

概要 

从 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 的某个部分中一样。
default_tls_container_ref 字符串	指向密钥管理器服务密钥容器的 URI，其中包含 TLS 密钥。
description 字符串	负载均衡器监听器的人工可读描述。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选择 `"admin"` `"internal"` `"public"` ← (默认)
is_admin_state_up 布尔值	监听器的管理状态，可以是启动或关闭。选择 `false` `true`
load_balancer 别名：loadbalancer 字符串	此监听器所属的负载均衡器的名称或 ID。当 state 为 `present` 时是必需的。此属性无法更新。
name 字符串 / 必需	必须给监听器的名称。此属性无法更新。
protocol 字符串	监听器的协议。例如，protocol 可以是 `HTTP`、`HTTPS`、`TCP`、`TERMINATED_HTTPS`、`UDP`、`SCTP` 或 `PROMETHEUS`。此属性无法更新。默认值： `"HTTP"`
protocol_port 整数	监听器的协议端口号。此属性无法更新。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选择 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不会写入日志
sni_container_refs 列表 / 元素=字符串	指向包含 TLS 密钥的密钥管理器服务密钥容器的 URI 列表。
state 字符串	资源应该是存在还是不存在。选择 `"present"` ← (默认) `"absent"`
timeout 整数	Ansible 应该等待请求的资源多长时间。默认值： `180`
timeout_client_data 整数	客户端不活动超时时间，以毫秒为单位。
timeout_member_data 整数	成员不活动超时时间，以毫秒为单位。
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 listener, wait for the loadbalancer to be active
  openstack.cloud.lb_listener:
    cloud: mycloud
    load_balancer: test-loadbalancer
    name: test-listener
    protocol: HTTP
    protocol_port: 8080
    state: present

- name: Delete a listener
  openstack.cloud.lb_listener:
    cloud: mycloud
    load_balancer: test-loadbalancer
    name: test-listener
    state: absent

- name: Create a listener, increase timeouts for connection persistence
  openstack.cloud.lb_listener:
    cloud: mycloud
    load_balancer: test-loadbalancer
    name: test-listener
    protocol: TCP
    protocol_port: 22
    state: present
    timeout_client_data: 1800000
    timeout_member_data: 1800000

返回值 

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

键	描述
listener 字典	描述侦听器的字典。返回：当 state 为 `present` 时成功。
allowed_cidrs 列表 / 元素=字符串	IPv4 或 IPv6 CIDR 的列表。返回：成功
alpn_protocols 列表 / 元素=字符串	ALPN 协议的列表。返回：成功
connection_limit 字符串	此负载均衡器允许的最大连接数。返回：成功
created_at 字符串	创建侦听器的时间戳。返回：成功
default_pool 字符串	请求将被路由到的默认池。返回：成功
default_pool_id 字符串	默认池的 ID。必须与侦听器具有兼容的协议。返回：成功
default_tls_container_ref 字符串	对 TLS 密钥容器的引用。返回：成功
description 字符串	侦听器的描述。返回：成功示例： `"description"`
id 字符串	唯一的 UUID。返回：成功示例： `"39007a7e-ee4f-4d13-8283-b4da2e037c69"`
insert_headers 字典	将其他标头插入 HTTP 标头的字典。返回：成功
is_admin_state_up 布尔值	侦听器的管理状态。返回：成功示例： `true`
l7_policies 列表 / 元素=字符串	L7 策略对象的列表。返回：成功
load_balancer_id 字符串	此侦听器所属的负载均衡器的 UUID。返回：成功示例： `"b32eef7e-d2a6-4ea4-a301-60a873f89b3b"`
load_balancers 列表 / 元素=字符串	负载均衡器 ID 的列表。返回：成功示例： `[{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}]`
name 字符串	赋予侦听器的名称。返回：成功示例： `"test"`
operating_status 字符串	侦听器的运行状态。返回：成功示例： `"ONLINE"`
project_id 字符串	拥有此资源的项目的 ID。返回：成功
protocol 字符串	监听器的协议。返回：成功示例： `"HTTP"`
protocol_port 整数	监听器的协议端口号。返回：成功示例： `80`
provisioning_status 字符串	侦听器的配置状态。返回：成功示例： `"ACTIVE"`
sni_container_refs 列表 / 元素=字符串	对 TLS 密钥的引用列表。返回：成功
tags 列表 / 元素=字符串	关联标签的列表。返回：成功
timeout_client_data 整数	客户端不活动超时时间，以毫秒为单位。返回：成功示例： `50000`
timeout_member_connect 整数	后端成员连接超时时间，以毫秒为单位。返回：成功
timeout_member_data 整数	成员不活动超时时间，以毫秒为单位。返回：成功示例： `50000`
timeout_tcp_inspect 整数	等待其他 TCP 数据包进行内容检查的时间，以毫秒为单位。返回：成功
tls_ciphers 字符串	以 OpenSSL 格式存储密码字符串。返回：成功
tls_versions 列表 / 元素=字符串	侦听器要使用的 TLS 协议列表。返回：成功
updated_at 字符串	侦听器上次更新的时间戳。返回：成功

作者

OpenStack Ansible SIG