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

Примечание

Этот модуль входит в коллекцию cloudscale_ch.cloud (версия 2.4.0).

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

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

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

В cloudscale_ch.cloud с версии 1.0.0

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

Описание

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

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

Параметры

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

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

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

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

Ключ	Описание
href строка	URL API для получения подробной информации об этом томе. Возвращается: state == present Пример: `"https://api.cloudscale.ch/v1/volumes/2db69ba3-1864-4608-853a-0771b6885a3a"`
name строка	Отображаемое имя тома. Возвращается: state == present Пример: `"my_ssd_volume"`
server_uuids список / элементы=строка	UUID серверов, к которым прикреплён этот том. Это значение возврата устарело и будет удалено в будущем, когда поле будет удалено из API. Возвращается: state == present Пример: `["47cec963-fcd2-482f-bdb6-24461b2d47b1"]`
servers список / элементы=строка	Список серверов, к которым прикреплён этот том. Возвращается: state == present Пример: `[{"href": "https://api.cloudscale.ch/v1/servers/47cec963-fcd2-482f-bdb6-24461b2d47b1", "name": "my_server", "uuid": "47cec963-fcd2-482f-bdb6-24461b2d47b1"}]`
size_gb строка	Размер тома в ГБ. Возвращается: state == present Пример: `"50"`
state строка	Текущее состояние тома. Возвращается: success Пример: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cloudscale_ch/cloud/volume_module.html