en-US/Start-RMAWSVMBasedMigration-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-RMAWSVMBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMAWSVMBasedMigration</command:noun> <maml:description> <maml:para>Starts a full migration of a VM based source to AWS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a full migration of a given VM based source and the parameters of the cmdlet allows the user to provide various configuration options for the target VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMAWSVMBasedMigration</maml:name> <command:parameter required="True" pipelineInput="False" position="Named" aliases="svmn"> <maml:name>SourceVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the source machine to be migrated.</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="svmfp"> <maml:name>SourceVMFolderPath</maml:name> <maml:description> <maml:para>Specifies the VM folder name of the source machine to be migrated.</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="True" pipelineInput="False" position="Named" aliases="tc"> <maml:name>TargetCloud</maml:name> <maml:description> <maml:para>Specifies the name of the migration appliance to be used.</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="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="tvmn"> <maml:name>TargetVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SourceVMName</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sdl"> <maml:name>SelectedDiskLabel</maml:name> <maml:description> <maml:para>Specifies the labels of the disks that you want to migrate.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Labels of all the source disks.</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="eav"> <maml:name>EncryptAllVolume</maml:name> <maml:description> <maml:para>Indicates whether to encrypt volume.</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="et"> <maml:name>EncryptionKeyType</maml:name> <maml:description> <maml:para>The encryption key type that will be used to encrypt the disk. E.g., "platform-managed-key" or "customer-managed-key".</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="kmskan"> <maml:name>KMSKeyAliasName</maml:name> <maml:description> <maml:para>For customer-managed-key encryption types, use this parameter to specify KMS key alias name.</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="True" pipelineInput="False" position="Named" aliases="vt"> <maml:name>VolumeType</maml:name> <maml:description> <maml:para>The volume type: General Purpose (SSD), Provisioned IOPS (SSD), and Magnetic. Default for instances is Magnetic.</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="IOPS"> <maml:name>IOPS</maml:name> <maml:description> <maml:para>The number of I/O operations per second (IOPS) to provision for a volume, with a maximum ratio of 30 IOPS/GiB.</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="rgn"> <maml:name>Region</maml:name> <maml:description> <maml:para>Specifies the region to migrate to.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Region of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="vid"> <maml:name>VPCID</maml:name> <maml:description> <maml:para>Specifies the ID of the VPC to use in the migration.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VPCID of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="snid"> <maml:name>SubnetID</maml:name> <maml:description> <maml:para>Specifies the ID of the subnet to use in the migration.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SubnetID of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="apip"> <maml:name>AssignPublicIP</maml:name> <maml:description> <maml:para>Indicates whether to automatically assign a public IP address.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Use-subnet-setting</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="spip"> <maml:name>StaticPrivateIP</maml:name> <maml:description> <maml:para>Specifies a new value for a static private IP.</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="True" pipelineInput="False" position="Named" aliases="instty"> <maml:name>InstanceType</maml:name> <maml:description> <maml:para>Specifies the instance type of the target machine.</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="etni"> <maml:name>EnforceTargetNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enforce target network isolation on the target. Defaults 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="sg"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Specifies the security group to use in the migration.</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="dtdnsr"> <maml:name>DisableTargetDNSRegistration</maml:name> <maml:description> <maml:para>Indicates whether to disable automatic DNS registration on the target for windows machine. Windows Only.</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="iamr"> <maml:name>IAMRole</maml:name> <maml:description> <maml:para>Specifies the IAM role to use in the migration.</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="cami"> <maml:name>CreateAMI</maml:name> <maml:description> <maml:para>Indicates whether to create an AMI.</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="insttg"> <maml:name>InstanceTag</maml:name> <maml:description> <maml:para>Specifies the instance tags for the 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="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="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 differential migration 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="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies special instructions for running a 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="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</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="True" pipelineInput="False" position="Named" aliases="svmn"> <maml:name>SourceVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the source machine to be migrated.</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="svmfp"> <maml:name>SourceVMFolderPath</maml:name> <maml:description> <maml:para>Specifies the VM folder name of the source machine to be migrated.</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="True" pipelineInput="False" position="Named" aliases="tc"> <maml:name>TargetCloud</maml:name> <maml:description> <maml:para>Specifies the name of the migration appliance to be used.</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="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="tvmn"> <maml:name>TargetVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SourceVMName</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sdl"> <maml:name>SelectedDiskLabel</maml:name> <maml:description> <maml:para>Specifies the labels of the disks that you want to migrate.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Labels of all the source disks.</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="eav"> <maml:name>EncryptAllVolume</maml:name> <maml:description> <maml:para>Indicates whether to encrypt volume.</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="et"> <maml:name>EncryptionKeyType</maml:name> <maml:description> <maml:para>The encryption key type that will be used to encrypt the disk. E.g., "platform-managed-key" or "customer-managed-key".</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="kmskan"> <maml:name>KMSKeyAliasName</maml:name> <maml:description> <maml:para>For customer-managed-key encryption types, use this parameter to specify KMS key alias name.</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="True" pipelineInput="False" position="Named" aliases="vt"> <maml:name>VolumeType</maml:name> <maml:description> <maml:para>The volume type: General Purpose (SSD), Provisioned IOPS (SSD), and Magnetic. Default for instances is Magnetic.</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="IOPS"> <maml:name>IOPS</maml:name> <maml:description> <maml:para>The number of I/O operations per second (IOPS) to provision for a volume, with a maximum ratio of 30 IOPS/GiB.</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="rgn"> <maml:name>Region</maml:name> <maml:description> <maml:para>Specifies the region to migrate to.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Region of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="vid"> <maml:name>VPCID</maml:name> <maml:description> <maml:para>Specifies the ID of the VPC to use in the migration.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VPCID of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="snid"> <maml:name>SubnetID</maml:name> <maml:description> <maml:para>Specifies the ID of the subnet to use in the migration.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SubnetID of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="apip"> <maml:name>AssignPublicIP</maml:name> <maml:description> <maml:para>Indicates whether to automatically assign a public IP address.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Use-subnet-setting</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="spip"> <maml:name>StaticPrivateIP</maml:name> <maml:description> <maml:para>Specifies a new value for a static private IP.</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="True" pipelineInput="False" position="Named" aliases="instty"> <maml:name>InstanceType</maml:name> <maml:description> <maml:para>Specifies the instance type of the target machine.</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="etni"> <maml:name>EnforceTargetNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enforce target network isolation on the target. Defaults 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="sg"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Specifies the security group to use in the migration.</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="dtdnsr"> <maml:name>DisableTargetDNSRegistration</maml:name> <maml:description> <maml:para>Indicates whether to disable automatic DNS registration on the target for windows machine. Windows Only.</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="iamr"> <maml:name>IAMRole</maml:name> <maml:description> <maml:para>Specifies the IAM role to use in the migration.</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="cami"> <maml:name>CreateAMI</maml:name> <maml:description> <maml:para>Indicates whether to create an AMI.</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="insttg"> <maml:name>InstanceTag</maml:name> <maml:description> <maml:para>Specifies the instance tags for the 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="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="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 differential migration 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="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies special instructions for running a 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="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</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<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: Full migration started successfully----------</maml:title> <dev:code>PS C:\> Start-RMAWSOSBasedMigration -tc 'demo_aws_vm_ca' -sip 10.10.2.27 -ekt 'customer-managed-key' -vt 'GP3' -rgn 'us-east-2' -vpc 'vpc-0a0d3514f52d341e1' -sid 'subnet-0cfcc6f0f4a58f6a7' -aaip $false -etni $true -it t2.large Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Starting migration preflight... Waiting for migration preflight to complete... Migration started successfully, migration ID : befb8287-ff23-4d70-81e1-bdafb7570f9a MigrationId : befb8287-ff23-4d70-81e1-bdafb7570f9a RMPreflightCheck : {source_attributes_check, Conflicting Migration Attempts, source_transfer_ports_check, source_hyper_v_check…} ReturnCode : 0 RMError : RMWarning : {RMWarning} OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 2: Full migration scheduled successfully and using parameter aliases----------</maml:title> <dev:code>PS C:\> Start-RMAWSOSBasedMigration -tc 'demo_aws_vm_ca' -tvmn "Demo-Target-VM" -sat "05/15/2023 20:30" -sip 10.10.2.27 -ekt 'customer-managed-key' -vt 'GP3' -rgn 'us-east-2' -vpc 'vpc-0a0d3514f52d341e1' -sid 'subnet-0cfcc6f0f4a58f6a7' -aaip $false -etni $true -it t2.large Starting target inventory... Waiting for target inventory to complete... Starting source preflight... Waiting for source preflight to complete... Starting migration preflight... Waiting for migration preflight to complete... Migration scheduled successfully MigrationId : RMPreflightCheck : {Conflicting Migration Attempts, source_guest_customization_check, source_disks_present_check, source_nics_present_check...} ReturnCode : 0 RMError : RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 3: Failed to start migration because of preflight error----------</maml:title> <dev:code>PS C:\> Start-RMAWSOSBasedMigration -tc 'demo_aws_vm_ca' -tvmn "Demo-Target-VM" -sat "05/15/2023 20:30" -sip 10.10.2.27 -ekt 'customer-managed-key' -vt 'GP3' -rgn 'us-east-2' -vpc 'vpc-0a0d3514f52d341e1' -sid 'subnet-0cfcc6f0f4a58f6a7' -aaip $false -etni $true -it t2.large Starting target inventory... Waiting for target inventory to complete... Starting source preflight... Waiting for source preflight to complete... Starting migration preflight... Waiting for migration preflight to complete... Preflight Check Error(s) --------------- -------- Migration readiness validation A VM named 'Demo-Target-VM' already exists in the selected destination folder. MigrationId : RMPreflightCheck : {Conflicting Migration Attempts, source_guest_customization_check, source_disks_present_check, source_nics_present_check...} ReturnCode : 1 RMError : {RMError} RMWarning : {RMWarning} OutputData : </dev:code> </command:example> </command:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |