Модуль vultr.cloud.vpc_info — сбор информации о VPC Vultr
Примечание
Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vultr.cloud.
Чтобы использовать её в плейбуке, укажите: vultr.cloud.vpc_info.
Добавлено в vultr.cloud 1.0.0
Краткое описание
- Собирает информацию о доступных VPC.
Параметры
Параметр | Комментарии |
|---|---|
api_endpoint string | URL конечной точки API (без завершающей косой черты). Резервная переменная среды По умолчанию: |
api_key string / обязательный | Ключ API Vultr. Резервная переменная среды |
api_results_per_page integer добавлено в vultr.cloud 1.14.0 | При получении большого числа ресурсов укажите, сколько результатов должно возвращаться при каждом обращении к API. Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для API Vultr — 500. Резервная переменная среды По умолчанию: |
api_retries integer | Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная среды По умолчанию: |
api_retry_max_delay integer | Задержка между повторными попытками увеличивается экспоненциально до этого максимального значения в секундах. Резервная переменная среды По умолчанию: |
api_timeout integer | Тайм-аут HTTP-запросов к API Vultr. Резервная переменная среды По умолчанию: |
validate_certs boolean | Проверять SSL-сертификаты API Vultr. Варианты:
|
Примечания
Примечание
- См. также документацию API: https://www.vultr.com/api/.
Примеры
- name: Gather Vultr VPCs information
vultr.cloud.vpc_info:
register: result
- name: Print the gathered information
ansible.builtin.debug:
var: result.vultr_vpc_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
vultr_api dictionary | Ответ API Vultr с некоторыми дополнениями и изменениями. Возвращается: success |
|
api_endpoint string |
Конечная точка, используемая для запросов к API. Возвращается: success Пример: |
|
api_results_per_page integer |
Количество результатов, возвращаемых при каждом обращении к API. Возвращается: success Пример: |
|
api_retries integer |
Максимальное количество повторных попыток для запросов к API. Возвращается: success Пример: |
|
api_retry_max_delay integer |
Максимальная задержка между повторными попытками в секундах при экспоненциальном увеличении интервала. Возвращается: success Пример: |
|
api_timeout integer |
Тайм-аут, используемый для запросов к API. Возвращается: success Пример: |
vultr_vpc_info list / elements=string | Ответ API Vultr в виде списка. Возвращается: success |
|
date_created string |
Дата создания VPC. Возвращается: success Пример: |
|
description string |
Описание VPC. Возвращается: success Пример: |
|
id string |
Идентификатор VPC. Возвращается: success Пример: |
|
region string |
Регион, в котором развернута VPC. Возвращается: success Пример: |
|
v4_subnet string |
Сетевой адрес IPv4 Возвращается: success Пример: |
|
v4_subnet_mask integer |
Сетевая маска IPv4 Возвращается: success Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vultr/cloud/vpc_info_module.html