hetzner.hcloud.placement_group 模块 – 在 Hetzner Cloud 上创建和管理放置组。

注意

此模块是 hetzner.hcloud 集合 (版本 4.2.2) 的一部分。

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

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

要在剧本中使用它，请指定：hetzner.hcloud.placement_group。

概要 

在 Hetzner Cloud 上创建、更新和管理放置组。

别名：hcloud_placement_group

需求 

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

python-dateutil >= 2.7.5
requests >=2.20

参数 

参数	注释
api_endpoint 别名：endpoint 字符串	Hetzner Cloud 的 API 端点。您也可以使用 `HCLOUD_ENDPOINT` 环境变量设置此选项。默认值： `"https://api.hetzner.cloud/v1"`
api_token 字符串 / 必需	Hetzner Cloud 的 API 令牌。您也可以使用 `HCLOUD_TOKEN` 环境变量设置此选项。
id 整数	要管理的 Hetzner Cloud 放置组的 ID。如果没有给出放置组名称，则仅需此项
labels 字典	用户定义的标签（键值对）
name 字符串	要管理的 Hetzner Cloud 放置组的名称。如果没有给出放置组 id，或者放置组不存在，则仅需此项。
state 字符串	放置组的状态。选项 `"absent"` `"present"` ← (默认)
type 字符串	Hetzner Cloud 放置组的类型。

另请参见 

另请参见

Hetzner Cloud API 文档: Hetzner Cloud API 的完整参考。

示例 

- name: Create a basic placement group
  hetzner.hcloud.placement_group:
    name: my-placement-group
    state: present
    type: spread

- name: Create a placement group with labels
  hetzner.hcloud.placement_group:
    name: my-placement-group
    type: spread
    labels:
      key: value
      mylabel: 123
    state: present

- name: Ensure the placement group is absent (remove if needed)
  hetzner.hcloud.placement_group:
    name: my-placement-group
    state: absent

返回值 

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

键	描述
hcloud_placement_group 复杂类型	放置组实例返回：始终
id 整数	放置组的数字标识符返回：始终示例： `1937415`
labels 字典	用户定义的标签（键值对）返回：始终
name 字符串	放置组的名称返回：始终示例： `"my placement group"`
servers 列表 / 元素=整数	放置组的服务器 ID 返回：始终示例： `[4711, 4712]`
type 字符串	放置组的类型返回：始终示例： `"spread"`

作者

Adrian Huber (@Adi146)