Set-XenGPUGroup

Last published : Nov 12, 2026
Sets fields of a GPUGroup object.
Related information
GPUGroup cmdlets

Syntax

Set-XenGPUGroup [-GPUGroup] <GPU_group> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-OtherConfig <hashtable>]
    [-AllocationAlgorithm {breadth_first | depth_first | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenGPUGroup [-Ref] <XenRef[GPU_group]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-OtherConfig <hashtable>]
    [-AllocationAlgorithm {breadth_first | depth_first | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenGPUGroup [-Uuid] <guid> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-OtherConfig <hashtable>]
    [-AllocationAlgorithm {breadth_first | depth_first | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenGPUGroup [-Name] <string> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-OtherConfig <hashtable>]
    [-AllocationAlgorithm {breadth_first | depth_first | unknown}] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a GPUGroup. Each optional parameter listed below corresponds to a field that can be set.

Parameters

-AllocationAlgorithm

Set the allocation\_algorithm field of the given GPU\_group.
Attribute Value
Type allocation_algorithm
Required False
Position Named
Accepts pipeline input False
Accepted values breadth_first, depth_first, unknown

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-GPUGroup

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

-Name

The name of the GPUGroup to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-NameDescription

Set the name/description field of the given GPU\_group.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given GPU\_group.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-OtherConfig

Set the other\_config field of the given GPU\_group.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-Uuid

The UUID of the GPUGroup to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • GPU_group
  • XenRef[GPU_group]
  • guid
  • string

Outputs

  • GPU_group
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Set-XenGPUGroup -NameLabel "new value"
Sets the NameLabel field of a GPUGroup.

Example 2: Set the NameDescription field

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Set-XenGPUGroup -NameDescription "new value"
Sets the NameDescription field of a GPUGroup.

Example 3: Set the OtherConfig field

PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Set-XenGPUGroup -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a GPUGroup.