Invoke-XenPBD
Invokes an operation on a PBD object.
Syntax
Invoke-XenPBD [-PBD] <PBD> -XenAction {Plug | Unplug} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenPBD [-Ref] <XenRef[PBD]> -XenAction {Plug | Unplug} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenPBD [-Uuid] <guid> -XenAction {Plug | Unplug} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Description
Invokes an operation on a PBD object. Use the -XenAction parameter to select which operation to perform.
Plug: Activate the specified PBD, causing the referenced SR to be attached and scanned.
Unplug: Deactivate the specified PBD, causing the referenced SR to be detached and no longer scanned.
Parameters
-Async
If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
| 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 |
-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 |
-XenAction
Selects which action to use.
| Attribute | Value |
|---|---|
| Type | XenPBDAction |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Plug, Unplug |
Inputs
-
PBD -
XenRef[PBD] -
guid
Outputs
-
System.Object
Examples
Example 1: Run the Plug operation
PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenPBD -XenAction Plug
Invokes the Plug operation on a PBD.
Example 2: Run the Plug operation by uuid
PS> Invoke-XenPBD -XenAction Plug -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the Plug operation on a PBD. -Uuid is the way to be sure of exactly one object.
Example 3: Run Plug asynchronously
PS> Invoke-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Plug -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.
Related links
-
Class: PBD
-
Using the XenServer PowerShell module