en-US/Start-RMOSBasedDifferentialMigration-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-RMOSBasedDifferentialMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMOSBasedDifferentialMigration</command:noun> <maml:description> <maml:para>Starts a OS based differential migration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts an OS-based differential migration using the provided OS-based full migration ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMOSBasedDifferentialMigration</maml:name> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration for which you want to run differential 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 a date and time to start the migration automatically. Format: MM/dd/yyyy HH:mm</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> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Automatically shutdown source after data is fully migrated. This option has the following consequences. No ability to perform differential migration (sync or changes) after shutdown, data that changed during migration (and is not part of the snapshot) will not get migrated and source is shut down before target is inspected.</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>Automatically shutdown target after data is fully migrated.</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="rrmsa"> <maml:name>RemoveRMSAgent</maml:name> <maml:description> <maml:para>Indicates whether the RMS agent will be removed after the migration completes.</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="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies additional 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>IgnoreValidationError</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:parameter required="False" pipelineInput="False" position="Named" aliases="ump"> <maml:name>UpdateMountPoint</maml:name> <maml:description> <maml:para>Specifies whether to update mount points.</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="usm"> <maml:name>UpdateSelectedMount</maml:name> <maml:description> <maml:para>Contains new data for selected mount.</maml:para> </maml:description> <command:parameterValue required="True">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="usc"> <maml:name>UpdateSourceCredential</maml:name> <maml:description> <maml:para>Specifies whether to update the migration source's credential.</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="sun"> <maml:name>SourceUsername</maml:name> <maml:description> <maml:para>Specifies a new user name for the migration's source.</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="susshpk"> <maml:name>SourceUseSSHPrivateKey</maml:name> <maml:description> <maml:para>Specifies whether to use an ssh private key for the source.</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="spk"> <maml:name>SourcePrivateKey</maml:name> <maml:description> <maml:para>Specifies a new private key for the migration's source. SourcePrivateKey must be True.</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="spp"> <maml:name>SourcePassphrase</maml:name> <maml:description> <maml:para>Specifies a new pass phrase for the migration's source.</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="scpp"> <maml:name>SourceConfirmPassphrase</maml:name> <maml:description> <maml:para>Confirms the new pass phrase for the migration's source.</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="spw"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Specifies a new password for the migration's source.</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="scpw"> <maml:name>SourceConfirmPassword</maml:name> <maml:description> <maml:para>Confirms the new password for the migration's source.</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="sd"> <maml:name>SourceDomain</maml:name> <maml:description> <maml:para>Specifies a new domain for the migration's source.</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="uti"> <maml:name>UpdateTargetInstance</maml:name> <maml:description> <maml:para>Specifies whether to update target instance.</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="tun"> <maml:name>TargetUsername</maml:name> <maml:description> <maml:para>Specifies a new username for the migration's target.</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="tusshpk"> <maml:name>TargetUseSSHPrivateKey</maml:name> <maml:description> <maml:para>Specifies whether to use an ssh private key for the migration's target.</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="tpk"> <maml:name>TargetPrivateKey</maml:name> <maml:description> <maml:para>Specifies a new private key for the migration's target.</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="tpp"> <maml:name>TargetPassphrase</maml:name> <maml:description> <maml:para>Specifies a new pass phrase for the migration's target.</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="tcpp"> <maml:name>TargetConfirmPassphrase</maml:name> <maml:description> <maml:para>Confirms the new pass phrase for the migration's target.</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="tpw"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Specifies a new password for the migration's target.</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="tcpw"> <maml:name>TargetConfirmPassword</maml:name> <maml:description> <maml:para>Confirms the new password for the migration's target.</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="td"> <maml:name>TargetDomain</maml:name> <maml:description> <maml:para>Specifies a new domain for the migration's target.</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="tipa"> <maml:name>TargetIPAddress</maml:name> <maml:description> <maml:para>Specifies a new IP address for the migration's target.</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="tm"> <maml:name>TransferMethod</maml:name> <maml:description> <maml:para>Specifies transfer method (file-based/block-based) for running the differential migrarion.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration for which you want to run differential 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 a date and time to start the migration automatically. Format: MM/dd/yyyy HH:mm</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> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Automatically shutdown source after data is fully migrated. This option has the following consequences. No ability to perform differential migration (sync or changes) after shutdown, data that changed during migration (and is not part of the snapshot) will not get migrated and source is shut down before target is inspected.</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>Automatically shutdown target after data is fully migrated.</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="rrmsa"> <maml:name>RemoveRMSAgent</maml:name> <maml:description> <maml:para>Indicates whether the RMS agent will be removed after the migration completes.</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="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies additional 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>IgnoreValidationError</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:parameter required="False" pipelineInput="False" position="Named" aliases="ump"> <maml:name>UpdateMountPoint</maml:name> <maml:description> <maml:para>Specifies whether to update mount points.</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="usm"> <maml:name>UpdateSelectedMount</maml:name> <maml:description> <maml:para>Contains new data for selected mount.</maml:para> </maml:description> <command:parameterValue required="True">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="usc"> <maml:name>UpdateSourceCredential</maml:name> <maml:description> <maml:para>Specifies whether to update the migration source's credential.</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="sun"> <maml:name>SourceUsername</maml:name> <maml:description> <maml:para>Specifies a new user name for the migration's source.</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="susshpk"> <maml:name>SourceUseSSHPrivateKey</maml:name> <maml:description> <maml:para>Specifies whether to use an ssh private key for the source.</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="spk"> <maml:name>SourcePrivateKey</maml:name> <maml:description> <maml:para>Specifies a new private key for the migration's source. SourcePrivateKey must be True.</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="spp"> <maml:name>SourcePassphrase</maml:name> <maml:description> <maml:para>Specifies a new pass phrase for the migration's source.</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="scpp"> <maml:name>SourceConfirmPassphrase</maml:name> <maml:description> <maml:para>Confirms the new pass phrase for the migration's source.</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="spw"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Specifies a new password for the migration's source.</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="scpw"> <maml:name>SourceConfirmPassword</maml:name> <maml:description> <maml:para>Confirms the new password for the migration's source.</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="sd"> <maml:name>SourceDomain</maml:name> <maml:description> <maml:para>Specifies a new domain for the migration's source.</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="uti"> <maml:name>UpdateTargetInstance</maml:name> <maml:description> <maml:para>Specifies whether to update target instance.</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="tun"> <maml:name>TargetUsername</maml:name> <maml:description> <maml:para>Specifies a new username for the migration's target.</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="tusshpk"> <maml:name>TargetUseSSHPrivateKey</maml:name> <maml:description> <maml:para>Specifies whether to use an ssh private key for the migration's target.</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="tpk"> <maml:name>TargetPrivateKey</maml:name> <maml:description> <maml:para>Specifies a new private key for the migration's target.</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="tpp"> <maml:name>TargetPassphrase</maml:name> <maml:description> <maml:para>Specifies a new pass phrase for the migration's target.</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="tcpp"> <maml:name>TargetConfirmPassphrase</maml:name> <maml:description> <maml:para>Confirms the new pass phrase for the migration's target.</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="tpw"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Specifies a new password for the migration's target.</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="tcpw"> <maml:name>TargetConfirmPassword</maml:name> <maml:description> <maml:para>Confirms the new password for the migration's target.</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="td"> <maml:name>TargetDomain</maml:name> <maml:description> <maml:para>Specifies a new domain for the migration's target.</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="tipa"> <maml:name>TargetIPAddress</maml:name> <maml:description> <maml:para>Specifies a new IP address for the migration's target.</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="tm"> <maml:name>TransferMethod</maml:name> <maml:description> <maml:para>Specifies transfer method (file-based/block-based) for running the differential migrarion.</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: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<linebreak/> 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-RMVSphereOSBasedDifferentialMigration -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 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:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |