Get-XenVGPUTypeProperty

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

Syntax

Get-XenVGPUTypeProperty [-VGPUType] <VGPU_type>
    -XenProperty {Uuid | VendorName | ModelName | FramebufferSize | MaxHeads | MaxResolutionX | MaxResolutionY | SupportedOnPGPUs | EnabledOnPGPUs | VGPUs | SupportedOnGPUGroups | EnabledOnGPUGroups | Implementation | Identifier | Experimental | CompatibleTypesInVm}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVGPUTypeProperty [-Ref] <XenRef[VGPU_type]>
    -XenProperty {Uuid | VendorName | ModelName | FramebufferSize | MaxHeads | MaxResolutionX | MaxResolutionY | SupportedOnPGPUs | EnabledOnPGPUs | VGPUs | SupportedOnGPUGroups | EnabledOnGPUGroups | Implementation | Identifier | Experimental | CompatibleTypesInVm}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VGPUType object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VGPU\_type.
VendorName: Get the vendor\_name field of the given VGPU\_type.
ModelName: Get the model\_name field of the given VGPU\_type.
FramebufferSize: Get the framebuffer\_size field of the given VGPU\_type.
MaxHeads: Get the max\_heads field of the given VGPU\_type.
MaxResolutionX: Get the max\_resolution\_x field of the given VGPU\_type.
MaxResolutionY: Get the max\_resolution\_y field of the given VGPU\_type.
SupportedOnPGPUs: Get the supported\_on\_PGPUs field of the given VGPU\_type.
EnabledOnPGPUs: Get the enabled\_on\_PGPUs field of the given VGPU\_type.
VGPUs: Get the VGPUs field of the given VGPU\_type.
SupportedOnGPUGroups: Get the supported\_on\_GPU\_groups field of the given VGPU\_type.
EnabledOnGPUGroups: Get the enabled\_on\_GPU\_groups field of the given VGPU\_type.
Implementation: Get the implementation field of the given VGPU\_type.
Identifier: Get the identifier field of the given VGPU\_type.
Experimental: Get the experimental field of the given VGPU\_type.
CompatibleTypesInVm: Get the compatible\_types\_in\_vm field of the given VGPU\_type.

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

-VGPUType

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVGPUTypeProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, VendorName, ModelName, FramebufferSize, MaxHeads, MaxResolutionX, MaxResolutionY, SupportedOnPGPUs, EnabledOnPGPUs, VGPUs, SupportedOnGPUGroups, EnabledOnGPUGroups, Implementation, Identifier, Experimental, CompatibleTypesInVm

Inputs

  • VGPU_type
  • XenRef[VGPU_type]

Outputs

  • System.Object

Examples

Example 1: Get the VendorName property

PS> Get-XenVGPUType -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUTypeProperty -XenProperty VendorName
Gets the VendorName property of a VGPUType.

Example 2: Get the ModelName property

PS> Get-XenVGPUType -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUTypeProperty -XenProperty ModelName
Gets the ModelName property of a VGPUType.

Example 3: Get the FramebufferSize property

PS> Get-XenVGPUType -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVGPUTypeProperty -XenProperty FramebufferSize
Gets the FramebufferSize property of a VGPUType.