en-US/RiverMeadow.Migrate.psm1-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-RMVSphereVMBasedDifferentialMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMVSphereVMBasedDifferentialMigration</command:noun> <maml:description> <maml:para>Starts a VM based differential migration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a differential migration for the given VM based full migration ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMVSphereVMBasedDifferentialMigration</maml:name> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>Specifies the migration ID of a VM based full migration.</maml:para> </maml:description> <command:parameterValue required="True">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sat"> <maml:name>ScheduledAt</maml:name> <maml:description> <maml:para>Specifies the date and time at which the differential migration should be run.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rc"> <maml:name>RunContinuous</maml:name> <maml:description> <maml:para>Indicates whether the differential migration should be run continuously until it's finalized by the user.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ut"> <maml:name>UpgradeTools</maml:name> <maml:description> <maml:para>Indicates whether the VM tools should be upgraded on the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Indicates whether the source VM should be shutdown after the differential migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="st"> <maml:name>ShutdownTarget</maml:name> <maml:description> <maml:para>Indicates whether the target VM should be shutdown after the differential migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="fm"> <maml:name>FinalizeMigration</maml:name> <maml:description> <maml:para>Indicates whether the snapshot(s) should be removed from the Target VM in preparation for a cutover, no subsequent differential migrations can be run if this is set to True.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="fm"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies the special instructions for running the differential migration in the format 'key=value'.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationErrors</maml:name> <maml:description> <maml:para>Indicates whether to ignore any preflight errors that may occur.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>Specifies the migration ID of a VM based full migration.</maml:para> </maml:description> <command:parameterValue required="True">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sat"> <maml:name>ScheduledAt</maml:name> <maml:description> <maml:para>Specifies the date and time at which the differential migration should be started automatically.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rc"> <maml:name>RunContinuous</maml:name> <maml:description> <maml:para>Indicates whether the differential migration should be run continuously until it's finalized by the user.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ut"> <maml:name>UpgradeTools</maml:name> <maml:description> <maml:para>Indicates whether the VM tools should be upgraded on the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Indicates whether the source VM should be shutdown after the differential migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="st"> <maml:name>ShutdownTarget</maml:name> <maml:description> <maml:para>Indicates whether the target VM should be shutdown after the differential migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="fm"> <maml:name>FinalizeMigration</maml:name> <maml:description> <maml:para>Indicates whether the snapshot(s) should be removed from the Target VM in preparation for a cutover, no subsequent differential migrations can be run if this is set to True.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="fm"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies the special instructions for running the differential migration in the format 'key=value'.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationErrors</maml:name> <maml:description> <maml:para>Indicates whether to ignore any preflight errors that may occur.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet goes into the interactive mode when no parameters are given.</maml:para> <maml:para>When at least one parameter is specified, the cmdlet runs in the non-interactive mode and validates that all the required parameters are given.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RMMigrationReturn Object</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a RMMigrationReturn object, which has the following attributes:</maml:para> <maml:para> RMMigrationReturn [String] MigrationId RMPreflightCheck[] [String] Name [String] DisplayName [String] Description [String] Status RMError RMWarning [int] ReturnCode RMError [String] ErrorCode [String] Message [String] Resolution RMWarning [String] ErrorCode [String] Message [String] Resolution [Hashtable] OutputData </maml:para> <maml:para> RMMigrationReturn.ReturnCode = 0, indicates migration started successfully. RMMigrationReturn.ReturnCode = 1, indicates that there was an error in starting the migration. RMMigrationReturn.OutputData, contains any additional data that the cmdlet can return. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> </maml:alertSet> <command:examples> <command:example> <maml:title>----------Example 1: Differential migration started successfully----------</maml:title> <dev:code>PS C:\> Start-RMVSphereVMBasedDifferentialMigration -MigrationId "23cb1201-d6ce-4a5b-9bb3-d7e94a4288a7" -UpgradeTools $true -ShutdownSource $true Starting differential migration preflight... Waiting for differential migration preflight to complete... Differential migration started successfully, migration ID : a0afb96f-e050-402c-82ad-1f530c7b2608 MigrationId : a0afb96f-e050-402c-82ad-1f530c7b2608 RMPreflightCheck : {Differential migration validation} ReturnCode : 0 RMError : RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 2: Differential migration scheduled successfully----------</maml:title> <dev:code>PS C:\> Start-RMVSphereVMBasedDifferentialMigration -MigrationId "23cb1201-d6ce-4a5b-9bb3-d7e94a4288a7" -ScheduledAt "04/28/2023 18:30" Starting differential migration preflight... Waiting for differential migration preflight to complete... Migration scheduled successfully MigrationId : RMPreflightCheck : {Differential migration validation} ReturnCode : 0 RMError : RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 3: Differential migration started successfully with migration instructions----------</maml:title> <dev:code>PS C:\> Start-RMVSphereVMBasedDifferentialMigration -MigrationId "23cb1201-d6ce-4a5b-9bb3-d7e94a4288a7" -MigrationInstruction "vddk_compression=SKIPZ", "vmtools_instalation_retries=5" Starting differential migration preflight... Waiting for differential migration preflight to complete... Differential migration started successfully, migration ID : 1750bcab-8893-4a92-8e07-4078b5bc99e8 MigrationId : 1750bcab-8893-4a92-8e07-4078b5bc99e8 RMPreflightCheck : {Differential migration validation} ReturnCode : 0 RMError : RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 4: Differential migration failed to start because of preflight errors----------</maml:title> <dev:code>PS C:\> Start-RMVSphereVMBasedDifferentialMigration -MigrationId "123a3594-b80d-49ac-9753-0fd1e2ccb2b8" Starting differential migration preflight... Waiting for differential migration preflight to complete... Preflight Check Error(s) --------------- -------- Differential migration validation Differential Migrations cannot be run because the Target VM is finalized. MigrationId : RMPreflightCheck : {Differential migration validation} ReturnCode : 1 RMError : {RMError} RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 5: Differential migration started with preflight errors ignored----------</maml:title> <dev:code>PS C:\> Start-RMVSphereVMBasedDifferentialMigration -MigrationId "123a3594-b80d-49ac-9753-0fd1e2ccb2b8" -IgnoreValidationErrors $true Starting differential migration preflight... Waiting for differential migration preflight to complete... Preflight Check Error(s) --------------- -------- Differential migration validation Differential Migrations cannot be run because the Target VM is finalized. Differential migration started successfully, migration ID : ed8a2eed-3dce-43f8-90a7-84c9ef37daff MigrationId : ed8a2eed-3dce-43f8-90a7-84c9ef37daff RMPreflightCheck : {Differential migration validation} ReturnCode : 0 RMError : {RMError} RMWarning : OutputData : </dev:code> </command:example> </command:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |