en-US/Start-RMAWSOSBasedMigration-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-RMAWSOSBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMAWSOSBasedMigration</command:noun> <maml:description> <maml:para>Starts a full migration of a OS based source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts an OS-based full migration for a given source, applying the parameters provided to configure the target machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMAWSOSBasedMigration</maml:name> <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="True" pipelineInput="False" position="Named" aliases="sip"> <maml:name>SourceIP</maml:name> <maml:description> <maml:para>Specifies the IP address 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="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="mp"> <maml:name>SelectedMount</maml:name> <maml:description> <maml:para>Specifies the mount point 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>Points of all the source mount point.</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="det"> <maml:name>DiskEncryptionType</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="rmp"> <maml:name>ResizeMountPoint</maml:name> <maml:description> <maml:para>Specifies the value to resize the mount point 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>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) to be used for 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="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>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="vpc"> <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>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sid"> <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>None</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">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="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="False" pipelineInput="False" position="Named" aliases="t"> <maml:name>Tenancy</maml:name> <maml:description> <maml:para>Specifies which tenancy, shared or dedicated host, 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="True" pipelineInput="False" position="Named" aliases="it"> <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="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="scami"> <maml:name>ShouldCreateAMI</maml:name> <maml:description> <maml:para>Use this option to create an AMI from the target instance. The name format will include the target instance name and the RiverMeadow UUID, i.e. "{TargetInstanceName}-{UUID} - AMI". Choosing this option may increase migration time.</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="itg"> <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="usqls"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies OS version the target will be upgraded 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>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="me"> <maml:name>MigrationExtension</maml:name> <maml:description> <maml:para>Specifies whether to use a migration extension 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="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 to remove the RMS agent after the 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="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>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: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="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="True" pipelineInput="False" position="Named" aliases="sip"> <maml:name>SourceIP</maml:name> <maml:description> <maml:para>Specifies the IP address 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="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="sat"> <maml:name>SelectedMount</maml:name> <maml:description> <maml:para>Specifies the mount point 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>Points of all the source mount point.</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="det"> <maml:name>DiskEncryptionType</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="rmp"> <maml:name>ResizeMountPoint</maml:name> <maml:description> <maml:para>Specifies the value to resize the mount point 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>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) to be used for 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="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>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="vpc"> <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>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sid"> <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>None</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">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="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="False" pipelineInput="False" position="Named" aliases="t"> <maml:name>Tenancy</maml:name> <maml:description> <maml:para>Specifies which tenancy, shared or dedicated host, 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="True" pipelineInput="False" position="Named" aliases="it"> <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="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="scami"> <maml:name>ShouldCreateAMI</maml:name> <maml:description> <maml:para>Use this option to create an AMI from the target instance. The name format will include the target instance name and the RiverMeadow UUID, i.e. "{TargetInstanceName}-{UUID} - AMI". Choosing this option may increase migration time.</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="itg"> <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="uosv"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies OS version the target will be upgraded 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>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="me"> <maml:name>MigrationExtension</maml:name> <maml:description> <maml:para>Specifies whether to use a migration extension 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="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 to remove the RMS agent after the 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="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>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: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... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. Starting migration preflight... Waiting for migration preflight to complete... Migration started successfully, migration ID : 44f052c9-2cbe-41e4-a16e-241ce55f8e39 MigrationId : 44f052c9-2cbe-41e4-a16e-241ce55f8e39 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 started successfully with migration instructions----------</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 -mi @('ami_name_override=RiverMeadow Target Worker Linux 64-bit - 0.116.6379 - HVM') Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. Starting migration preflight... Waiting for migration preflight to complete... Migration started successfully, migration ID : 44f052c9-2cbe-41e4-a16e-241ce55f8e39 MigrationId : 44f052c9-2cbe-41e4-a16e-241ce55f8e39 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 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' -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 -mi @('ami_name_override=RiverMeadow Target Worker Linux 64-bit - 0.116.6379 - HVM') Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. 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. Migration started successfully, migration ID : 0e401d37-0c6e-4aa5-b 3c-dd636fcbb8ba MigrationId : 0e401d37-0c6e-4aa5-bb3c-dd636fcbb8ba 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> |