en-US/Start-RMOpenshiftVMBasedMigration-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-RMOpenshiftVMBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMOpenshiftVMBasedMigration</command:noun> <maml:description> <maml:para>Starts a workload migration for a VM-based source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a workload migration for a VM-based source. Modifying the parameters of this cmdlet allows the user to configure the target VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMOpenshiftVMBasedMigration</maml:name> <command:parameter required="True" pipelineInput="False" position="Named" aliases="tc"> <maml:name>TargetCloud</maml:name> <maml:description> <maml:para>Specifies the appliance name of the cloud 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="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="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="False">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="True" pipelineInput="False" position="Named" aliases="prj"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the project name for 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="True" pipelineInput="False" position="Named" aliases="instty"> <maml:name>InstanceType</maml:name> <maml:description> <maml:para>Specifies the name of the Instance type to be used for 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="ram"> <maml:name>RAM</maml:name> <maml:description> <maml:para>Specifies the amount of memory to be allocated for the target machine.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sckts"> <maml:name>Sockets</maml:name> <maml:description> <maml:para>Specifies the number of processor sockets.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="crs"> <maml:name>Cores</maml:name> <maml:description> <maml:para>Specifies the number of processor cores.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="sc"> <maml:name>StorageClass</maml:name> <maml:description> <maml:para>Specifies the type of storage to be used for 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="True" pipelineInput="False" position="Named" aliases="am"> <maml:name>AccessMode</maml:name> <maml:description> <maml:para>Specifies the access mode (Single user (RWO)", "Shared access (RWX)", "Read only (ROX)) of the target machine</maml:para> </maml:description> <command:parameterValue required="True">Bool</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="nam"> <maml:name>VolumeMode</maml:name> <maml:description> <maml:para>Specifies the volume mode (Filesystem, Block) 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="True" pipelineInput="False" position="Named" aliases="nam"> <maml:name>NetworkAdapterModel</maml:name> <maml:description> <maml:para>Specifies the network adapter model (virtio, E1000E) 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="True" pipelineInput="False" position="Named" aliases="nat"> <maml:name>NetworkAdaptersType</maml:name> <maml:description> <maml:para>Specifies the network adapter type (Masquerade, Bridge) 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="True" pipelineInput="False" position="Named" aliases="dnn"> <maml:name>DestinationNetworkName</maml:name> <maml:description> <maml:para>Specifies a destination network name for the target machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</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="me"> <maml:name>MigrationExtension</maml:name> <maml:description> <maml:para>Specifies the post migration binary asset uploaded to RiverMeadow as a migration extension.</maml:para> </maml:description> <command:parameterValue required="False">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: There is no ability to perform workload delta migration (sync or changes) after shutdown. Any data that is changed during the migration and which is not part of the snapshot will not be migrated. The source will be shut down before target is finalized and inspected.</maml:para> </maml:description> <command:parameterValue required="False">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="False">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="False">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="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 workload delta migration can be run if this is set to true</maml:para> </maml:description> <command:parameterValue required="False">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 appliance name of the cloud 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="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="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="False">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="True" pipelineInput="False" position="Named" aliases="prj"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the project name for 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="True" pipelineInput="False" position="Named" aliases="instty"> <maml:name>InstanceType</maml:name> <maml:description> <maml:para>Specifies the name of the Instance type to be used for 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="ram"> <maml:name>RAM</maml:name> <maml:description> <maml:para>Specifies the amount of memory to be allocated for the target machine.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sckts"> <maml:name>Sockets</maml:name> <maml:description> <maml:para>Specifies the number of processor sockets.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="crs"> <maml:name>Cores</maml:name> <maml:description> <maml:para>Specifies the number of processor cores.</maml:para> </maml:description> <command:parameterValue required="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="sc"> <maml:name>StorageClass</maml:name> <maml:description> <maml:para>Specifies the type of storage to be used for 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="True" pipelineInput="False" position="Named" aliases="am"> <maml:name>AccessMode</maml:name> <maml:description> <maml:para>Specifies the access mode (Single user (RWO)", "Shared access (RWX)", "Read only (ROX)) of the target machine</maml:para> </maml:description> <command:parameterValue required="True">Bool</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="nam"> <maml:name>VolumeMode</maml:name> <maml:description> <maml:para>Specifies the volume mode (Filesystem, Block) 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="True" pipelineInput="False" position="Named" aliases="nam"> <maml:name>NetworkAdapterModel</maml:name> <maml:description> <maml:para>Specifies the network adapter model (virtio, E1000E) 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="True" pipelineInput="False" position="Named" aliases="nat"> <maml:name>NetworkAdaptersType</maml:name> <maml:description> <maml:para>Specifies the network adapter type (Masquerade, Bridge) 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="True" pipelineInput="False" position="Named" aliases="dnn"> <maml:name>DestinationNetworkName</maml:name> <maml:description> <maml:para>Specifies a destination network name for the target machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</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="me"> <maml:name>MigrationExtension</maml:name> <maml:description> <maml:para>Specifies the post migration binary asset uploaded to RiverMeadow as a migration extension.</maml:para> </maml:description> <command:parameterValue required="False">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: There is no ability to perform workload delta migration (sync or changes) after shutdown. Any data that is changed during the migration and which is not part of the snapshot will not be migrated. The source will be shut down before target is finalized and inspected.</maml:para> </maml:description> <command:parameterValue required="False">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="False">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="False">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="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 workload delta migration can be run if this is set to true</maml:para> </maml:description> <command:parameterValue required="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <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: Workload migration started successfully----------</maml:title> <dev:code>PS C:\> $nic0 = @{DestinationNetworkName = "HP Cluster dvSwitch/VM Traffic - 3 x 1Gbit"; IPType = "dhcp"} PS C:\> Start-RMOpenshiftVMBasedMigration -TargetCloud 'demo-onpeshift' -SourceVMName 'rhel-6' -IgnoreValidationError $true -project default -StorageClass aws-efs-sc -InstanceType cx1.medium -NetworkAdapterModel virtio -NetworkAdaptersType Masquerade -DestinationNetworkName pod -AccessMode 'Single user (RWO)' -VolumeMode Block 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 started successfully, migration ID : e184f461-a8ec-423c-b7a0-49be063795fd MigrationId : e184f461-a8ec-423c-b7a0-49be063795fd 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 2: Workload migration scheduled successfully and using parameter aliases----------</maml:title> <dev:code>PS C:\> $nic0 = @{DestinationNetworkName = "HP Cluster dvSwitch/VM Traffic - 3 x 1Gbit"; IPType = "dhcp"} PS C:\> Start-RMOpenshiftVMBasedMigration -TargetCloud 'demo-onpeshift' -SourceVMName 'rhel-6' -IgnoreValidationError $true -project default -StorageClass aws-efs-sc -InstanceType cx1.medium -NetworkAdapterModel virtio -NetworkAdaptersType Masquerade -DestinationNetworkName pod -AccessMode 'Single user (RWO)' -VolumeMode Block -MigrationExtension test -ShutdownSource $true -ShutdownTarget $true -MigrationInstruction asd=asd -FinalizeMigration $true 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:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |