Spec-Zone.ru › Ansible

Модуль 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 (без завершающей косой черты).

Резервная переменная среды VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / обязательный

Ключ API Vultr.

Резервная переменная среды VULTR_API_KEY.

api_results_per_page

integer

добавлено в vultr.cloud 1.14.0

При получении большого числа ресурсов укажите, сколько результатов должно возвращаться при каждом обращении к API.

Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам.

Максимальное значение для API Vultr — 500.

Резервная переменная среды VULTR_API_RESULTS_PER_PAGE.

По умолчанию: 100

api_retries

integer

Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out.

Резервная переменная среды VULTR_API_RETRIES.

По умолчанию: 5

api_retry_max_delay

integer

Задержка между повторными попытками увеличивается экспоненциально до этого максимального значения в секундах.

Резервная переменная среды VULTR_API_RETRY_MAX_DELAY.

По умолчанию: 12

api_timeout

integer

Тайм-аут HTTP-запросов к API Vultr.

Резервная переменная среды VULTR_API_TIMEOUT.

По умолчанию: 180

validate_certs

boolean

Проверять SSL-сертификаты API Vultr.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • См. также документацию 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

Пример: "https://api.vultr.com/v2"

api_results_per_page

integer

Количество результатов, возвращаемых при каждом обращении к API.

Возвращается: success

Пример: 100

api_retries

integer

Максимальное количество повторных попыток для запросов к API.

Возвращается: success

Пример: 5

api_retry_max_delay

integer

Максимальная задержка между повторными попытками в секундах при экспоненциальном увеличении интервала.

Возвращается: success

Пример: 12

api_timeout

integer

Тайм-аут, используемый для запросов к API.

Возвращается: success

Пример: 60

vultr_vpc_info

list / elements=string

Ответ API Vultr в виде списка.

Возвращается: success

date_created

string

Дата создания VPC.

Возвращается: success

Пример: "2020-10-10T01:56:20+00:00"

description

string

Описание VPC.

Возвращается: success

Пример: "myvpc"

id

string

Идентификатор VPC.

Возвращается: success

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

region

string

Регион, в котором развернута VPC.

Возвращается: success

Пример: "ewr"

v4_subnet

string

Сетевой адрес IPv4

Возвращается: success

Пример: "192.168.42.0"

v4_subnet_mask

integer

Сетевая маска IPv4

Возвращается: success

Пример: 24

Авторы

  • René Moser (@resmo)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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

Spec-Zone.ru

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