NAME
Disable-DcsTask
SYNOPSIS
Disables a task.
SYNTAX
Disable-DcsTask -Task <Object> [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Disables a task. The task will not run again until enabled.
PARAMETERS
- -Task<Object>
- TaskData object, name, or ID that identifies the task.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- 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 and describes the task.
OUTPUTS
TaskData : Object that identifies and describes the task.
NOTES
Also see Get-DcsTask, Enable-DcsTask.
EXAMPLES
-------------- Example 1 Disables a task specified by name (caption) --------------
Disable-DcsTask -Task MyNightlyTask
Disables the task named "MyNightlyTask". The task will not run again until enabled.
| Description | : | Start Virtual Disk Reclamation at 2 am |
| Enabled | : | False |
| ActionBehavior | : | RunPerTrigger |
| MaxRunTime | : | 6048000000000 |
| Connective | : | LogicalAnd |
| ActionDelay | : | 0 |
| State | : | Idle |
| CurrentActionId | : | |
| LastStartTime | : | 1/1/0001 12:00:00 AM |
| LastStopTime | : | 1/1/0001 12:00:00 AM |
| Id | : | e0b61456-55b1-4f09-9567-39586e71ef16 |
| Caption | : | MyNightlyTask |
| ExtendedCaption | : | MyNightlyTask |
| Internal | : | False |
-------------- Example 2 Disables all tasks by piping objects --------------
Get-DcsTask | Disable-DcsTask
Disables all enabled tasks on servers in the server group. The task objects were obtained using the Get-DcsTask cmdlet.
| Description | : | |
| Enabled | : | False |
| 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 | : | 32651f76-72e9-4852-ba35-0b111eaa7808 |
| Caption | : | Task 1 |
| ExtendedCaption | : | Task 1 |
| Internal | : | False |
| Description | : | |
| Enabled | : | False |
| 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 | : | b72c3fac-61d0-4641-95f1-1c310b7c322d |
| Caption | : | Task 2 |
| ExtendedCaption | : | Task 2 |
| Internal | : | False |