Модуль hetzner.hcloud.placement_group – Создание и управление группами размещения в Hetzner Cloud.

Примечание

Этот модуль является частью коллекции hetzner.hcloud (версия 3.1.1).

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	API-точка входа для Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. Значение по умолчанию: `"https://api.hetzner.cloud/v1"`
api_token строка / обязательный	API-токен для Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
id целое число	Идентификатор группы размещения Hetzner Cloud для управления. Требуется только если не задано имя группы размещения.
labels словарь	Пользовательские метки (парные ключ-значение).
name строка	Имя группы размещения Hetzner Cloud для управления. Требуется только если не задан идентификатор группы размещения или группы размещения не существует.
state строка	Состояние группы размещения. Доступные значения: `"absent"` `"present"` ← (по умолчанию)
type строка	Тип группы размещения Hetzner Cloud.

См. также

Документация API Hetzner Cloud: Полное описание API Hetzner Cloud.

Примеры

- 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 список / элементы=целое число	Идентификаторы серверов в группе размещения Возвращается: всегда Пример: `[4711, 4712]`
type строка	Тип группы размещения Возвращается: всегда Пример: `"spread"`

Авторы

Adrian Huber (@Adi146)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/placement_group_module.html