Модуль community.digitalocean.digital_ocean_volume_info — Сбор информации о томах DigitalOcean

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.digitalocean. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.digitalocean.digital_ocean_volume_info.

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

Обзор

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

Псевдонимы: digital_ocean_volume_facts

Требования

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

python >= 2.6

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. По умолчанию: `"https://api.digitalocean.com/v2"`
oauth_token псевдонимы: api_token строка	Токен DigitalOcean OAuth. Существуют и другие переменные окружения, которые могут быть использованы для предоставления этого значения. Например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
region_name строка	Имя региона для ограничения результатов томами, доступными в определенном регионе. Для получения допустимых значений, связанных с регионами, используйте community.digitalocean.digital_ocean_region_info.
timeout целое число	Таймаут в секундах, используемый для опроса API DigitalOcean. По умолчанию: `30`
validate_certs логическое	Если установлено в значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в значение `no`, используемое на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Gather information about all volume
  community.digitalocean.digital_ocean_volume_info:
    oauth_token: "{{ oauth_token }}"

- name: Gather information about volume in given region
  community.digitalocean.digital_ocean_volume_info:
    region_name: nyc1
    oauth_token: "{{ oauth_token }}"

- name: Get information about volume named nyc3-test-volume
  community.digitalocean.digital_ocean_volume_info:
  register: resp_out
- set_fact:
    volume_id: "{{ item.id }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?name=='nyc3-test-volume']"
- debug: var=volume_id

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

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

Ключ	Описание
data список / элементы=строка	Информация о томе DigitalOcean Возвращается: успех Пример: [{"created_at": "2016-03-02T17:00:49Z", "description": "Block store for examples", "droplet_ids": [], "id": "506f78a4-e098-11e5-ad9f-000f53306ae1", "name": "example", "region": {"available": true, "features": ["private_networking", "backups", "ipv6", "metadata"], "name": "New York 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "slug": "nyc1"}, "size_gigabytes": 10}]

Ключ

Описание

data

список / элементы=строка

Информация о томе DigitalOcean

Возвращается: успех

Пример: [{"created_at": "2016-03-02T17:00:49Z", "description": "Block store for examples", "droplet_ids": [], "id": "506f78a4-e098-11e5-ad9f-000f53306ae1", "name": "example", "region": {"available": true, "features": ["private_networking", "backups", "ipv6", "metadata"], "name": "New York 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "slug": "nyc1"}, "size_gigabytes": 10}]

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/digitalocean/digital_ocean_volume_info_module.html