Модуль community.digitalocean.digital_ocean_block_storage — Создание/удаление или подключение/отключение томов блочного хранилища в DigitalOcean

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

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

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

Для использования в книге задач укажите: community.digitalocean.digital_ocean_block_storage.

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

Описание

Создание/удаление томов блочного хранилища в DigitalOcean или подключение/отключение тома блочного хранилища к дроплету.

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. По умолчанию: `"https://api.digitalocean.com/v2"`
block_size целое число	Размер тома блочного хранилища в гигабайтах. Требуется при command=create и state=present. Если указан snapshot_id, этот параметр будет проигнорирован. Если block_size больше текущего размера тома, размер тома будет изменён.
command строка / обязательно	Операция, которую нужно выполнить. Доступные значения: `"create"` `"attach"`
description строка	Описание тома блочного хранилища.
droplet_id целое число	ID дроплету, к которому нужно подключиться. Требуется при command=attach.
oauth_token псевдонимы: api_token строка	Токен DigitalOcean OAuth. Доступны и другие переменные окружения для его указания. Например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
project_name псевдонимы: project строка	Проект, которому нужно назначить ресурс (название проекта, а не UUID). По умолчанию используется стандартный проект учётной записи (пустая строка). В данный момент поддерживается только при `command=create`. По умолчанию: `""`
region строка	Код региона, в котором должен находиться том блочного хранилища. Если указан snapshot_id, этот параметр будет проигнорирован.
snapshot_id строка	ID снимка, с которым должен быть создан том блочного хранилища. Если указан, region и block_size будут проигнорированы и изменены на `null`.
state строка / обязательно	Укажите желаемое состояние цели. Доступные значения: `"present"` `"absent"`
timeout целое число	Таймаут в секундах для опроса API DigitalOcean. По умолчанию: `30`
validate_certs логическое значение	Если установлено в `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `no` при работе с сайтами, контролируемыми лично, используя самоподписанные сертификаты. Доступные значения: `false` `true` ← (по умолчанию)
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
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: create
    region: nyc1
    block_size: 10
    volume_name: nyc1-block-storage

- name: Create new Block Storage (and assign to Project "test")
  community.digitalocean.digital_ocean_block_storage:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: create
    region: nyc1
    block_size: 10
    volume_name: nyc1-block-storage
    project_name: test

- name: Resize an existing Block Storage
  community.digitalocean.digital_ocean_block_storage:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: create
    region: nyc1
    block_size: 20
    volume_name: nyc1-block-storage

- name: Delete Block Storage
  community.digitalocean.digital_ocean_block_storage:
    state: absent
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: create
    region: nyc1
    volume_name: nyc1-block-storage

- name: Attach Block Storage to a Droplet
  community.digitalocean.digital_ocean_block_storage:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: attach
    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
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    command: attach
    volume_name: nyc1-block-storage
    region: nyc1
    droplet_id: <ID>

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

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

Ключ	Описание
assign_status строка	Статус назначения (ok, not_found, assigned, already_assigned, service_down) Возвращено: изменённо Пример: `"assigned"`
id строка	Уникальный идентификатор тома Блок-хранилища, возвращённый во время создания. Возвращено: изменённо Пример: `"69b25d9a-494c-12e6-a5af-001f53126b44"`
msg строка	Сообщение об информации или ошибке, возникшее во время выполнения Возвращено: изменённо Пример: `"No project named test2 found"`
resources словарь	Ресурсы, вовлеченные в назначение проекта. Возвращено: изменённо Пример: `{"assigned_at": "2021-10-25T17:39:38Z", "links": {"self": "https://api.digitalocean.com/v2/volumes/8691c49e-35ba-11ec-9406-0a58ac1472b9"}, "status": "assigned", "urn": "do:volume:8691c49e-35ba-11ec-9406-0a58ac1472b9"}`

Авторы

Harnek Sidhu (@harneksidhu)

Ссылки на сборку

© 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/community/digitalocean/digital_ocean_block_storage_module.html