NAME
Get-DcsTask
SYNOPSIS
Returns data for tasks.
SYNTAX
Get-DcsTask [ -Task <Object> ] [ -States <String[]> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Returns data for tasks. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all tasks on all servers in the default connection will be returned.
PARAMETERS
- -Task<Object>
- TaskData object, name, or ID that identifies a task. If specified, only data for that task will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -States<String[]>
- Use this parameter to return tasks with one or more specific states. Possible values are: "Idle", "Running", and "Aborting". If specified, only tasks in those states will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Connection<String>
- Alias of the connection to the server group. If not specified, the default connection is used.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -PipelineVariable<String>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
TaskData : Object that identifies the task.
OUTPUTS
TaskData : Object that identifies the task.
NOTES
Also see Add-DcsTask, Remove-DcsTask, Get-DcsAction, Get-DcsTrigger, Set-DcsTaskProperties.
EXAMPLES
-------------- Example 1 Returns data for a task specified by name --------------
Get-DcsTask -Task ReclaimVD1
Returns data about the task named "ReclaimVD1".
Description | : | Reclaims unused space on Virtual disk 1 every night at 11:30PM |
Enabled | : | True |
ActionBehavior | : | RunPerTrigger |
MaxRunTime | : | 6048000000000 |
Connective | : | LogicalOr |
ActionDelay | : | 0 |
State | : | Idle |
CurrentActionId | : | |
LastStartTime | : | 1/1/0001 12:00:00 AM |
LastStopTime | : | 1/1/0001 12:00:00 AM |
Id | : | 0f028eee-1954-4d2a-8787-a36ba47a472f |
Caption | : | ReclaimVD1 |
ExtendedCaption | : | ReclaimVD1 |
Internal | : | False |