ngine_io.vultr.vultr_dns_domain – Управляет DNS-доменами на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr
Для использования в playbook, укажите: ngine_io.vultr.vultr_dns_domain
Новое в версии 0.1.0: плагина ngine_io.vultr
Обзор
- Создание и удаление DNS-доменов.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- 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 секунд, если не указано. | |
| name строка / обязательно | Имя домена. псевдонимы: domain | |
| server_ip строка | IP-адрес сервера по умолчанию. Используйте vultr_dns_record для его изменения после создания домена. Требуется, если state=present. | |
| state строка |
| Состояние DNS-домена. |
| validate_certs булево |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- См. также документацию API на https://www.vultr.com/api/.
Примеры
- name: Ensure a domain exists
ngine_io.vultr.vultr_dns_domain:
name: example.com
server_ip: 10.10.10.10
- name: Ensure a domain is absent
ngine_io.vultr.vultr_dns_domain:
name: example.com
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложное | success | Ответ от Vultr API с некоторыми дополнениями/модификациями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Точка входа API для запросов Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток API-запросов Пример: 5 | |
| api_retry_max_delay целое число | success | Экспоненциальная задержка отложенных попыток в секундах между повторами до максимальной задержки. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для API-запросов Пример: 60 | |
| vultr_dns_domain сложное | success | Ответ от Vultr API | |
| date_created строка | success | Дата создания DNS-домена. Пример: 2017-08-26 12:47:48 | |
| name строка | success | Имя DNS-домена. Пример: example.com | |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_dns_domain_module.html