NAME
Remove-DcsTask
SYNOPSIS
Removes a task from the configuration.
SYNTAX
Remove-DcsTask -Task <Object> [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Removes a task from the configuration. After removal, the task will no longer exist.
PARAMETERS
- -Task<Object>
- TaskData object, name, or ID that identifies the task to remove.
-
- 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
NOTES
Also see, Add-DcsTask, Get-DcsTask, Remove-DcsAction, Remove-DcsTrigger.
EXAMPLES
-------------- Example 1 Removes a task specified by name --------------
Remove-DcsTask -Task MonitorPoolUsage
Removes the task named "MonitorPoolUsage" from the server group configuration.
-------------- Example 2 Removes all tasks by piping objects --------------
Get-DcsTask | Remove-DcsTask
The cmdlet Get-DcsTask is used to obtain the TaskData objects for all tasks for the server group. The results are piped to Remove-DcsSnapshot resulting in the removal of all tasks from the server group configuration.