cloudscale_ch.cloud.volume – Управляет томами на службе IaaS cloudscale.ch.
Примечание
Этот плагин является частью коллекции cloudscale_ch.cloud (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cloudscale_ch.cloud
Для использования в книге задач укажите: cloudscale_ch.cloud.volume
Новое в версии 1.0.0: cloudscale_ch.cloud
Обзор
- Создание, подключение/отключение, обновление и удаление томов на службе IaaS cloudscale.ch.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Значение по умолчанию: 30 | Время ожидания в секундах для вызовов API cloudscale.ch. |
| api_token строка / обязательно | Токен API cloudscale.ch. Его также можно передать в переменной среды CLOUDSCALE_API_TOKEN | |
| api_url строка добавлен в версии 1.3.0 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 строка |
| Состояние тома. |
| tags словарь | Теги, связанные с томом. Установите значение {}, чтобы очистить все теги. | |
| type строка |
| Тип тома. Не может быть изменён после создания тома. По умолчанию ssd при создании тома. |
| uuid строка | UUID тома. Для изменения существующего тома необходимо указать либо имя, либо UUID. | |
| zone строка | Зона, в которой находится том (например, lgp1 или rma1). Не может быть изменена после создания тома. По умолчанию используется зона по умолчанию проекта. |
Примечания
Примечание
- Для создания нового тома требуются как минимум параметры name и size_gb.
- В рамках одной задачи можно создать том и подключить его к серверу.
- Все операции выполняются с использованием публичного API v1 cloudscale.ch.
- Полная документация API доступна по адресу: https://www.cloudscale.ch/ru/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': 'мой проект'} |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cloudscale_ch/cloud/volume_module.html