Documentation updates

This commit is contained in:
Michael Perzel 2015-09-08 14:36:11 -05:00
parent 64416ff094
commit 685c935a37

View file

@ -30,6 +30,10 @@ options:
description: description:
- Name of the scheduled task - Name of the scheduled task
required: true required: true
description:
description:
- The description for the scheduled task
required: false
enabled: enabled:
description: description:
- Enable/disable the task - Enable/disable the task
@ -40,16 +44,26 @@ options:
state: state:
description: description:
- State that the task should become - State that the task should become
required: true
choices: choices:
- present - present
- absent - absent
user:
description:
- User to run scheduled task as
required: false
execute: execute:
description: description:
- Command the scheduled task should execute - Command the scheduled task should execute
required: false required: false
argument:
description:
- Arguments to provide scheduled task action
required: false
frequency: frequency:
description: description:
- The frequency of the command - The frequency of the command
required: false
choices: choices:
- daily - daily
- weekly - weekly
@ -57,7 +71,7 @@ options:
description: description:
- Time to execute scheduled task - Time to execute scheduled task
required: false required: false
daysOfWeek: days_of_week:
description: description:
- Days of the week to run a weekly task - Days of the week to run a weekly task
required: false required: false
@ -69,5 +83,5 @@ options:
EXAMPLES = ''' EXAMPLES = '''
# Create a scheduled task to open a command prompt # Create a scheduled task to open a command prompt
win_scheduled_task: name="TaskName" execute="cmd" frequency="daily" time="9am" description="open command prompt" path="example" enable=yes state=present win_scheduled_task: name="TaskName" execute="cmd" frequency="daily" time="9am" description="open command prompt" path="example" enable=yes state=present user=SYSTEM
''' '''