community.digitalocean.digital_ocean_block_storage – Создание/удаление или подключение/отключение блочных хранилищ в DigitalOcean
Примечание
Этот плагин входит в коллекцию community.digitalocean (версия 1.0.0).
Для установки используйте: ansible-galaxy collection install community.digitalocean.
Для использования в книге задач укажите: community.digitalocean.digital_ocean_block_storage.
Описание
- Создание/удаление блочного хранилища в DigitalOcean или подключение/отключение блочного хранилища к дроплету.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| block_size целое число | Размер блочного хранилища в гигабайтах. Требуется при command=create и state=present. Если указан snapshot_id, этот параметр будет проигнорирован. | |
| command строка / обязательно |
| Какой операцию выполнить. |
| description строка | Описание блочного хранилища. | |
| droplet_id целое число | Идентификатор дроплету, над которым будет выполняться операция. Требуется при command=attach. | |
| oauth_token строка | Токен DigitalOcean OAuth. Существуют и другие переменные среды, которые можно использовать для предоставления этого значения. Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN' псевдонимы: api_token | |
| region строка | Идентификатор региона, где должно располагаться блочное хранилище. Если указан snapshot_id, этот параметр будет проигнорирован. | |
| snapshot_id строка | Идентификатор моментального снимка, с которым будет создаваться блочное хранилище. Если указан, region и block_size будут проигнорированы и изменены на null. | |
| state строка / обязательно |
| Указывает желаемое состояние целевого объекта. |
| timeout целое число | По умолчанию: 30 | Таймаут в секундах для опроса API DigitalOcean. |
| validate_certs логическое |
| Если установлено в no, сертификаты SSL не будут проверены.Это нужно только при работе с лично контролируемыми сайтами, использующими самозаверяющие сертификаты. |
| volume_name строка / обязательно | Имя блочного хранилища. |
Примечания
Примечание
- Можно использовать две переменные среды: DO_API_KEY и DO_API_TOKEN. Обе они ссылаются на токен v2.
- Если используется snapshot_id, region и block_size будут проигнорированы и изменены на null.
Примеры
- name: Create new Block Storage
community.digitalocean.digital_ocean_block_storage:
state: present
command: create
api_token: <TOKEN>
region: nyc1
block_size: 10
volume_name: nyc1-block-storage
- name: Delete Block Storage
community.digitalocean.digital_ocean_block_storage:
state: absent
command: create
api_token: <TOKEN>
region: nyc1
volume_name: nyc1-block-storage
- name: Attach Block Storage to a Droplet
community.digitalocean.digital_ocean_block_storage:
state: present
command: attach
api_token: <TOKEN>
volume_name: nyc1-block-storage
region: nyc1
droplet_id: <ID>
- name: Detach Block Storage from a Droplet
community.digitalocean.digital_ocean_block_storage:
state: absent
command: attach
api_token: <TOKEN>
volume_name: nyc1-block-storage
region: nyc1
droplet_id: <ID>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | changed | Уникальный идентификатор блочного хранилища, возвращенный при создании. Пример: 69b25d9a-494c-12e6-a5af-001f53126b44 |
Авторы
- 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.10/collections/community/digitalocean/digital_ocean_block_storage_module.html
