Skip to Content

Create Schedule Job Run every N months

Schedules a task that runs every N months.

Warning

Note

This workflow is available only for use in Microsoft Windows environments.

 Workflow inputs – Create Schedule Job Run every N months

Call Workflow Input

Description

Required

Default Value

connection details

XML document conforms to Connection Details common object that contains the information required to execute a command via command line.

Yes

n/a

task name

Specifies a name for the task.

 

Valid value: unique name not exceeding 238 characters.

 

Warning

Note

You must use quotation marks to enclose the names that include spaces.

Yes

n/a

task run

Specifies the program or command that the task runs.

 

Warning

Note

The fully qualified path and file name of an executable file, script file, or batch file must be provided. The path name must not exceed 262 characters. If path omitted default path is Systemroot/System32 directory.

Yes

n/a

modifier

The /mo (modifier) parameter, which specifies the number of months between each run of the task, is optional and the default is 1 (every month).

Yes

1

runas user

Runs the task with permissions of the specified user account.

Default value is permissions of the current user of the local computer, or permission of the user specified by /u parameter.

Yes

Permissions of current local user

runas password

Provides the password for the user account that is specified in the /ru [Domain]User parameter.

Yes

n/a

day

Specifies day (or days) of a month.

 

Warning

Note

Valid only with a WEEKLY or MONTHLY schedule.

No

n/a

start time

Specifies the time of day that the task starts (each time it starts) in HH:MM 24–hour format. Default value is current time on local computer.

No

Current time on local computer

end time

Specifies time of day that a minute or hourly task schedule ends in HH:MM 24–hour format.

 

Warning

Note

Valid only with MINUTE or HOURLY schedule.

No

n/a

start date

Specifies the date on which the task schedule starts.

 

Valid date format: mm/dd/yyyy

 

Warning

Note

Format set by selected locale on local computer.

No

Current date on the local computer

end date

Specifies the date on which the schedule ends. This parameter is optional. By default, schedules have no ending date.

 

Warning

Note

Not valid for ONCE, ONSTART, ONLOGON, or ONIDLE schedule.

Format for <end date> varies with the selected locale on local.

No

n/a

 

 Workflow outputs – Create Schedule Job Run every N months

Call Workflow Output

Description

output

XML document consisting of one or more <line> elements that contain the command response. Each <line> element contains an index attribute indicating the order in which the information was returned by the command.

success

Did the operation succeed?

 

Valid values: true, false

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 20.18.01