Export (0) Print
Expand All
Expand Minimize

New-FsrmScheduledTask

Windows Server 2012 R2 and Windows 8.1

Updated: January 7, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

New-FsrmScheduledTask

Creates a scheduled task object.

Syntax

Parameter Set: CreateScheduledTask0
New-FsrmScheduledTask [-Time] <DateTime> [-AsJob] [-CimSession <CimSession[]> ] [-Monthly <Int32[]> ] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Weekly <FsrmScheduledTaskDaysEnum[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The New-FsrmScheduledTask cmdlet creates a scheduled task object that defines scheduling for reports, classification, and file management jobs.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Monthly<Int32[]>

Specifies an array of days on which to run the task. Specify a value of -1 to run the task on the last day of the month. If you specify this parameter, do not specify the Weekly parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RunDuration<Int32>

Specifies the number of hours that the server runs the task before canceling it. The value 0 indicates that the server runs the task to completion.


Aliases

none

Required?

false

Position?

named

Default Value

0

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Time<DateTime>

Specifies a date and time value, in standard Coordinated Universal Time (UTC) format, to run the task.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Weekly<FsrmScheduledTaskDaysEnum[]>

Specifies an array of weekdays on which to run the task. If you specify this parameter, do not specify the Monthly parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create a weekly scheduled task

The first command gets a DateTime object and stores it in the variable $d.

The second command returns a FsrmScheduledTask object that defines a schedule that runs the task at midnight every day, Monday through Friday.


PS C:\> $d = get-date "12:00am"
PS C:\> New-FsrmScheduledTask -Time $d -Weekly @(Monday, Tuesday, Wednesday, Thursday, Friday)

Example 2: Create a monthly scheduled task

The first command gets a DateTime object and stores it in the variable $d.

This second command returns a FsrmScheduledTask object that describes a schedule that runs the task at midnight on the 15th and the last day of every month. The RunDuration parameter specifies that the server terminates the process after 4 hours if the process has not ended.


PS C:\> $d = get-date "12:00am"
PS C:\> New-FsrmScheduledTask -Time $d -Monthly @(-1,15) -RunDuration 4

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft