Get-XenGPUGroupProperty

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

Syntax

Get-XenGPUGroupProperty [-GPUGroup] <GPU_group>
    -XenProperty {Uuid | NameLabel | NameDescription | PGPUs | VGPUs | GPUTypes | OtherConfig | AllocationAlgorithm | SupportedVGPUTypes | EnabledVGPUTypes | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenGPUGroupProperty [-Ref] <XenRef[GPU_group]>
    -XenProperty {Uuid | NameLabel | NameDescription | PGPUs | VGPUs | GPUTypes | OtherConfig | AllocationAlgorithm | SupportedVGPUTypes | EnabledVGPUTypes | RemainingCapacity}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a GPUGroup object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given GPU\_group.
NameLabel: Get the name/label field of the given GPU\_group.
NameDescription: Get the name/description field of the given GPU\_group.
PGPUs: Get the PGPUs field of the given GPU\_group.
VGPUs: Get the VGPUs field of the given GPU\_group.
GPUTypes: Get the GPU\_types field of the given GPU\_group.
OtherConfig: Get the other\_config field of the given GPU\_group.
AllocationAlgorithm: Get the allocation\_algorithm field of the given GPU\_group.
SupportedVGPUTypes: Get the supported\_VGPU\_types field of the given GPU\_group.
EnabledVGPUTypes: Get the enabled\_VGPU\_types field of the given GPU\_group.
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

-GPUGroup

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

-Ref

The GPUGroup object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[GPU_group]
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 the remaining capacity will be calculated. 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 XenGPUGroupProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, PGPUs, VGPUs, GPUTypes, OtherConfig, AllocationAlgorithm, SupportedVGPUTypes, EnabledVGPUTypes, RemainingCapacity

Inputs

  • GPU_group
  • XenRef[GPU_group]

Outputs

  • System.Object

Examples

Example 1: Get the PGPUs property

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Get-XenGPUGroupProperty -XenProperty PGPUs
Gets the PGPUs property of a GPUGroup.

Example 2: Get the VGPUs property

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Get-XenGPUGroupProperty -XenProperty VGPUs
Gets the VGPUs property of a GPUGroup.

Example 3: Get the GPUTypes property

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Get-XenGPUGroupProperty -XenProperty GPUTypes
Gets the GPUTypes property of a GPUGroup.