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

Примечание

Этот плагин входит в состав коллекции hetzner.hcloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install hetzner.hcloud.

Для использования в playbook, укажите: hetzner.hcloud.hcloud_volume.

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

Обзор

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

Требования

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

hcloud-python >= 1.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_token строка / обязательно		Это токен API для Hetzner Cloud.
automount булево	Варианты: нет ← да	Автоматически подключить том.
delete_protection булево	Варианты: нет да	Защитить том от удаления.
endpoint строка	По умолчанию: "https://api.hetzner.cloud/v1"	Это конечная точка API для Hetzner Cloud.
format строка	Варианты: xfs ext4	Автоматически отформатировать том при создании Может использоваться только в случае, если том не существует.
id целое число		ID блочного тома Hetzner Cloud для управления. Требуется только если не задано имя тома.
labels словарь		Пользовательские пары ключ-значение.
location строка		Местоположение тома Hetzner Cloud. Требуется, если не задан сервер и том не существует.
name строка		Имя блочного тома Hetzner Cloud для управления. Требуется только если не задан ID тома или том не существует.
server строка		Имя сервера, к которому должен быть прикреплен том. Требуется, если не задано местоположение и том не существует.
size целое число		Размер блочного тома в ГБ. Требуется, если том еще не существует.
state строка	Варианты: отсутствует наличие ←	Состояние тома.

См. также

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

Примеры

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

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

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

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

Авторы

Christopher Schmitt (@cschmitt-hcloud)

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