Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: vultr.cloud.vpc2_info.

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

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

Описание

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

Параметры

Параметр

Комментарии

api_endpoint

строка

URL конечной точки API (без конечной косой черты).

Альтернативная переменная окружения VULTR_API_ENDPOINT.

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

api_key

строка / обязательно

API ключ Vultr API.

Альтернативная переменная окружения VULTR_API_KEY.

api_retries

целое число

Количество попыток при возвращении HTTP-кода ошибки Vultr API, таких как - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Gateway Time-out

Альтернативная переменная окружения 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 2.0 information
  vultr.cloud.vpc2_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_vpc2_info
END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ

Описание

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_vpc2_info

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

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

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

date_created

строка

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

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

Пример: "2023-08-20T19:39:20+00:00"

description

строка

Описание VPC.

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

Пример: "my vpc"

id

строка

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

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

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

ip_block

строка

Подсеть VPC.

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

Пример: "10.99.1.0"

prefix_length

целое число

Количество битов для маски сети в нотации CIDR.

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

Пример: 24

region

строка

Регион, в котором находится VPC.

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

Пример: "ewr"

Авторы

  • 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/vpc2_info_module.html

Spec-Zone.ru

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