theforeman.foreman.wait_for_task module – Wait for a task

Note

This module is part of the theforeman.foreman collection (version 5.7.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.wait_for_task.

New in theforeman.foreman 3.13.0

Synopsis 

Wait for a task to finish

Requirements 

The below requirements are needed on the host that executes this module.

requests

Parameters 

Parameter	Comments
ca_path path	PEM formatted file that contains a CA certificate to be used for validation. If the value is not specified in the task, the value of environment variable `FOREMAN_CA_PATH` will be used instead.
password string	Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_PASSWORD` will be used instead.
server_url string / required	URL of the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_SERVER_URL` will be used instead.
task string / required	Task id to wait for.
timeout integer	How much time the task should take to be finished Default: `60`
use_gssapi boolean	Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library requests-gssapi to be installed. If the value is not specified in the task, the value of environment variable `FOREMAN_USE_GSSAPI` will be used instead. Choices: `false` ← (default) `true`
username string	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_USERNAME` will be used instead.
validate_certs boolean	Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable `FOREMAN_VALIDATE_CERTS` will be used instead. Choices: `false` `true` ← (default)

Attributes 

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples 

- 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 }}"

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
task dictionary	The finished task Returned: success

Authors

Julien Godin (@JGodin-C2C)

theforeman.foreman.wait_for_task module – Wait for a task

Synopsis

Requirements

Parameters

Attributes

Examples

Return Values