community.digitalocean.digital_ocean_snapshot_info – Сбор информации о снимке DigitalOcean

Примечание

Этот плагин является частью коллекции community.digitalocean (версия 1.0.0).

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

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

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

Обзор

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

Требования

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

python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
oauth_token строка		Токен DigitalOcean OAuth. Существуют и другие переменные окружения, которые могут быть использованы для предоставления этого значения. Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN' псевдонимы: api_token
snapshot_id строка		Для получения информации о снимке укажите его идентификатор. Если задан фактический идентификатор снимка, то собирается информация только об этом конкретном снимке. Это обязательный параметр, если `snapshot_type` установлен на `by_id`.
snapshot_type строка	Варианты: all ← droplet volume by_id	Указывает тип информации о снимке, которую необходимо получить. Если установлено `droplet`, то собирается информация о снимках только на основе дроплетов. Если установлено `volume`, то собирается информация о снимках только на основе томов. Если установлено `by_id`, то собирается информация о снимках только по идентификатору снимка. Если не установлено ни одно из вышеперечисленных значений, то собирается информация обо всех снимках.
timeout целое число	По умолчанию: 30	Время ожидания в секундах, используемое для опроса API DigitalOcean.
validate_certs булево	Варианты: no yes ←	Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует установить только на сайтах, которыми вы управляете и используете самозаверяющие сертификаты.

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/digitalocean/digital_ocean_snapshot_info_module.html