Get-XenHostDriverProperty

Last published : Nov 12, 2026
Gets a property of a HostDriver object.
Related information
HostDriver cmdlets

Syntax

Get-XenHostDriverProperty [-HostDriver] <Host_driver>
    -XenProperty {Uuid | Host | Name | FriendlyName | Variants | ActiveVariant | SelectedVariant | Type | Description | Info}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenHostDriverProperty [-Ref] <XenRef[Host_driver]>
    -XenProperty {Uuid | Host | Name | FriendlyName | Variants | ActiveVariant | SelectedVariant | Type | Description | Info}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a HostDriver object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Host\_driver.
Host: Get the host field of the given Host\_driver.
Name: Get the name field of the given Host\_driver.
FriendlyName: Get the friendly\_name field of the given Host\_driver.
Variants: Get the variants field of the given Host\_driver.
ActiveVariant: Get the active\_variant field of the given Host\_driver.
SelectedVariant: Get the selected\_variant field of the given Host\_driver.
Type: Get the type field of the given Host\_driver.
Description: Get the description field of the given Host\_driver.
Info: Get the info field of the given Host\_driver.

Parameters

-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

-HostDriver

The HostDriver object to operate on.
Attribute Value
Type Host_driver
Required True
Position 0
Accepts pipeline input True (ByValue)

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenHostDriverProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Host, Name, FriendlyName, Variants, ActiveVariant, SelectedVariant, Type, Description, Info

Inputs

  • Host_driver
  • XenRef[Host_driver]

Outputs

  • System.Object

Examples

Example 1: Get the Host property

PS> Get-XenHostDriver -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenHostDriverProperty -XenProperty Host
Gets the Host property of a HostDriver.

Example 2: Get the Name property

PS> Get-XenHostDriver -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenHostDriverProperty -XenProperty Name
Gets the Name property of a HostDriver.

Example 3: Get the FriendlyName property

PS> Get-XenHostDriver -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenHostDriverProperty -XenProperty FriendlyName
Gets the FriendlyName property of a HostDriver.