Get-XenVMGroupProperty

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

Syntax

Get-XenVMGroupProperty [-VMGroup] <VM_group>
    -XenProperty {Uuid | NameLabel | NameDescription | Placement | VMs} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMGroupProperty [-Ref] <XenRef[VM_group]>
    -XenProperty {Uuid | NameLabel | NameDescription | Placement | VMs} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VMGroup object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VM\_group.
NameLabel: Get the name/label field of the given VM\_group.
NameDescription: Get the name/description field of the given VM\_group.
Placement: Get the placement field of the given VM\_group.
VMs: Get the VMs field of the given VM\_group.

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

-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

-VMGroup

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVMGroupProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Placement, VMs

Inputs

  • VM_group
  • XenRef[VM_group]

Outputs

  • System.Object

Examples

Example 1: Get the Placement property

PS> Get-XenVMGroup -Name "Demo VMGroup" | Get-XenVMGroupProperty -XenProperty Placement
Gets the Placement property of a VMGroup.

Example 2: Get the VMs property

PS> Get-XenVMGroup -Name "Demo VMGroup" | Get-XenVMGroupProperty -XenProperty VMs
Gets the VMs property of a VMGroup.

Example 3: Get the Uuid property

PS> Get-XenVMGroup -Name "Demo VMGroup" | Get-XenVMGroupProperty -XenProperty Uuid
Gets the Uuid property of a VMGroup.