Set-XenVMGroup

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

Syntax

Set-XenVMGroup [-VMGroup] <VM_group> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMGroup [-Ref] <XenRef[VM_group]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMGroup [-Uuid] <guid> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMGroup [-Name] <string> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]

Description

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

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

-Name

The name of the VMGroup 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 VM\_group.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given VM\_group.
Attribute Value
Type 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 VMGroup object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_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 VMGroup to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VMGroup

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

-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

  • VM_group
  • XenRef[VM_group]
  • guid
  • string

Outputs

  • VM_group
  • void

Examples

Example 1: Set the NameLabel field

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

Example 2: Set the NameDescription field

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

Example 3: Set the NameLabel field by name

PS> Set-XenVMGroup -NameLabel "new value" -Name "Demo VMGroup"
Sets the NameLabel field of a VMGroup. -Name matches on name\_label, which is not unique, so every match is operated on.