Get-SCOMTask

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-SCOMTask

Gets a list of tasks.

Syntax

Parameter Set: Empty
Get-SCOMTask [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromInstance
Get-SCOMTask [-Instance] <EnterpriseManagementObject> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPack
Get-SCOMTask [-ManagementPack] <ManagementPack> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackClass
Get-SCOMTask [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [-Target <ManagementPackClass> ] [ <CommonParameters>]

Parameter Set: FromTaskDisplayName
Get-SCOMTask [-DisplayName] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromTaskId
Get-SCOMTask [-Id] <Guid> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromTaskName
Get-SCOMTask [-ComputerName <String> ] [-Credential <PSCredential> ] [-Name <String> ] [-SCSession <Connection> ] [ <CommonParameters>]

Detailed Description

The Get-SCOMTask cmdlet gets a list of tasks.

Parameters

-ComputerName<String>

Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name. To specify the local computer, type the computer name, "localhost", or a dot (.).

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. For more information, type Get-Help Get-Credential.

-DisplayName<String>

Specifies the display name of an object. This parameter takes one or more strings and will look for matches in the DisplayName property of the given objects that this cmdlet works with. DisplayName values may vary depending on which localized management packs are imported into the management group and the locale of the user running Windows PowerShell.

-Id<Guid>

Retrieves the task with the specified GUID.

The GUID is stored in the Id property of the object that represents an SCOMTask. To get the GUID of a task, type "Get-SCOMTask | Format-Table DisplayName, Id".

-Instance<EnterpriseManagementObject>

Retrieves tasks for one or more class instance objects. Enter a variable that represents the class instances, or type a command that gets the class instances. This parameter also accepts group objects.

For information about how to get a class instance object, type Get-Help Get-SCOMClassInstance.

-ManagementPack<ManagementPack>

Retrieves tasks for one or more management pack objects. Enter a variable that represents the management packs, or type a command that gets the management packs.

For information about how to get a management pack object, type Get-Help Get-SCOMManagementPack.

-Name<String>

Specifies the name of an object.

This parameter takes one or more strings and will look for matches in the Name property of the given objects that this cmdlet works with.

-SCSession<Connection>

Specifies a connection to a management server. The default is the current management group connection. Specify a Management group connection object, such as one returned by the Get-SCOMManagementGroupConnection cmdlet.

-Target<ManagementPackClass>

Retrieves tasks for one or more specified target class objects. Enter a variable that represents the target classes, or type a command that gets the target classes.

For information about how to get a class object, type Get-Help Get-SCOMClass.

<CommonParameters>

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

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command gets all tasks with "health" in their name.

PS C:\>Get-SCOMTask -Name *health*

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command gets all tasks that have a display name beginning with "Stop".

PS C:\>Get-SCOMTask -DisplayName "Stop*"

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

This command gets all tasks for the management packs with "System Center Core" in their display name. By using the ErrorAction parameter with the SilentlyContinue value, if the command encounters a management pack with no associated tasks, the command will continue to run, and will not display errors.

PS C:\>Get-SCOMManagementPack -DisplayName "System Center Core*" | Get-SCOMTask -ErrorAction SilentlyContinue

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

This command gets all tasks for classes with "health" in their name.

PS C:\>Get-SCOMClass -Name *health* | Get-SCOMTask

-------------------------- EXAMPLE 5 --------------------------

Description

-----------

This command gets all tasks for class instances that have "Contoso.com" in their name.

PS C:\>Get-SCOMClassInstance -Name *.Contoso.com | Get-SCOMTask

-------------------------- EXAMPLE 6 --------------------------

Description

-----------

This command gets the task with an Id of 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.

PS C:\>Get-SCOMTask -Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd

Related topics

Get-SCOMClass

Get-SCOMClassInstance

Get-SCOMManagementPack

Get-SCOMTaskResult

Start-SCOMTask