Spec-Zone.ru › Ansible 2.8

digital_ocean_snapshot_facts – Сбор данных о снимках DigitalOcean

Новое в версии 2.6.

  • Описание
  • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Требования

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

  • 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 не будут проверяться.
Это следует делать только в no на сайтах, контролируемых лично, использующих самозаверенные сертификаты.

Примеры

- name: Gather facts about all snapshots
  digital_ocean_snapshot_facts:
    snapshot_type: all
    oauth_token: "{{ oauth_token }}"

- name: Gather facts about droplet snapshots
  digital_ocean_snapshot_facts:
    snapshot_type: droplet
    oauth_token: "{{ oauth_token }}"

- name: Gather facts about volume snapshots
  digital_ocean_snapshot_facts:
    snapshot_type: volume
    oauth_token: "{{ oauth_token }}"

- name: Gather facts about snapshot by snapshot id
  digital_ocean_snapshot_facts:
    snapshot_type: by_id
    snapshot_id: 123123123
    oauth_token: "{{ oauth_token }}"

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

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

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

Ключ Возвращаемое значение Описание
data
список
успех
Данные о снимках DigitalOcean

Пример:
[{'id': '4f60fc64-85d1-11e6-a004-000f53315871', 'name': 'big-data-snapshot1', 'regions': ['nyc1'], 'created_at': '2016-09-28T23:14:30Z', 'resource_id': '89bcc42f-85cf-11e6-a004-000f53315871', 'resource_type': 'volume', 'min_disk_size': 10, 'size_gigabytes': 0}]


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Abhijeet Kasurde (@Akasurde)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/digital_ocean_snapshot_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API