digital_ocean_snapshot_info – Сбор информации о снимках DigitalOcean
Новое в версии 2.6.
Обзор
- Этот модуль может использоваться для сбора информации о снимках на основе предоставленных значений, таких как идентификатор виртуальной машины, тома и снимка.
- Этот модуль назывался
digital_ocean_snapshot_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: digital_ocean_snapshot_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 - |
| Указывает тип информации о снимке, который нужно получить. Если задано droplet, то собирается информация о снимках, основанных только на виртуальных машинах.Если задано volume, то собирается информация о снимках, основанных только на томах.Если задано by_id, то собирается информация о снимках, основанных только на идентификаторе снимка.Если не задано ни одно из вышеперечисленных значений, то собирается информация обо всех снимках. |
| timeout целое число | Значение по умолчанию: 30 | Таймаут в секундах, используемый для опроса API DigitalOcean. |
| validate_certs булево |
| Если задано no, сертификаты SSL не будут проверены.Это нужно задавать только для no используемых на сайтах с собственными сертификатами. |
Примеры
- name: Gather information about all snapshots
digital_ocean_snapshot_info:
snapshot_type: all
oauth_token: "{{ oauth_token }}"
- name: Gather information about droplet snapshots
digital_ocean_snapshot_info:
snapshot_type: droplet
oauth_token: "{{ oauth_token }}"
- name: Gather information about volume snapshots
digital_ocean_snapshot_info:
snapshot_type: volume
oauth_token: "{{ oauth_token }}"
- name: Gather information about snapshot by snapshot id
digital_ocean_snapshot_info:
snapshot_type: by_id
snapshot_id: 123123123
oauth_token: "{{ oauth_token }}"
- name: Get information about snapshot named big-data-snapshot1
digital_ocean_snapshot_info:
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.9/modules/digital_ocean_snapshot_info_module.html