Spec-Zone.ru › Ansible 2.10

ngine_io.vultr.vultr_dns_domain_info – Сбор информации о доступных доменных именах DNS Vultr.

Примечание

Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).

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

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

Новый в версии 0.1.0: of ngine_io.vultr

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

Обзор

  • Сбор информации о доступных доменных именах DNS в 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
целое число
Задержка экспоненциального отката при повторной попытке в секундах до максимального значения.
Переменная среды 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 DNS domains information
  ngine_io.vultr.vultr_dns_domains_info:
  register: result

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

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

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

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

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

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

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

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

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

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

date_created
строка
успех
Дата создания доменного имени DNS.

Пример:
2017-08-26 12:47:48
domain
строка
успех
Имя доменного имени DNS.

Пример:
example.com


Авторы

  • 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.10/collections/ngine_io/vultr/vultr_dns_domain_info_module.html

Spec-Zone.ru

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