Invoke-XenHostDriver

Last published : Nov 12, 2026
Invokes an operation on a HostDriver object.
Related information
HostDriver cmdlets

Syntax

Invoke-XenHostDriver [-HostDriver] <Host_driver> -XenAction {Select | Deselect | Rescan}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenHostDriver [-Ref] <XenRef[Host_driver]> -XenAction {Select | Deselect | Rescan}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenHostDriver [-Uuid] <guid> -XenAction {Select | Deselect | Rescan} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a HostDriver object. Use the -XenAction parameter to select which operation to perform.
Select: UNSUPPORTED. Select a variant of the driver to become active after reboot or immediately if currently no version is active.
Deselect: UNSUPPORTED. Deselect the currently active variant of this driver after reboot. No action will be taken if no variant is currently active.
Rescan: UNSUPPORTED. Re-scan a host's drivers and update information about them. This is mostly for trouble shooting.

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

-HostDriver

The HostDriver object to operate on.
Attribute Value
Type Host_driver
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 HostDriver object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Host_driver]
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 HostDriver to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-Variant

Driver version to become active (after reboot). Accepted when -XenAction is Select.
Attribute Value
Type XenRef[Driver_variant]
Required False
Position Named
Accepts pipeline input False

-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 XenHostDriverAction
Required True
Position Named
Accepts pipeline input False
Accepted values Select, Deselect, Rescan

-XenHost

Update driver information of this host. Accepted when -XenAction is Rescan.
Attribute Value
Type XenRef[Host]
Required False
Position Named
Accepts pipeline input False

Inputs

  • Host_driver
  • XenRef[Host_driver]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Select operation

PS> Get-XenHostDriver -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenHostDriver -XenAction Select
Invokes the Select operation on a HostDriver.

Example 2: Run the Select operation by uuid

PS> Invoke-XenHostDriver -XenAction Select -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the Select operation on a HostDriver. -Uuid is the way to be sure of exactly one object.

Example 3: Run Select asynchronously

PS> Invoke-XenHostDriver -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Select -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.