Get-XenVGPUProperty

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

Syntax

Get-XenVGPUProperty [-VGPU] <VGPU>
    -XenProperty {Uuid | VM | GPUGroup | Device | CurrentlyAttached | OtherConfig | Type | ResidentOn | ScheduledToBeResidentOn | CompatibilityMetadata | ExtraArgs | PCI}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVGPUProperty [-Ref] <XenRef[VGPU]>
    -XenProperty {Uuid | VM | GPUGroup | Device | CurrentlyAttached | OtherConfig | Type | ResidentOn | ScheduledToBeResidentOn | CompatibilityMetadata | ExtraArgs | PCI}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VGPU object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VGPU.
VM: Get the VM field of the given VGPU.
GPUGroup: Get the GPU\_group field of the given VGPU.
Device: Get the device field of the given VGPU.
CurrentlyAttached: Get the currently\_attached field of the given VGPU.
OtherConfig: Get the other\_config field of the given VGPU.
Type: Get the type field of the given VGPU.
ResidentOn: Get the resident\_on field of the given VGPU.
ScheduledToBeResidentOn: Get the scheduled\_to\_be\_resident\_on field of the given VGPU.
CompatibilityMetadata: Get the compatibility\_metadata field of the given VGPU.
ExtraArgs: Get the extra\_args field of the given VGPU.
PCI: Get the PCI field of the given VGPU.

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

-Ref

The VGPU object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VGPU]
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

-VGPU

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVGPUProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, VM, GPUGroup, Device, CurrentlyAttached, OtherConfig, Type, ResidentOn, ScheduledToBeResidentOn, CompatibilityMetadata, ExtraArgs, PCI

Inputs

  • VGPU
  • XenRef[VGPU]

Outputs

  • System.Object

Examples

Example 1: Get the VM property

PS> Get-XenVGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUProperty -XenProperty VM
Gets the VM property of a VGPU.

Example 2: Get the GPUGroup property

PS> Get-XenVGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUProperty -XenProperty GPUGroup
Gets the GPUGroup property of a VGPU.

Example 3: Get the Device property

PS> Get-XenVGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUProperty -XenProperty Device
Gets the Device property of a VGPU.
  • VGPU cmdlets
  • Class: VGPU
  • Using the XenServer PowerShell module