Edit

Share via

Get-ClusteredScheduledTask

  • Reference
Module:
ScheduledTasks

Gets clustered scheduled tasks for a failover cluster.

Syntax

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

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.

Examples

Example 1: Get scheduled tasks

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

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

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Cluster

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

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskName

Specifies a name of a scheduled task.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskType

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.
Type:ClusterTaskTypeEnum
Accepted values:ResourceSpecific, AnyNode, ClusterWide
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance[]