ansible.builtin.async_status – Получение статуса асинхронной задачи

Примечание

Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев, вы можете использовать короткое имя модуля async_status даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя (FQCN) для лёгкой ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь то же имя модуля.

Новое в версии 0.5: из ansible.builtin

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Этот модуль получает статус асинхронной задачи.
Этот модуль также поддерживается для целевых платформ Windows.

Примечание

У этого модуля есть соответствующий плагин действия.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
jid строка / обязательно		Идентификатор задания или задачи
mode строка	Варианты: cleanup status ←	Если `status`, получить статус. Если `cleanup`, очистить кэш асинхронной задачи (по умолчанию в `~/.ansible_async/`) для указанного задания jid.

Примечания

Примечание

Этот модуль также поддерживается для целевых платформ Windows.

См. также

Асинхронные действия и опрос: Подробная информация о том, как использовать асинхронные действия и опрос.

Примеры

---
- name: Asynchronous yum task
  yum:
    name: docker-io
    state: present
  async: 1000
  poll: 0
  register: yum_sleeper

- name: Wait for asynchronous job to end
  async_status:
    jid: '{{ yum_sleeper.ansible_job_id }}'
  register: job_result
  until: job_result.finished
  retries: 100
  delay: 10

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

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

Ключ	Возвращаемое значение	Описание
ansible_job_id строка	success	Идентификатор асинхронной задачи Пример: 360874038559.4169
finished целое число	success	Завершено ли асинхронное задание (`1`) или нет (`0`) Пример: 1
started целое число	success	Начато ли асинхронное задание (`1`) или нет (`0`) Пример: 1

Авторы

Команда разработчиков Ansible
Michael DeHaan

© 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/ansible/builtin/async_status_module.html