Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Export-ScheduledTask

Updated: October 30, 2012

Applies To: Windows Server 2012

Export-ScheduledTask

Exports a scheduled task as an XML string.

Syntax

Parameter Set: Name
Export-ScheduledTask [[-TaskName] <String> ] [[-TaskPath] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Object
Export-ScheduledTask [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Export-ScheduledTask cmdlet exports the definition of a scheduled task into an XML string.

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

-InputObject<CimInstance>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-TaskName<String>

Specifies the name of a scheduled task to export.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskPath<String>

Specifies the path for a scheduled task in Task Scheduler namespace. You can use \ for the root folder. If you do not specify a path, the cmdlet uses the root folder.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

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

<CommonParameters>

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

Outputs

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

  • String

Examples

Example 1: Export a scheduled task into an XML string.

This command exports the UpdateDrivers scheduled task in the \UpdateTasks\ folder into an XML string. The command lists the XML string as its output.


PS C:\> Export-ScheduledTask –TaskName "UpdateDrivers" –TaskPath "\UpdateTasks\" 

Example 2: Export all scheduled task definitions that are in the UpdateTasks folder.

This command uses the Get-Scheduledtask cmdlet to get all scheduled tasks in the \UpdateTasks\ folder. The command pipes this information to the Export-ScheduledTasks cmdlet, which exports the definitions of these scheduled tasks. The command lists the XML string of each task as its output.


PS C:\> Get-ScheduledTask -TaskPath "\UpdateTasks\" | Export-ScheduledTask

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.