Модуль vultr.cloud.vpc_info – Сбор информации о VPC Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.0).

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

Для установки используйте: ansible-galaxy collection install vultr.cloud.

Для использования в playbook укажите: vultr.cloud.vpc_info.

Новая функция в vultr.cloud 1.0.0

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

Описание

Сбор информации о доступных VPC.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без конечного слэша). Значение по умолчанию из переменной среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Значение по умолчанию из переменной среды `VULTR_API_KEY`.
api_retries целое число	Количество попыток при ошибках Vultr API, таких как: - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза Значение по умолчанию из переменной среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Максимальная задержка повторной попытки в секундах, экспоненциально возрастающая. Значение по умолчанию из переменной среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP запроса к Vultr API. Значение по умолчанию из переменной среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs булево	Проверка SSL сертификатов Vultr API. Варианты: `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 словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успех
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: успех Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Количество максимальных попыток повтора запросов API. Возвращено: успех Пример: `5`
api_retry_max_delay целое число	Задержка экспоненциального возвратного отката в секундах между повторными попытками до этого максимального значения задержки. Возвращено: успех Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успех Пример: `60`
vultr_vpc_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращено: успех
date_created строка	Дата создания VPC. Возвращено: успех Пример: `"2020-10-10T01:56:20+00:00"`
description строка	Описание VPC. Возвращено: успех Пример: `"myvpc"`
id строка	ID VPC. Возвращено: успех Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
region строка	Регион, в котором была развернута VPC. Возвращено: успех Пример: `"ewr"`
v4_subnet строка	Адрес сети IPv4 Возвращено: успех Пример: `"192.168.42.0"`
v4_subnet_mask целое число	Маска сети IPv4 Возвращено: успех Пример: `24`

Авторы

René Moser (@resmo)

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

© 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/vultr/cloud/vpc_info_module.html