Remove-VMGroup

Removes a virtual machine group.

Syntax

Remove-VMGroup
      [-Name] <String>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-Force]
      [<CommonParameters>]
Remove-VMGroup
      [-Id] <Guid>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-Force]
      [<CommonParameters>]
Remove-VMGroup
      [-VMGroup] <VMGroup>
      [-Force]
      [<CommonParameters>]

Description

The Remove-VMGroup cmdlet removes a virtual machine group. Before you can remove a group, it must be empty.

Examples

Example 1: Remove a group

PS C:\> Remove-VMGroup -Name "Group04"

This command removes the virtual machine group named Group04. Before you can remove a group, it must be empty.

Required Parameters

-Id

Specifies the unique ID of an empty virtual machine group that this cmldet removes.

Type:Guid
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of an empty virtual machine group that this cmdlet removes.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMGroup

Specifies an empty virtual machine group that this cmdlet removes. To obtain a VMGroup object, use the Get-VMGroup cmdlet.

Type:VMGroup
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional 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
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
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
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.Object