File: started.yml

package info (click to toggle)
ansible-core 2.19.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 32,960 kB
  • sloc: python: 181,477; cs: 4,929; sh: 4,697; xml: 34; makefile: 21
file content (21 lines) | stat: -rw-r--r-- 690 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: started
  author: Ansible Core
  version_added: "1.9"
  short_description: Was async task started
  description:
    - Used to check if an async task has started, will also work with non async tasks but will issue a warning.
    - This test checks for the existence of a C(started) key in the input dictionary and that it is V(1) if present
  options:
    _input:
      description: registered result from an Ansible task
      type: dictionary
      required: True
EXAMPLES: |
  # test 'status' to know how to respond
  {{ (asynctaskpoll is started}}

RETURN:
  _value:
    description: Returns V(True) if the task has started, V(False) otherwise.
    type: boolean