Add-XenTask
Adds to fields of a Task object.
Syntax
Add-XenTask [-Task] <Task> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenTask [-Ref] <XenRef[Task]> [-PassThru]
[-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenTask [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenTask [-Name] <string> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Adds values to the collection-valued fields of a Task. Each optional parameter listed below corresponds to a field that can be added to.
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
Add the given key-value pair to the other\_config field of the given task.
| Attribute | Value |
|---|---|
| Type | KeyValuePair[string, 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 -
void
Examples
Example 1: Add an otherconfig
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenTask -OtherConfig $entry -Name "Demo Task"
Add the given key-value pair to the other\_config field of the given task.
Example 2: Add an otherconfig piped from the getter
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Get-XenTask -Name "Demo Task" | Add-XenTask -OtherConfig $entry
Add the given key-value pair to the other\_config field of the given task. The object is piped in, which is the usual way once you already have it.
Example 3: Add an otherconfig by uuid
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenTask -OtherConfig $entry -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Add the given key-value pair to the other\_config field of the given task. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: Task
-
Using the XenServer PowerShell module