external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|
Microsoft.HyperV.PowerShell.dll-Help.xml |
Hyper-V |
10/30/2017 |
2.0.0 |
Rename-VM |
Renames a virtual machine.
Rename-VM [-Name] <String> [-NewName] <String> [-Passthru] [-ComputerName <String[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Rename-VM [-NewName] <String> [-Passthru] [-VM] <VirtualMachine[]> [-ComputerName <String[]>] [-WhatIf]
[-Confirm] [<CommonParameters>]
The Rename-VM cmdlet renames a virtual machine.
PS C:\>Rename-VM VM1 -NewName VM2
Renames virtual machine VM1 to VM2.
PS C:\>Get-VM VM1 | Rename-VM -NewName VM2 -PassThru
Renames virtual machine VM1 to VM2 and displays the renamed virtual machine.
Specifies one or more Hyper-V hosts on which the virtual machine is to be deleted. 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: (All)
Aliases:
Required: False
Position: Named
Default value: .
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies the name of the virtual machine to be renamed.
Type: String
Parameter Sets: Name
Aliases: VMName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name to which the virtual machine is to be renamed.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies that an object is to be passed through to the pipeline representing the virtual machine to be renamed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the virtual machine to be renamed.
Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.