openstack.cloud.host_aggregate 模块 – 管理 OpenStack 主机聚合

注意

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

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

要安装它,请使用:ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:openstack.cloud.host_aggregate

概要

  • 创建、更新或删除 OpenStack 主机聚合。如果已存在具有提供名称的聚合,则将使用新名称、新可用区域、新元数据和新主机列表进行更新。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

auth

字典

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

auth_type

字符串

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

availability_zone

字符串

要将聚合创建到的可用区域。

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 的一个部分一样。

hosts

列表 / 元素=字符串

要为聚合设置的主机列表。

interface

别名:endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

metadata

字典

元数据字典。

name

字符串 / 必需

聚合的名称。

purge_hosts

布尔值

是否应从聚合中删除不在 *hosts* 中的主机

选项

  • false

  • true ← (默认)

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

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

默认值: 180

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 配置文件,然后来自标准环境变量,最后来自 plays 中的显式参数。有关更多信息,请访问 https://docs.openstack.org/openstacksdk/

示例

# Create a host aggregate
- openstack.cloud.host_aggregate:
    cloud: mycloud
    state: present
    name: db_aggregate
    hosts:
      - host1
      - host2
    metadata:
      type: dbcluster

# Add an additional host to the aggregate
- openstack.cloud.host_aggregate:
    cloud: mycloud
    state: present
    name: db_aggregate
    hosts:
      - host3
    purge_hosts: false
    metadata:
      type: dbcluster

# Delete an aggregate
- openstack.cloud.host_aggregate:
    cloud: mycloud
    state: absent
    name: db_aggregate

返回值

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

描述

aggregate

字典

主机聚合资源。

返回:成功时,当 *state* 为 present 时

availability_zone

字符串

聚合的可用区域

返回:始终

created_at

字符串

创建资源时的日期和时间

返回:始终

deleted_at

字符串

删除资源时的日期和时间

除非is_deleted为 true,否则为 Null

返回:始终

hosts

字符串

属于聚合的主机

返回:始终

ID

字符串

聚合的 UUID。

返回:始终

is_deleted

布尔值

资源是否已删除

返回:始终

metadata

字符串

附加到聚合的元数据

返回:始终

name

字符串

聚合的名称

返回:始终

updated_at

字符串

资源更新的日期和时间

返回:始终

uuid

字符串

聚合的 UUID

返回:始终

作者

  • OpenStack Ansible SIG