Модуль community.digitalocean.digital_ocean_snapshot — Создание и удаление снимков DigitalOcean

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: community.digitalocean.digital_ocean_snapshot.

Новая в community.digitalocean 1.7.0

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

Описание

Этот модуль можно использовать для создания и удаления снимков виртуальных машин DigitalOcean и томов.

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. Значение по умолчанию: `"https://api.digitalocean.com/v2"`
droplet_id строка	ID виртуальной машины (Droplet) для создания снимка.
oauth_token алиасы: api_token строка	Токен DigitalOcean OAuth. Существует несколько других переменных окружения, которые можно использовать для предоставления этого значения. Например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
snapshot_id строка	ID снимка для удаления.
snapshot_name строка	Имя снимка для создания.
snapshot_tags список / элементы=строка	Список тегов, которые нужно применить к снимку тома. Применимо только к снимкам томов (а не виртуальных машин). Значение по умолчанию: `[]`
snapshot_type строка	Определяет тип информации снимка для создания или удаления. Если установлено `droplet`, то создается снимок виртуальной машины. Если установлено `volume`, то создается снимок тома. Варианты: `"droplet"` ← (значение по умолчанию) `"volume"`
state строка	Указывает, должен ли снимок существовать (создан) или отсутствовать (удален). Варианты: `"present"` ← (значение по умолчанию) `"absent"`
timeout целое число	Время ожидания в секундах для опроса API DigitalOcean. Значение по умолчанию: `30`
validate_certs логическое значение	Если установлено `no`, сертификаты SSL не будут проверены. Это следует устанавливать только для `no` при использовании на сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (значение по умолчанию)
volume_id строка	ID тома для создания снимка.
wait логическое значение	Ожидать создания снимка перед возвратом. Варианты: `false` `true` ← (значение по умолчанию)
wait_timeout целое число	Время ожидания в секундах, прежде чем ожидание завершится при создании снимка. Значение по умолчанию: `120`

Примеры

- name: Snapshot a Droplet
  community.digitalocean.digital_ocean_snapshot:
    state: present
    snapshot_type: droplet
    droplet_id: 250329179
  register: result

- name: Delete a Droplet snapshot
  community.digitalocean.digital_ocean_snapshot:
    state: absent
    snapshot_type: droplet
    snapshot_id: 85905825
  register: result

- name: Snapshot a Volume
  community.digitalocean.digital_ocean_snapshot:
    state: present
    snapshot_type: volume
    snapshot_name: mysnapshot1
    volume_id: 9db5e329-cc68-11eb-b027-0a58ac144f91

- name: Delete a Volume snapshot
  community.digitalocean.digital_ocean_snapshot:
    state: absent
    snapshot_type: volume
    snapshot_id: a902cdba-cc68-11eb-a701-0a58ac145708

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

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

Ключ	Описание
data словарь	Действие создания или удаления снимка. Возвращаемое значение: успех Пример: [{"completed_at": "2021-06-14T12:36:00Z", "id": 1229119156, "region": {"available": true, "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "name": "New York 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-1gb-amd", "s-1vcpu-1gb-intel", "<snip>"], "slug": "nyc1"}, "region_slug": "nyc1", "resource_id": 250445117, "resource_type": "droplet", "started_at": "2021-06-14T12:35:25Z", "status": "completed", "type": "snapshot"}, {"created_at": "2021-06-14T12:55:10Z", "id": "c06d4a86-cd0f-11eb-b13c-0a58ac145472", "min_disk_size": 1, "name": "my-snapshot-1", "regions": ["nbg1"], "resource_id": "f0adea7e-cd0d-11eb-b027-0a58ac144f91", "resource_type": "volume", "size_gigabytes": 0, "tags": ["tag1", "tag2"]}]

Ключ

Описание

data

словарь

Действие создания или удаления снимка.

Возвращаемое значение: успех

Пример: [{"completed_at": "2021-06-14T12:36:00Z", "id": 1229119156, "region": {"available": true, "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "name": "New York 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-1gb-amd", "s-1vcpu-1gb-intel", "<snip>"], "slug": "nyc1"}, "region_slug": "nyc1", "resource_id": 250445117, "resource_type": "droplet", "started_at": "2021-06-14T12:35:25Z", "status": "completed", "type": "snapshot"}, {"created_at": "2021-06-14T12:55:10Z", "id": "c06d4a86-cd0f-11eb-b13c-0a58ac145472", "min_disk_size": 1, "name": "my-snapshot-1", "regions": ["nbg1"], "resource_id": "f0adea7e-cd0d-11eb-b027-0a58ac144f91", "resource_type": "volume", "size_gigabytes": 0, "tags": ["tag1", "tag2"]}]

Авторы

Марк Меркадо (@mamercad)

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

© 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_snapshot_module.html