community.digitalocean.digital_ocean_snapshot_facts – Сбор информации о снимках DigitalOcean
Примечание
Этот плагин входит в коллекцию community.digitalocean (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.digitalocean.
Чтобы использовать его в плейбуке, укажите: community.digitalocean.digital_ocean_snapshot_facts.
Обзор
- Этот модуль может быть использован для сбора информации о снимках на основе предоставленных значений, таких как идентификаторы виртуальных машин, томов и снимков.
- Этот модуль назывался
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 строка |
| Указывает тип информации о снимках, которую необходимо получить. Если установлено значение droplet, то собирается информация о снимках, основанная только на виртуальных машинах.Если установлено значение volume, то собирается информация о снимках, основанная только на томах.Если установлено значение by_id, то собирается информация о снимках, основанная только на идентификаторе снимка.Если не установлено ни одно из вышеперечисленных значений, то собирается информация обо всех снимках. |
| timeout целое число | Значение по умолчанию: 30 | Таймаут в секундах, используемый для опроса API DigitalOcean. |
| validate_certs булево |
| Если установлено значение no, сертификаты SSL не будут проверены.Это значение должно быть установлено в no только для сайтов, управляемых вами лично, которые используют самоподписанные сертификаты. |
Примеры
- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_snapshot_facts_module.html
