Documentation on the timeout keyword

pull/83152/head
Niko Mlynarčik 1 month ago
parent 87bead3dcf
commit ed516728f4

@ -1921,7 +1921,11 @@ TASK_TIMEOUT:
name: Task Timeout
default: 0
description:
- Set the maximum time (in seconds) that a task can run for.
- Set the maximum time (in seconds) for a task to execute in.
- Timeout runs independently from templating or looping.
It applies per each attempt and remains unchanged by the total time spent on a task.
- When the task execution exceeds the timeout, Ansible interrupts the process.
This is registered as a failure due to outside circumstances, not a task failure, to receive appropriate response and recovery process.
- If set to 0 (the default) there is no timeout.
env: [{name: ANSIBLE_TASK_TIMEOUT}]
ini:

@ -61,7 +61,7 @@ serial: Explicitly define how Ansible batches the execution of the current play
strategy: Allows you to choose the strategy plugin to use for the play. See :ref:`strategy_plugins`.
tags: Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
tasks: Main list of tasks to execute in the play, they run after :term:`roles` and before :term:`post_tasks`.
timeout: Time limit for the task to execute in, if exceeded Ansible will interrupt and fail the task.
timeout: Time limit for the task to execute in, if exceeded, Ansible will interrupt the process. Timeout does not affect templating or looping.
throttle: Limit the number of concurrent task runs on task, block and playbook level. This is independent of the forks and serial settings, but cannot be set higher than those limits. For example, if forks is set to 10 and the throttle is set to 15, at most 10 hosts will be operated on in parallel.
until: "This keyword implies a ':term:`retries` loop' that will go on until the condition supplied here is met or we hit the :term:`retries` limit."
vars: Dictionary/map of variables

Loading…
Cancel
Save