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

Примечание

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

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

Примечания

Примечание

Для создания нового тома необходимо указать как минимум параметры name и size_gb.
Том можно создать и подключить к серверу в рамках одной задачи.
Все операции выполняются с использованием публичного API cloudscale.ch версии 1.
Подробную информацию см. в полной документации 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

# Revert a volume to the most recent snapshot
- name: Revert volume to snapshot
  cloudscale_ch.cloud.volume:
    uuid: "{{ my_ssd_volume.uuid }}"
    revert: "e504dc99-ff01-4e89-ad89-7df080f97b4b"
    api_token: xxxxxx

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

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

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

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

Авторы

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

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

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