Start-SCOMTask
Starts a task for a specified object.
Syntax
Default (Default)
Start-SCOMTask
[-Instance] <EnterpriseManagementObject[]>
[-Task] <ManagementPackTask>
-TaskCredentials <PSCredential>
[[-Override] <Hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Start-SCOMTask cmdlet starts a task for a specified object. This cmdlet takes a task object and a class instance object as input. The cmdlet accepts only one task, but it can accept multiple class instances and overrides.
Examples
Example 1: Start a task by using a display name
PS C:\>$Instances = Get-SCOMClassInstance -Name "*.Contoso.com"
PS C:\> Get-SCOMTask -DisplayName "Get Monitor State" | Start-SCOMTask -Instance $Instances
This example starts a task by using a display name.
The first command gets all class instances in the Contoso.com domain and stores them in the $Instances variable.
The second command gets the task that has the display name Get Monitor State and starts the task for each class instance that is stored in the $Instances variable.
Example 2: Start a task by using a display name and a timeout specification
PS C:\>$Overrides = @{Timeout=60}
PS C:\> $Instances = Get-SCOMClassInstance -DisplayName "Contoso Service"
PS C:\> $Task = Get-SCOMTask -DisplayName "Start NT Service"
PS C:\> Start-SCOMTask -Task $Task -Instance $Instances -Override $Overrides
This example shows how to start a task by using a display name and a hash table that specifies a timeout value.
The first command creates a hash table that has a value for the Timeout key and stores it in the $Overrides variable.
The second command gets all class instances that have the name Contoso Service and stores them in the $Instances variable.
The third command gets the task that has the display name Start NT Service and starts the task for each class instance that is stored in the $Instances variable.
The fourth command starts the task for each class instance that is stored in the $Instances variable. The command specifies a Timeout key value of 60.
Example 3: Start a task by using credentials
PS C:\>$Credential = Get-Credential
PS C:\> $Instance = Get-SCOMClassInstance -Name "Server01.Contoso.com"
PS C:\> Get-SCOMTask -DisplayName "Reset State" | Start-SCOMTask -Instance $Instance -TaskCredentials $Credential
This example starts a task by using credentials.
The first command prompts the user for a user name and password, creates a credential object from the input, and stores the credential object in the $Credential variable.
The second command gets a class instance named Server01.Contoso.com and stores it in the $Instance variable.
The third command gets a task that has the display name Reset State and starts the task for the class instance that is stored in $Instance. The command runs the task under the credentials that are stored in $Credential.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Instance
Specifies an array of EnterpriseManagementObject objects that represent class instance objects for which to start a task. Specify a variable that stores the class instances or use a cmdlet such as the Get-SCOMClassInstance cmdlet that gets the class instances. This parameter also accepts group objects. To obtain a group object, use the Get-SCOMGroup cmdlet.
Parameter properties
| Type: | EnterpriseManagementObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Override
Specifies a hash table that defines new values for one or more task parameters, if those parameters allow overrides.
For more information about hash tables, type "Get-Help about_Hash_Tables".
To determine which parameters for a task allow overrides, use the GetOverrideableParameters method for the task object.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Task
Specifies a task object to start. Specify a variable that represents a task, or use a cmdlet such as the Get-SCOMTask cmdlet that gets a task. This parameter accepts only one task object.
Parameter properties
| Type: | ManagementPackTask |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TaskCredentials
Specifies the user account under which the management group connection runs.
Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter.
For more information about credential objects, type "Get-Help Get-Credential".
This account must have access to the server that is specified in the ComputerName parameter if that parameter appears.
This is a mandatory parameter. If you specify a null value, Operations Manager uses the default TaskCredentials of the account for the current user.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.