openstack.cloud.server_group 模块 – 管理 OpenStack 服务器组

注意

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

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

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

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

概要

  • 从 OpenStack 添加或删除服务器组。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

auth

字典

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

auth_type

字符串

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

ca_cert

别名：cacert

字符串

作为验证 SSL API 请求的一部分可以使用的 CA 证书包的路径。

client_cert

别名：cert

字符串

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

client_key

别名：key

字符串

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

cloud

任意

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

interface

别名：endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ← （默认）

name

字符串 / 必需

服务器组名称。

policy

字符串

表示策略的当前名称。

选项

  • "anti-affinity"

  • "affinity"

  • "soft-anti-affinity"

  • "soft-affinity"

region_name

字符串

区域的名称。

rules

字典

要应用于策略的规则。目前，对于 anti-affinity 策略，仅支持 max_server_per_host 规则。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← （默认）

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

指示资源的所需状态。当 state 为 present 时，则 policy 是必需的。

选项

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

示例

- name: Create a server group with 'affinity' policy.
  openstack.cloud.server_group:
    cloud: "{{ cloud }}"
    state: present
    name: my_server_group
    policy: affinity

- name: Delete 'my_server_group' server group.
  openstack.cloud.server_group:
    cloud: "{{ cloud }}"
    state: absent
    name: my_server_group

返回值

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

键

描述

server_group

字典

表示服务器组的对象

返回: 当 state 存在时成功返回

id

字符串

唯一的 UUID。

返回: 总是返回

member_ids

列表 / 元素=字符串

服务器组中成员的列表

返回: 总是返回

metadata

字典

元数据键值对。

返回: 总是返回

name

字符串

服务器组的名称。

返回: 总是返回

policies

列表 / 元素=字符串

与该组关联的策略名称列表，列表中只有一个策略名称。在微版本 2.63 之前可用

返回: 总是返回

policy

字符串

表示策略的名称。从版本 2.64 起可用。

返回: 总是返回

project_id

字符串

拥有该服务器组的项目 ID。

返回: 总是返回

rules

字典

应用于策略的规则字段。目前，对于 anti-affinity 策略，仅支持 max_server_per_host 规则。

返回: 总是返回

user_id

字符串

拥有该服务器组的用户 ID。

返回: 总是返回

作者

  • OpenStack Ansible SIG