ngine_io.vultr.vultr_dns_domain – Управляет DNS-доменами на Vultr.
Примечание
Этот плагин является частью коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в плейбуке укажите: ngine_io.vultr.vultr_dns_domain.
Введено в версии 0.1.0: of 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 сложный | успех | Ответ от 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 сложный | успех | Ответ от Vultr API | |
| date_created строка | успех | Дата создания DNS-домена. Пример: 2017-08-26 12:47:48 | |
| name строка | успех | Имя DNS-домена. Пример: example.com | |
Авторы
- René Moser (@resmo)
© 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_module.html
