community.general.memset_dns_reload – Запрос перезагрузки инфраструктуры DNS Memset
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general
Чтобы использовать его в книге задач, укажите: community.general.memset_dns_reload
Описание
- Запрос перезагрузки инфраструктуры DNS Memset и, необязательно, ожидание завершения процесса.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка / обязательно | Ключ API, полученный из панели управления Memset. | |
| poll булево |
| Булево значение. Если установлено, будет происходить мониторинг состояния задачи перезагрузки и функция вернёт результат, когда задача завершится (если в первую очередь не истечёт таймаут в 30 секунд). Если таймаут истечёт, задача не будет отмечена как проваленная, но в stderr будет указано, что мониторинг не удался. |
Примечания
Примечание
- Запросы перезагрузки DNS — это услуги наилучших усилий, предоставляемые Memset. Они обычно выполняются каждые 15 минут по умолчанию, однако вы можете запросить немедленную перезагрузку, если последующие задачи зависят от создания записей. Требуется ключ API, сгенерированный в панели управления клиентом Memset, с минимальным объемом доступа — dns.reload. Если вы хотите отследить состояние задачи для ожидания завершения перезагрузки, вам также потребуется job.status.
Примеры
- name: Submit DNS reload and poll
community.general.memset_dns_reload:
api_key: 5eb86c9196ab03919abcf03857163741
poll: True
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращено | Описание | |
|---|---|---|---|
| memset_api сложное | всегда | Необработанный ответ с API Memset. | |
| error булево | всегда | Указывает, завершилась ли задача ошибкой. Пример: True | |
| finished булево | всегда | Указывает, завершилась ли задача до возврата результата. Пример: True | |
| id строка | всегда | Идентификатор задачи. Пример: c9cc8ad2a3e3fb8c63ed83c424928ef8 | |
| status строка | всегда | Статус задачи. Пример: DONE | |
| type строка | всегда | Тип задачи. Пример: dns | |
Авторы
- Simon Weald (@glitchcrab)
© 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/community/general/memset_dns_reload_module.html