mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 06:10:22 -07:00
Update win_scheduled_task.py (#46720)
* Update win_scheduled_task.py to document that the duration of a task trigger can be null, which will cause it to run indefinitely - docs update makes use of suboptions * Add a fix for the validate-modules schema
This commit is contained in:
parent
fd97c8e56c
commit
0bc5b799a6
2 changed files with 18 additions and 5 deletions
|
@ -186,9 +186,22 @@ options:
|
|||
- Allows you to define the repetition action of the trigger that defines how often the task is run and how long the repetition pattern is repeated
|
||||
after the task is started.
|
||||
- It takes in the following keys, C(duration), C(interval), C(stop_at_duration_end)
|
||||
- C(duration) is how long the pattern is repeated and is written in the ISO 8601 Duration format C(P[n]Y[n]M[n]DT[n]H[n]M[n]S).
|
||||
- C(interval) is the amount of time between earch restart of the task and is written in the ISO 8601 Duration format C(P[n]Y[n]M[n]DT[n]H[n]M[n]S).
|
||||
- C(stop_at_duration_end) is a boolean value that indicates if a running instance of the task is stopped at the end of the repetition pattern.
|
||||
suboptions:
|
||||
duration:
|
||||
description:
|
||||
- Defines how long the pattern is repeated.
|
||||
- The value is in the ISO 8601 Duration format C(P[n]Y[n]M[n]DT[n]H[n]M[n]S).
|
||||
- By default this is not set which means it will repeat indefinitely.
|
||||
type: str
|
||||
interval:
|
||||
description:
|
||||
- The amount of time between each restart of the task.
|
||||
- The value is written in the ISO 8601 Duration format C(P[n]Y[n]M[n]DT[n]H[n]M[n]S).
|
||||
type: str
|
||||
stop_at_duration_end:
|
||||
description:
|
||||
- Whether a running instance of the task is stopped at the end of the repetition pattern.
|
||||
type: bool
|
||||
version_added: '2.5'
|
||||
|
||||
# Principal options
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue