Move-Cluster Virtual Machine Role

Module:
failoverclusters
Moves the ownership of a clustered virtual machine to a different node.

Syntax 

Move-ClusterVirtualMachineRole
    [[-Name] <String>]
    [[-Node] <String>]
    [-Cancel]
    [-MigrationType <VmMigrationType>]
    [-IgnoreLocked]
    [-VMId <Guid>]
    [-Wait <Int32>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

Description

The Move-ClusterVirtualMachineRole cmdlet moves the ownership of a clustered virtual machine to a different node.

This cmdlet is used to live migrate a clustered virtual machine. For quick migration, use Move-ClusterGroup after using Get-ClusterResource and Set-ClusterParameter to set the OfflineAction parameter of the virtual machine resource to save state, or a value of 1.

Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.

Examples

Example 1 

PS C:\> Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Node node2
Name                       OwnerNode                           State 
----                       ---------                           ----- 
Virtual Machine1           node2                              Online

This example performs a live migration of the clustered virtual machine named Virtual Machine1 to the node named node2. The Windows PowerShell® prompt does not return until the action is complete.

Example 2 

PS C:\> Get-ClusterGroup -Name "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0
Name                       OwnerNode                           State 
----                       ---------                           ----- 
Virtual Machine1           node2                              Online

This example performs a live migration of clustered virtual machine named Virtual Machine1 to the node named node2. The Windows PowerShell® prompt returns as soon as the action has been initiated.

Example 3 

PS C:\> Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Cancel
Name                       OwnerNode                           State 
----                       ---------                           ----- 
Virtual Machine1           node1                              Online

This example cancels the live migration in progress for the clustered virtual machine named Virtual Machine1.

Example 4 

PS C:\> $groups = Get-ClusterNode -Name node1 | Get-ClusterGroup | Where-Object -FilterScript {$_ | Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType -Like "Virtual Machine"}}



PS C:\> ForEach-Object -InputObject ($group in $groups) -Process { $group | Move-ClusterVirtualMachineRole -Node node2 }
Name                       OwnerNode                           State 
----                       ---------                           ----- 
Virtual Machine1           node2                              Online 
Virtual Machine2           node2                              Online 
Virtual Machine3           node2                              Online

This example performs a live migration of all clustered virtual machines that are currently owned by the node named node1 to the node named node2. The migration of each virtual machine should complete before the next migration is started. Use this cmdlet before performing maintenance on the specified node.

Optional Parameters

-Cancel

Specifies that an in-progress live migration of the virtual machine be canceled.

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

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

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

Specifies that locked groups are ignored when running the cmdlet.

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

Specifies the clustered virtual machine to move.

Type: PSObject
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-MigrationType

Specifies the type of migration to perform for the virtual machine. The options are as follows:

-- Live: Transparently migrates the virtual machine without a dropped network connection or perceived downtime.

-- Quick: Rapidly migrates a running virtual machine with minimal downtime.

-- Shutdown: Performs an orderly shutdown of the operating system (waiting for all processes to close) on the virtual machine, and then migrates the virtual machine.

-- ShutdownForce: Shuts down the operating system on the virtual machine without waiting for slower processes to finish, and then migrates the virtual machine.

-- TurnOff: Turns off the virtual machine without shutting down the operating system first, then migrates the virtual machine. This is the same as turning off the power, which means that data loss may occur.

Type: VmMigrationType
Parameter Sets: TurnOff, Quick, Shutdown, ShutdownForce, Live
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the clustered virtual machine to move.

Type: String
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Node

Specifies the name of the cluster node to which to move the virtual machine.

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

Specifies the virtual machine identifier (ID).

Type: Guid
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Wait

Specifies the time in seconds to wait for the cmdlet. If the Wait parameter is not specified, then the cmdlet waits for completion. If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.

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

Inputs

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterGroup