Get-XenPGPUProperty

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

Syntax

Get-XenPGPUProperty [-PGPU] <PGPU>
    -XenProperty {Uuid | PCI | GPUGroup | Host | OtherConfig | SupportedVGPUTypes | EnabledVGPUTypes | ResidentVGPUs | SupportedVGPUMaxCapacities | Dom0Access | IsSystemDisplayDevice | CompatibilityMetadata | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenPGPUProperty [-Ref] <XenRef[PGPU]>
    -XenProperty {Uuid | PCI | GPUGroup | Host | OtherConfig | SupportedVGPUTypes | EnabledVGPUTypes | ResidentVGPUs | SupportedVGPUMaxCapacities | Dom0Access | IsSystemDisplayDevice | CompatibilityMetadata | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a PGPU object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PGPU.
PCI: Get the PCI field of the given PGPU.
GPUGroup: Get the GPU\_group field of the given PGPU.
Host: Get the host field of the given PGPU.
OtherConfig: Get the other\_config field of the given PGPU.
SupportedVGPUTypes: Get the supported\_VGPU\_types field of the given PGPU.
EnabledVGPUTypes: Get the enabled\_VGPU\_types field of the given PGPU.
ResidentVGPUs: Get the resident\_VGPUs field of the given PGPU.
SupportedVGPUMaxCapacities: Get the supported\_VGPU\_max\_capacities field of the given PGPU.
Dom0Access: Get the dom0\_access field of the given PGPU. (Deprecated.)
IsSystemDisplayDevice: Get the is\_system\_display\_device field of the given PGPU.
CompatibilityMetadata: Get the compatibility\_metadata field of the given PGPU.
RemainingCapacity

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

-PGPU

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

-Ref

The PGPU object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PGPU]
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 VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU. Accepted when -XenProperty is RemainingCapacity.
Attribute Value
Type XenRef[VGPU_type]
Required False
Position Named
Accepts pipeline input False

-XenProperty

Selects which property to use.
Attribute Value
Type XenPGPUProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, PCI, GPUGroup, Host, OtherConfig, SupportedVGPUTypes, EnabledVGPUTypes, ResidentVGPUs, SupportedVGPUMaxCapacities, Dom0Access, IsSystemDisplayDevice, CompatibilityMetadata, RemainingCapacity

Inputs

  • PGPU
  • XenRef[PGPU]

Outputs

  • System.Object

Examples

Example 1: Get the PCI property

PS> Get-XenPGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPGPUProperty -XenProperty PCI
Gets the PCI property of a PGPU.

Example 2: Get the GPUGroup property

PS> Get-XenPGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPGPUProperty -XenProperty GPUGroup
Gets the GPUGroup property of a PGPU.

Example 3: Get the Host property

PS> Get-XenPGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPGPUProperty -XenProperty Host
Gets the Host property of a PGPU.
  • PGPU cmdlets
  • Class: PGPU
  • Using the XenServer PowerShell module