Set-XenPBD
Sets fields of a PBD object.
Syntax
Set-XenPBD [-PBD] <PBD> [-PassThru] [-OtherConfig <hashtable>] [-DeviceConfig <hashtable>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPBD [-Ref] <XenRef[PBD]> [-PassThru] [-OtherConfig <hashtable>]
[-DeviceConfig <hashtable>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-XenPBD [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>]
[-DeviceConfig <hashtable>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Description
Changes writable fields of a PBD. Each optional parameter listed below corresponds to a field that can be set.
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 |
-DeviceConfig
Sets the PBD's device\_config field
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-OtherConfig
Set the other\_config field of the given PBD.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-PBD
The PBD object to operate on.
| Attribute | Value |
|---|---|
| Type | PBD |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-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 PBD object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[PBD] |
| 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 |
-Uuid
The UUID of the PBD 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
-
PBD -
XenRef[PBD] -
guid
Outputs
-
PBD -
Task -
void
Examples
Example 1: Set the OtherConfig field
PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPBD -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a PBD.
Example 2: Set a deviceconfig
PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPBD -DeviceConfig @{ "key" = "value" }
Sets the PBD's device\_config field
Example 3: Set the OtherConfig field by uuid
PS> Set-XenPBD -OtherConfig @{ "key" = "value" } -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Sets the OtherConfig field of a PBD. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: PBD
-
Using the XenServer PowerShell module