Add-XenGPUGroup

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

Syntax

Add-XenGPUGroup [-GPUGroup] <GPU_group> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenGPUGroup [-Ref] <XenRef[GPU_group]> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenGPUGroup [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenGPUGroup [-Name] <string> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Adds values to the collection-valued fields of a GPUGroup. Each optional parameter listed below corresponds to a field that can be added to.

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

-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

-OtherConfig

Add the given key-value pair to the other\_config field of the given GPU\_group.
Attribute Value
Type KeyValuePair[string, string]
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: Add to the OtherConfig field

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenGPUGroup -OtherConfig $entry -Name "Demo GPUGroup"
Adds a value to the OtherConfig field of a GPUGroup. The parameter takes one entry of the map; a hashtable does not bind to it.

Example 2: Add to the OtherConfig field piped from the getter

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Get-XenGPUGroup -Name "Demo GPUGroup" | Add-XenGPUGroup -OtherConfig $entry
Adds a value to the OtherConfig field of a GPUGroup. The parameter takes one entry of the map; a hashtable does not bind to it. The object is piped in, which is the usual way once you already have it.

Example 3: Add to the OtherConfig field by uuid

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenGPUGroup -OtherConfig $entry -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Adds a value to the OtherConfig field of a GPUGroup. The parameter takes one entry of the map; a hashtable does not bind to it. -Uuid is the way to be sure of exactly one object.