Rename-VMGroup

Renames virtual machine groups.

Syntax

Rename-VMGroup
      [-Name] <String[]>
      [-NewName] <String>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Confirm]
      [-Credential <PSCredential[]>]
      [-Passthru]
      [-WhatIf]
      [<CommonParameters>]
Rename-VMGroup
      [-Id] <Guid>
      [-NewName] <String>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Confirm]
      [-Credential <PSCredential[]>]
      [-Passthru]
      [-WhatIf]
      [<CommonParameters>]
Rename-VMGroup
      [-VMGroup] <VMGroup[]>
      [-NewName] <String>
      [-Confirm]
      [-Passthru]
      [-WhatIf]
      [<CommonParameters>]

Description

The Rename-VMGroup cmdlet renames virtual machine groups.

Examples

Example 1: Rename a group

PS C:\> Rename-VMGroup -Name "TestGroup" -NewName "Group01"

This command renames the group named TestGroup to be Group01.

Required Parameters

-Id

Specifies the unique ID of the virtual machine group that this cmdlet renames.

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

Specifies an array of names of virtual machine groups that this cmdlet renames.

Type:String[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NewName

Specifies the new name for the virtual machine group.

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

Specifies an array of virtual machine groups that this cmdlet renames. To obtain a VMGroup object, use the Get-VMGroup cmdlet.

Type:VMGroup[]
Position:0
Default value:None
Accept pipeline input:False
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
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value: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
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMGroup object that it renames.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Outputs

Microsoft.HyperV.PowerShell.VMGroup

This cmdlet returns a Microsoft.HyperV.PowerShell.VMGroup object, if you specify the Passthru parameter.