Модуль hetzner.hcloud.volume – Создание и управление блочным томом на Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля требуются дополнительные зависимости, подробнее см. Требования.

Для использования в книге задач укажите: hetzner.hcloud.volume.

Описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и подключение/отключение блочного тома на Hetzner Cloud.

Псевдонимы: hcloud_volume

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

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`.
automount булево	Автоматически монтировать том. Доступные значения: `false` ← (по умолчанию) `true`
delete_protection булево	Защита тома от удаления. Доступные значения: `false` `true`
format строка	Автоматически форматировать том при создании Может использоваться только в случае, если том ещё не существует. Доступные значения: `"xfs"` `"ext4"`
id целое число	Идентификатор блочного тома Hetzner Cloud для управления. Требуется только в том случае, если не указано имя тома.
labels словарь	Пользовательские пары ключ-значение.
location строка	Местоположение тома Hetzner Cloud. Требуется, если не указан сервер и том не существует.
name строка	Имя блочного тома Hetzner Cloud для управления. Требуется только в том случае, если не указан идентификатор или том не существует.
server строка	Имя сервера, к которому должен быть прикреплен том. Требуется, если не указано местоположение и том не существует.
size целое число	Размер блочного тома в ГБ. Требуется, если том ещё не существует.
state строка	Состояние тома. Доступные значения: `"absent"` `"present"` ← (по умолчанию)

См. также

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

Примеры

- name: Create a Volume
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn1
    size: 100
    state: present
- name: Create a Volume and format it with ext4
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn
    format: ext4
    size: 100
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Ensure the Volume is absent (remove if needed)
  hetzner.hcloud.volume:
    name: my-volume
    state: absent

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
hcloud_volume сложный	Том блочного устройства Возвращается: Всегда
delete_protection булево добавлено в hetzner.hcloud 0.1.0	Истина, если том защищен от удаления Возвращается: всегда Пример: `false`
id целое	ID тома Возвращается: Всегда Пример: `12345`
labels словарь	Пользовательские метки (пары ключ-значение) Возвращается: Всегда Пример: `{"key": "value", "mylabel": 123}`
linux_device строка добавлено в hetzner.hcloud 0.1.0	Путь к устройству, содержащему том. Возвращается: всегда Пример: `"/dev/disk/by-id/scsi-0HC_Volume_12345"`
location строка	Название расположения, где находится том Возвращается: Всегда Пример: `"fsn1"`
name строка	Имя тома Возвращается: Всегда Пример: `"my-volume"`
server строка	Имя сервера, к которому подключен том Возвращается: Всегда Пример: `"my-server"`
size целое	Размер тома в ГБ Возвращается: Всегда Пример: `1337`

Авторы

Christopher Schmitt (@cschmitt-hcloud)

Ссылки на сборку

© 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/volume_module.html