digital_ocean_block_storage – Создание/удаление или подключение/отключение томов Block Storage в DigitalOcean
Описание
- Создание/удаление тома Block Storage в DigitalOcean или подключение/отключение тома Block Storage к дроплету.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| block_size - | Размер тома Block Storage в гигабайтах. Требуется при command=create и state=present. Если указан snapshot_id, этот параметр будет проигнорирован. | |
| command - / обязательно |
| Операция, которую нужно выполнить. |
| description - | Описание тома Block Storage. | |
| droplet_id - | ID дроплету, с которым нужно работать. Требуется при command=attach. | |
| oauth_token строка | Токен DigitalOcean OAuth. Существуют и другие переменные окружения, которые можно использовать для предоставления этого значения. Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN' псевдонимы: api_token | |
| region - / обязательно | Идентификатор региона, где должен располагаться ваш том Block Storage. Если указан snapshot_id, этот параметр будет проигнорирован. | |
| snapshot_id - добавлено в 2.5 | Идентификатор снимка, который необходимо использовать для создания тома Block Storage. При включении, region и block_size будут проигнорированы и установлены в значение null. | |
| state - / обязательно |
| Указывает желаемое состояние объекта. |
| timeout целое число | По умолчанию: 30 | Время ожидания в секундах для опроса API DigitalOcean. |
| validate_certs логическое значение |
| Если установлено в no, сертификаты SSL не будут проверены.Это нужно устанавливать только в no случаях на сайтах с самоподписанными сертификатами, которыми вы полностью управляете. |
| volume_name - / обязательно | Имя тома Block Storage. |
Примечания
Примечание
- Можно использовать две переменные окружения: DO_API_KEY и DO_API_TOKEN. Обе они относятся к токену v2.
- Если используется snapshot_id, region и block_size будут проигнорированы и установлены в значение null.
Примеры
# Create new Block Storage
- digital_ocean_block_storage:
state: present
command: create
api_token: <TOKEN>
region: nyc1
block_size: 10
volume_name: nyc1-block-storage
# Delete Block Storage
- digital_ocean_block_storage:
state: absent
command: create
api_token: <TOKEN>
region: nyc1
volume_name: nyc1-block-storage
# Attach Block Storage to a Droplet
- digital_ocean_block_storage:
state: present
command: attach
api_token: <TOKEN>
volume_name: nyc1-block-storage
region: nyc1
droplet_id: <ID>
# Detach Block Storage from a Droplet
- digital_ocean_block_storage:
state: absent
command: attach
api_token: <TOKEN>
volume_name: nyc1-block-storage
region: nyc1
droplet_id: <ID>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | изменено | Уникальный идентификатор тома Block Storage, возвращаемый при создании. Пример: 69b25d9a-494c-12e6-a5af-001f53126b44 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Harnek Sidhu (@harneksidhu)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/digital_ocean_block_storage_module.html
