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

Примечание

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

Добавлен в версии 0.5: of 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 строка	успех	Идентификатор асинхронной задачи Пример: 360874038559.4169
finished целое число	успех	Закончена ли асинхронная задача (`1`) или нет (`0`) Пример: 1
started целое число	успех	Запущена ли асинхронная задача (`1`) или нет (`0`) Пример: 1

Авторы

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

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