You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

hetzner.hcloud.hcloud_placement_group module – Create and manage placement groups on the Hetzner Cloud.

Note

This module is part of the hetzner.hcloud collection (version 1.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.hcloud_placement_group.

Synopsis

• Create, update and manage placement groups on the Hetzner Cloud.

Requirements

The below requirements are needed on the host that executes this module.

• hcloud-python >= 1.0.0

• hcloud-python >= 1.15.0

Parameters

Parameter	Comments
api_token string / required	This is the API Token for the Hetzner Cloud. You can also set this option by using the environment variable HCLOUD_TOKEN
endpoint string	This is the API Endpoint for the Hetzner Cloud. Default: "https://api.hetzner.cloud/v1"
id integer	The ID of the Hetzner Cloud placement group to manage. Only required if no placement group name is given
labels dictionary	User-defined labels (key-value pairs)
name string	The Name of the Hetzner Cloud placement group to manage. Only required if no placement group id is given, or a placement group does not exist.
state string	State of the placement group. Choices: "absent" "present" ← (default)
type string	The Type of the Hetzner Cloud placement group.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Create a basic placement group
  hcloud_placement_group:
    name: my-placement-group
    state: present
    type: spread

- name: Create a placement group with labels
  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)
  hcloud_placement_group:
    name: my-placement-group
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
hcloud_placement_group complex	The placement group instance Returned: Always
id integer	Numeric identifier of the placement group Returned: always Sample: 1937415
labels dictionary	User-defined labels (key-value pairs) Returned: always
name string	Name of the placement group Returned: always Sample: "my placement group"
servers list / elements=integer	Server IDs of the placement group Returned: always Sample: [4711, 4712]
type string	Type of the placement group Returned: always Sample: "spread"

Authors

• Adrian Huber (@Adi146)

Collection links

Issue Tracker Repository (Sources)