Remove-XenTaskProperty
Removes values from fields of a Task object.
Syntax
Remove-XenTaskProperty [-Task] <Task> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTaskProperty [-Ref] <XenRef[Task]> [-PassThru] [-OtherConfig <string>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTaskProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTaskProperty [-Name] <string> [-PassThru] [-OtherConfig <string>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Removes values from the collection-valued fields of a Task. Each optional parameter listed below corresponds to a field that can be removed from.
Parameters
-Async
If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-BestEffort
If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Confirm
Prompts for confirmation before running the cmdlet.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | cf |
-Name
The name of the Task to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-OtherConfig
Remove the given key and its corresponding value from the other\_config field of the given task. If the key is not in that Map, then do nothing.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-PassThru
If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ref
The Task object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Task] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SessionOpaqueRef
The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Task
The Task object to operate on.
| Attribute | Value |
|---|---|
| Type | Task |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-Uuid
The UUID of the Task to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | wi |
Inputs
-
Task -
XenRef[Task] -
guid -
string
Outputs
-
Task -
Task
Examples
Example 1: Remove an otherconfig
PS> Remove-XenTaskProperty -OtherConfig "value" -Name "Demo Task"
Remove the given key and its corresponding value from the other\_config field of the given task. If the key is not in that Map, then do nothing.
Example 2: Remove an otherconfig piped from the getter
PS> Get-XenTask -Name "Demo Task" | Remove-XenTaskProperty -OtherConfig "value"
Remove the given key and its corresponding value from the other\_config field of the given task. If the key is not in that Map, then do nothing. The object is piped in, which is the usual way once you already have it.
Example 3: Remove an otherconfig by uuid
PS> Remove-XenTaskProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Remove the given key and its corresponding value from the other\_config field of the given task. If the key is not in that Map, then do nothing. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: Task
-
Using the XenServer PowerShell module