Модуль community.digitalocean.digital_ocean_snapshot_info – Сбор информации о снимках DigitalOcean

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.digitalocean. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.digitalocean.digital_ocean_snapshot_info.

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

Обзор

Этот модуль может использоваться для сбора информации о снимках на основе предоставленных значений, таких как идентификатор виртуальной машины, тома и снимка.
Этот модуль назывался digital_ocean_snapshot_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: digital_ocean_snapshot_facts

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.6

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. По умолчанию: `"https://api.digitalocean.com/v2"`
oauth_token псевдонимы: api_token строка	Токен DigitalOcean OAuth. Можно использовать несколько переменных окружения для задания этого значения. Например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
snapshot_id строка	Для получения информации о снимке укажите его идентификатор. Если задан фактический идентификатор снимка, то собирается информация только об этом конкретном снимке. Этот параметр обязателен, если `snapshot_type` установлен в значение `by_id`.
snapshot_type строка	Указывает тип информации о снимке, который нужно получить. Если установлено `droplet`, то информация собирается о снимках только на основе виртуальных машин. Если установлено `volume`, то информация собирается о снимках только на основе томов. Если установлено `by_id`, то информация собирается только на основе идентификатора снимка. Если не установлено ни одно из вышеперечисленных значений, то информация собирается обо всех снимках. Доступные значения: `"all"` ← (по умолчанию) `"droplet"` `"volume"` `"by_id"`
timeout целое число	Время ожидания в секундах для опроса API DigitalOcean. По умолчанию: `30`
validate_certs булево	Если установлено в `no`, сертификаты SSL не будут проверены. Это следует установить только в `no` для сайтов, управляемых лично, использующих самозаверяющие сертификаты. Доступные значения: `false` `true` ← (по умолчанию)

Примеры

- name: Gather information about all snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: all
    oauth_token: "{{ oauth_token }}"

- name: Gather information about droplet snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: droplet
    oauth_token: "{{ oauth_token }}"

- name: Gather information about volume snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: volume
    oauth_token: "{{ oauth_token }}"

- name: Gather information about snapshot by snapshot id
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: by_id
    snapshot_id: 123123123
    oauth_token: "{{ oauth_token }}"

- name: Get information about snapshot named big-data-snapshot1
  community.digitalocean.digital_ocean_snapshot_info:
  register: resp_out
- set_fact:
    snapshot_id: "{{ item.id }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?name=='big-data-snapshot1']"
- debug:
    var: snapshot_id

Возвращаемые значения

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

Ключ	Описание
data список / элементы=словарь	Информация о снимках DigitalOcean Возвращается: успех Пример: `[{"created_at": "2016-09-28T23:14:30Z", "id": "4f60fc64-85d1-11e6-a004-000f53315871", "min_disk_size": 10, "name": "big-data-snapshot1", "regions": ["nyc1"], "resource_id": "89bcc42f-85cf-11e6-a004-000f53315871", "resource_type": "volume", "size_gigabytes": 0}]`

Авторы

Abhijeet Kasurde (@Akasurde)

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

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