Модуль theforeman.foreman.wait_for_task – Ожидание завершения задачи

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

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

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: theforeman.foreman.wait_for_task.

Новая функция в theforeman.foreman 3.13.0

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

Обзор

Ожидание завершения задачи

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.

requests

Параметры

Параметр	Комментарии
password строка / обязательно	Пароль пользователя, который получает доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL-адрес сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
task строка / обязательно	Идентификатор задачи, для которой ожидается завершение.
timeout целое число	Время, в течение которого должна завершиться задача. По умолчанию: `60`
username строка / обязательно	Имя пользователя, получающий доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs булево	Требовать проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Возможность работы в режиме check_mode и возврата прогнозируемого статуса изменения без модификации сущности
diff_mode	Поддержка: полная	Возвращает подробную информацию о том, что изменилось (или возможно, требует изменения в режиме check_mode), когда в режиме diff

Примеры

- name: Wait for a task to finish
  theforeman.foreman.wait_for_task:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    task: a03ba49f-4dc2-4ad6-a48b-b271b46f3347
    timeout: 60

- name: Sarch for previously created tasks
  resource_info:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    resource: foreman_tasks
    search: "(label = Actions::Katello::Product::Destroy and action ~ 'Test Product' and state = running)"
  register: tasks

- name: Wait for all found tasks to finish
  wait_for_task:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    task: "{{ item }}"
    timeout: 900
  loop: "{{ tasks.resources | map(attribute='id') | list }}"

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

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

Ключ	Описание
task словарь	Завершенная задача Возвращается: success

Авторы

Julien Godin (@JGodin-C2C)

Ссылки на коллекцию

© 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/theforeman/foreman/wait_for_task_module.html