Update-SCVMVersion

  • Reference
Module:
VirtualMachineManager

Updates the version of configuration and save state files for a virtual machine.

Syntax

Update-SCVMVersion
      [-VM] <VM>
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-OnBehalfOfUser <String>]
      [-OnBehalfOfUserRole <UserRole>]
      [<CommonParameters>]

Description

The Update-SCVMVersion cmdlet updates the version of configuration and save state files for a virtual machine. You can find a virtual machine's current version by examining its $VM.Version property.

With Windows 10®, a virtual machine can run configuration files from an earlier version; one way to achieve this is to migrate a virtual machine from a Windows Server 2016 host machine to a Windows 10 host machine.

To perform the update:

  • The virtual machine must be off.
  • It must have no checkpoints with saved state.
  • It must be an earlier version than what is supported by the host.

Note: A Windows 10 host running in a mixed-mode cluster only supports Windows Server 2012 R2 and Windows Server 2016 configurations, and does not allow updates to Windows 10 until the functional level of the cluster is updated to Windows 10.

Parameters

-JobVariable

Specifies a variable in which job progress is tracked and stored.

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

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

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

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

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

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-VM

Specifies a virtual machine.

Type:VM
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False