Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Rename-VMGroup

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Renames virtual machine groups.

SYNTAX

Name (Default)

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

Id

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

InputObject

Rename-VMGroup [-VMGroup] <VMGroup[]> [-NewName] <String> [-Passthru] [-WhatIf] [-Confirm] [<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.

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[]
Parameter Sets: Name, Id
Aliases: 

Required: False
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[]
Parameter Sets: Name, Id
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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[]
Parameter Sets: Name, Id
Aliases: 

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

-Id

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

Type: Guid
Parameter Sets: Id
Aliases: 

Required: True
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[]
Parameter Sets: Name
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
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[]
Parameter Sets: InputObject
Aliases: 

Required: True
Position: 0
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.HyperV.PowerShell.VMGroup

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

NOTES

Get-VMGroup

New-VMGroup

Remove-VMGroup

© 2017 Microsoft