Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.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

string

URL конечной точки API (без завершающей косой черты).

Резервная переменная окружения VULTR_API_ENDPOINT.

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

api_key

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

Ключ API Vultr API.

Резервная переменная окружения VULTR_API_KEY.

api_results_per_page

integer

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

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

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

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

Резервная переменная окружения VULTR_API_RESULTS_PER_PAGE.

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

api_retries

integer

Количество повторных попыток в случае, если Vultr API возвращает код ошибки 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-запроса к Vultr API.

Резервная переменная окружения VULTR_API_TIMEOUT.

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

validate_certs

boolean

Проверять 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

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

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

Ключ

Описание

vultr_api

dictionary

Ответ Vultr API с небольшими дополнениями и изменениями.

Возвращается: 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_vpc2_info

list / elements=string

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

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

date_created

string

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

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

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

description

string

Описание VPC.

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

Пример: "my vpc"

id

string

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

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

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

ip_block

string

Подсеть VPC.

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

Пример: "10.99.1.0"

prefix_length

integer

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

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

Пример: 24

region

string

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

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

Пример: "ewr"

Авторы

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

Spec-Zone.ru

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