cloudscale_ch.cloud.volume – Управляет томами на службе cloudscale.ch IaaS.

Примечание

Этот плагин входит в состав коллекции cloudscale_ch.cloud (версия 2.0.0).

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

Для использования в playbook укажите: cloudscale_ch.cloud.volume.

Добавлено в версии 1.0.0: of cloudscale_ch.cloud

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание, подключение/отключение, обновление и удаление томов на службе cloudscale.ch IaaS.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число	По умолчанию: 30	Время ожидания в секундах для вызовов API cloudscale.ch.
api_token строка / обязательно		Токен API cloudscale.ch. Также может быть передан в переменной среды `CLOUDSCALE_API_TOKEN`.
api_url строка добавлено в 1.3.0 of cloudscale_ch.cloud	По умолчанию: "https://api.cloudscale.ch/v1"	URL API cloudscale.ch. Также может быть передан в переменной среды `CLOUDSCALE_API_URL`.
name строка		Имя тома. Для изменения существующего тома необходимо указать либо имя, либо UUID.
server_uuids список / элементы=строка		UUID серверов, к которым подключен этот том. Установите значение `[]` для отключения тома. В настоящее время том может быть подключен только к одному серверу. псевдонимы: server_uuid
size_gb целое число		Размер тома в ГБ.
state строка	Варианты: present ← absent	Состояние тома.
tags словарь		Теги, связанные с томом. Установите значение `{}` для очистки всех тегов.
type строка	Варианты: ssd bulk	Тип тома. Не может быть изменён после создания тома. По умолчанию `ssd` при создании тома.
uuid строка		UUID тома. Для изменения существующего тома необходимо указать либо имя, либо UUID.
zone строка		Зона, в которой находится том (например, `lgp1` или `rma1`). Не может быть изменена после создания тома. По умолчанию используется зона по умолчанию для проекта.

Примечания

Примечание

Для создания нового тома необходимы как минимум параметры name и size_gb.
Том может быть создан и подключен к серверу в рамках одной задачи.
Все операции выполняются с использованием публичного API v1 cloudscale.ch.
Для получения подробной информации обратитесь к полной документации API: https://www.cloudscale.ch/en/api/v1.
Для всех операций требуется действительный токен API. Вы можете создать сколько угодно токенов с помощью панели управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

# Create a new SSD volume
- name: Create an SSD volume
  cloudscale_ch.cloud.volume:
    name: my_ssd_volume
    zone: 'lpg1'
    size_gb: 50
    api_token: xxxxxx
  register: my_ssd_volume

# Attach an existing volume to a server
- name: Attach volume to server
  cloudscale_ch.cloud.volume:
    uuid: my_ssd_volume.uuid
    server_uuids:
      - ea3b39a3-77a8-4d0b-881d-0bb00a1e7f48
    api_token: xxxxxx

# Create and attach a volume to a server
- name: Create and attach volume to server
  cloudscale_ch.cloud.volume:
    name: my_ssd_volume
    zone: 'lpg1'
    size_gb: 50
    server_uuids:
      - ea3b39a3-77a8-4d0b-881d-0bb00a1e7f48
    api_token: xxxxxx

# Detach volume from server
- name: Detach volume from server
  cloudscale_ch.cloud.volume:
    uuid: my_ssd_volume.uuid
    server_uuids: []
    api_token: xxxxxx

# Delete a volume
- name: Delete volume
  cloudscale_ch.cloud.volume:
    name: my_ssd_volume
    state: absent
    api_token: xxxxxx

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
href строка	state == present	URL API для получения подробной информации об этом томе. Пример: https://api.cloudscale.ch/v1/volumes/2db69ba3-1864-4608-853a-0771b6885a3a
name строка	state == present	Отображаемое имя тома. Пример: my_ssd_volume
server_uuids список / элементы=строка	state == present	UUID серверов, к которым подключен этот том. Пример: ['47cec963-fcd2-482f-bdb6-24461b2d47b1']
size_gb строка	state == present	Размер тома в ГБ. Пример: 50
state строка	успех	Текущее состояние тома. Пример: present
tags словарь	state == present	Теги, связанные с томом. Пример: {'project': 'my project'}
type строка	state == present	Тип тома. Пример: bulk
uuid строка	state == present	Уникальный идентификатор тома. Пример: 2db69ba3-1864-4608-853a-0771b6885a3a
zone словарь	state == present	Зона тома. Пример: {'slug': 'lpg1'}

Авторы

Gaudenz Steinlin (@gaudenz)
René Moser (@resmo)
Denis Krienbühl (@href)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cloudscale_ch/cloud/volume_module.html