community.windows.win_scheduled_task_stat – Get information about Windows Scheduled Tasks¶
Note
This plugin is part of the community.windows collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.windows
.
To use it in a playbook, specify: community.windows.win_scheduled_task_stat
.
Synopsis¶
Will return whether the folder and task exists.
Returns the names of tasks in the folder specified.
Use community.windows.win_scheduled_task to configure a scheduled task.
Parameters¶
See Also¶
See also
- community.windows.win_scheduled_task
The official documentation on the community.windows.win_scheduled_task module.
Examples¶
- name: Get information about a folder
community.windows.win_scheduled_task_stat:
path: \folder name
register: task_folder_stat
- name: Get information about a task in the root folder
community.windows.win_scheduled_task_stat:
name: task name
register: task_stat
- name: Get information about a task in a custom folder
community.windows.win_scheduled_task_stat:
path: \folder name
name: task name
register: task_stat
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Jordan Borean (@jborean93)