Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-ClusteredScheduledTask

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

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

Get-ClusteredScheduledTask

Gets clustered scheduled tasks for a failover cluster.

Syntax

Parameter Set: Get0
Get-ClusteredScheduledTask [[-TaskName] <String> ] [[-Cluster] <String> ] [[-TaskType] <ClusterTaskTypeEnum> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-ClusteredScheduledTask cmdlet gets the clustered scheduled tasks registered on a failover cluster. You can specify task name or task type.

For more information about the Windows Server® 2012 Task Scheduler, see the Task Scheduler Overview topic in the TechNet Library at http://technet.microsoft.com/en-us/library/cc721871.aspx.

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

-Cluster<String>

Specifies the name of a failover cluster. If you do not specify a cluster, the cmdlet uses the current node cluster name.


Aliases

none

Required?

false

Position?

2

Default Value

"."

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskName<String>

Specifies a name of a scheduled task.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskType<ClusterTaskTypeEnum>

Specifies a type for the task. The acceptable values for this parameter are: 

-- ResourceSpecific. Resource specific cluster nodes
-- AnyNode. Active cluster nodes.
-- ClusterWide. All cluster nodes.


Aliases

none

Required?

false

Position?

3

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.

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.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_ClusteredScheduledTask[]

Examples

Example 1: Get scheduled tasks

This command gets the task named Task14 on the cluster named Cluster73.


PS C:\> Get-ClusteredScheduledTask -TaskName "Task14" -Cluster "Cluster73" 

Related topics

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