Add an example for cleaning up the async job cache, and clarify how that works (#81697)

pull/81707/head
Sloane Hertel 10 months ago committed by GitHub
parent 6f65397871
commit 81c83c623c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -24,7 +24,7 @@ options:
mode: mode:
description: description:
- If V(status), obtain the status. - If V(status), obtain the status.
- If V(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job O(jid). - If V(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job O(jid), without waiting for it to finish.
type: str type: str
choices: [ cleanup, status ] choices: [ cleanup, status ]
default: status default: status
@ -70,6 +70,11 @@ EXAMPLES = r'''
until: job_result.finished until: job_result.finished
retries: 100 retries: 100
delay: 10 delay: 10
- name: Clean up async file
ansible.builtin.async_status:
jid: '{{ yum_sleeper.ansible_job_id }}'
mode: cleanup
''' '''
RETURN = r''' RETURN = r'''

Loading…
Cancel
Save