Модуль community.general.memset_dns_reload – Запрос перегрузки инфраструктуры DNS Memset

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: community.general.memset_dns_reload.

Описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Запросить перегрузку инфраструктуры DNS Memset и, необязательно, выполнить опросы, пока процесс не завершится.

Параметры

Параметр	Комментарии
api_key строка / обязательно	Ключ API, полученный из панели управления Memset.
poll логическое значение	Логическое значение; если установлено, будет выполняться опрос состояния задачи перегрузки и возвращаться результат, когда задача завершится (если время ожидания 30 секунд не истечёт раньше). Если время ожидания истечёт, задача не будет помечена как завершённая с ошибкой, но в stderr будет указано, что опрос завершился с ошибкой. Возможные значения: `false` ← (по умолчанию) `true`

Параметр

Комментарии

api_key

строка / обязательно

Ключ API, полученный из панели управления Memset.

poll

логическое значение

Логическое значение; если установлено, будет выполняться опрос состояния задачи перегрузки и возвращаться результат, когда задача завершится (если время ожидания 30 секунд не истечёт раньше). Если время ожидания истечёт, задача не будет помечена как завершённая с ошибкой, но в stderr будет указано, что опрос завершился с ошибкой.

Возможные значения:

false ← (по умолчанию)
true

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогнозируемый результат изменения состояния без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Вернёт подробную информацию о произошедших изменениях (или потенциальных изменениях в `check_mode`) в режиме сравнения.

Примечания

Примечание

Запросы на перегрузку 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/memset_dns_reload_module.html