Spec-Zone.ru › Ansible 2.6

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
bool
    Варианты:
  • 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 }}"
  with_items: "{{ 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. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/digital_ocean_snapshot_facts_module.html

Spec-Zone.ru

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