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