Edit

New-VMGroup

  • Reference
Module:
Hyper-V

Creates a virtual machine group.

With Hyper-V, there are two types of VMGroups: a VMCollectionType and a ManagementCollectionType. A VMCollectionType VMGroup contains VMs while the ManagementCollectionType VMGroup contains VMCollectionType VMGroups. For example, you could have two VMCollectionType VMGroups VMG1 (containing VMs VM1 and VM2) and a second VMG2 (containing VMs VM3 and VM4). You could then create a ManagementCollectionType VMGroup VM-All containing the two VMCollectionType VMGroups. You use the Add-VMGroupMember cmdlet to add VMs to VMCollectionType VMGroups and to add VMCollectionType groups to ManagementCollectionType VMGroups.

Syntax

New-VMGroup
   [-Name] <String>
   [-GroupType] <GroupType>
   [[-Id] <Guid>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]

Description

The New-VMGroup cmdlet creates a virtual machine group.

Examples

Example 1: Create a group to contain virtual machines

PS C:\> New-VMGroup -Name 'CollectionGroup07' -GroupType VMCollectionType

This command creates a virtual machine group named CollectionGroup07 of type VMCollectionType. This group can contain collections of virtual machines.

Example 2: Create a group to contain groups of virtual machines

PS C:\> New-VMGroup -Name 'ManagementCollectionGroup03' -GroupType ManagementCollectionType

This command creates a virtual machine group named ManagementCollectionGroup03 of type ManagementCollectionType. This group can contain collections of other groups.

Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupType

Specifies the type of group that this cmdlet creates. The acceptable values for this parameter are: ManagementCollectionType and VMCollectionType.

Type:GroupType
Accepted values:VMCollectionType, ManagementCollectionType
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the unique ID of the group that this cmdlet creates.

Type:Guid
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name for the group that this cmdlet creates.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.HyperV.PowerShell.VMGroup