Spec-Zone.ru › Ansible 2.9

vultr_network_info – Сбор информации о доступных сетях Vultr

Новое в версии 2.9.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

  • Сбор информации о доступных сетях в Vultr.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_account
строка
По умолчанию:
"default"
Имя раздела ini в файле vultr.ini.
Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если определена.
api_endpoint
строка
URL конечной точки API (без заключительного слеша).
Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию – https://api.vultr.com, если не указано.
api_key
строка
Ключ API Vultr API.
Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если определена.
api_retries
целое число
Количество попыток повторного выполнения запросов в случае, если Vultr API возвращает код HTTP 503.
Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если определена.
Значение по умолчанию – 5 попыток, если не указано.
api_retry_max_delay
целое число
добавлен в 2.9
Задержка экспоненциального отката при повторных попытках в секундах, до максимального значения.
Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.
Значение по умолчанию – 12 секунд.
api_timeout
целое число
Таймаут HTTP запросов к Vultr API.
Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию – 60 секунд, если не указано.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Проверка SSL-сертификатов Vultr API.

Примечания

Примечание

  • См. также документацию API на https://www.vultr.com/api/.

Примеры

- name: Gather Vultr networks information
  local_action:
    module: vultr_network_info
  register: result

- name: Print the gathered information
  debug:
    var: result.vultr_network_info

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

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

Ключ Возвращаемое значение Описание
vultr_api
сложное
успех
Ответ от Vultr API с некоторыми дополнениями/изменениями

api_account
строка
успех
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default
api_endpoint
строка
успех
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_retries
целое число
успех
Максимальное количество повторных попыток запросов к API

Пример:
5
api_retry_max_delay
целое число
добавлен в 2.9
успех
Задержка экспоненциального отката при повторных попытках в секундах, до максимального значения.

Пример:
12
api_timeout
целое число
успех
Таймаут, используемый для запросов API

Пример:
60
vultr_network_info
сложное
успех
Ответ от Vultr API

Пример:
{'vultr_network_info': [{'date_created': '2018-08-02 11:18:49', 'id': 'net5b62e8991adfg', 'name': 'mynet', 'region': 'Amsterdam', 'v4_subnet': '192.168.42.0', 'v4_subnet_mask': 24}]}


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Yanis Guenane (@Spredzy)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_network_info_module.html

Spec-Zone.ru

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