Invoke-XenPUSB
Invokes an operation on a PUSB object.
Syntax
Invoke-XenPUSB [-PUSB] <PUSB> -XenAction {Scan} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenPUSB [-Ref] <XenRef[PUSB]> -XenAction {Scan} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenPUSB [-Uuid] <guid> -XenAction {Scan} [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Description
Invokes an operation on a PUSB object. Use the -XenAction parameter to select which operation to perform.
Scan
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 |
-PUSB
The PUSB object to operate on.
| Attribute | Value |
|---|---|
| Type | PUSB |
| 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 PUSB object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[PUSB] |
| 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 PUSB 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 | XenPUSBAction |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Scan |
-XenHost
The host. Accepted when -XenAction is Scan.
| Attribute | Value |
|---|---|
| Type | XenRef[Host] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
Inputs
-
PUSB -
XenRef[PUSB] -
guid
Outputs
-
System.Object
Examples
Example 1: Run the Scan operation
PS> Get-XenPUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenPUSB -XenAction Scan
Invokes the Scan operation on a PUSB.
Example 2: Run the Scan operation by uuid
PS> Invoke-XenPUSB -XenAction Scan -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the Scan operation on a PUSB. -Uuid is the way to be sure of exactly one object.
Example 3: Run Scan asynchronously
PS> Invoke-XenPUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Scan -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.
Related links
-
Class: PUSB
-
Using the XenServer PowerShell module