Rename-VMSnapshot
Renames a virtual machine checkpoint.
Rename-VMSnapshot
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-Name] <String>
[-VMName] <String>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMSnapshot
[-VMSnapshot] <VMSnapshot>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMSnapshot
[-VM] <VirtualMachine>
[-Name] <String>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
The Rename-VMSnapshot cmdlet renames a virtual machine checkpoint.
Note: In Windows Server 2012 R2, virtual machine snapshots were renamed to virtual machine checkpoints. For clarity, this document will refer to virtual machine snapshots as checkpoints.
PS C:\> Rename-VMSnapshot -VMName TestVM -Name "Configuration 2" -NewName "Configuration 2: applied all updates"
Renames checkpoint Configuration 2 of virtual machine TestVM to Configuration 2: applied all updates.
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 |
Specifies one or more Hyper-V hosts on which the virtual machine checkpoint is to be renamed. 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 |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
Specifies the name of the virtual machine checkpoint to be renamed.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the name to which the virtual machine checkpoint is to be renamed.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies that a VMSnapshot object is to be passed through to the pipeline representing the virtual machine checkpoint to be renamed.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the virtual machine of which the checkpoint is to be renamed.
Type: | VirtualMachine |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the name of the virtual machine of which the checkpoint is to be renamed.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the virtual machine checkpoint to be renamed.
Type: | VMSnapshot |
Aliases: | VMCheckpoint |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
None
Default
VMSnapshot
If -PassThru is specified.