en-US/Start-RMHPEVMEVMBasedMigration-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-RMHPEVMEVMBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMHPEVMEVMBasedMigration</command:noun> <maml:description> <maml:para>Starts a workload migration for a VM-based source to HPE VME</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-RMHPEVMEVMBasedMigration</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="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="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 name of the target VM. If it is not provided, the source VM name will 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="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="True" pipelineInput="False" position="Named" aliases="grp"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the HPE VME group to which the target VM will 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="cld"> <maml:name>Cloud</maml:name> <maml:description> <maml:para>Specifies the name of the HPE VME cloud, within the selected group, to which the target VM will 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="clstr"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the name of the cluster, within the selected cloud, to which the target VM will 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="hn"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Specifies the name of the host, within the selected cluster, on which the target VM will be placed.</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="dtstr"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastores, within the selected cluster, to be used for the target VM disks. A datastore must be provided for each disk on the source.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="lyt"> <maml:name>Layout</maml:name> <maml:description> <maml:para>Specifies the name of the instance type layout to be used for the target VM.</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="rpl"> <maml:name>ResourcePool</maml:name> <maml:description> <maml:para>Specifies the name of the resource pool, within the selected layout, to be used for the target VM.</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="pln"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specifies the name of the plan to be used for the target VM.</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="cps"> <maml:name>CoresPerSocket</maml:name> <maml:description> <maml:para>Specifies the number of cores per socket for the target VM.</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="mem"> <maml:name>Memory</maml:name> <maml:description> <maml:para>Specifies the amount of memory, in GB, for the target VM. Must be within the range supported by the selected plan.</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="crs"> <maml:name>Cores</maml:name> <maml:description> <maml:para>Specifies the number of processor cores for the target VM. Must be within the range supported by the selected plan.</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="dnic"> <maml:name>DestinationNICConfig</maml:name> <maml:description> <maml:para>Specifies the destination network interface configuration of the target VM. Use the following format to provide an array of RMHPEVMEDestinationNetworkConfiguration objects. Ex: [RMHPEVMEDestinationNetworkConfiguration]::new("network1", "static")</maml:para> </maml:description> <command:parameterValue required="True">RMHPEVMEDestinationNetworkConfiguration[]</command:parameterValue> <dev:type> <maml:name>RMHPEVMEDestinationNetworkConfiguration[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ucnc"> <maml:name>UseCustomNetworkConfig</maml:name> <maml:description> <maml:para>Specifies whether to use a custom network configuration for the target VM. When set to true, DefaultGateway, PrimaryDNS and SecondaryDNS can be provided.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dg"> <maml:name>DefaultGateway</maml:name> <maml:description> <maml:para>Specifies the default gateway for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="pdns"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Specifies the primary DNS server for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sdns"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Specifies the secondary DNS server for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="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="mea"> <maml:name>MigrationExtensionArg</maml:name> <maml:description> <maml:para>Specifies the command line arguments to overwrite for the migration extension.</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: 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="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="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="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="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:parameter required="False" pipelineInput="False" position="Named" aliases="iawsssma"> <maml:name>InstallAWSSSMAgent</maml:name> <maml:description> <maml:para>Enable AWS Systems Manager (SSM) Agent on the target VM.</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="iawscwa"> <maml:name>InstallAWSCloudWatchAgent</maml:name> <maml:description> <maml:para>Enable AWS CloudWatch Agent on the target VM.</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 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="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="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 name of the target VM. If it is not provided, the source VM name will 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="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="True" pipelineInput="False" position="Named" aliases="grp"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the name of the HPE VME group to which the target VM will 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="cld"> <maml:name>Cloud</maml:name> <maml:description> <maml:para>Specifies the name of the HPE VME cloud, within the selected group, to which the target VM will 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="clstr"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the name of the cluster, within the selected cloud, to which the target VM will 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="hn"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Specifies the name of the host, within the selected cluster, on which the target VM will be placed.</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="dtstr"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastores, within the selected cluster, to be used for the target VM disks. A datastore must be provided for each disk on the source.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="lyt"> <maml:name>Layout</maml:name> <maml:description> <maml:para>Specifies the name of the instance type layout to be used for the target VM.</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="rpl"> <maml:name>ResourcePool</maml:name> <maml:description> <maml:para>Specifies the name of the resource pool, within the selected layout, to be used for the target VM.</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="pln"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specifies the name of the plan to be used for the target VM.</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="cps"> <maml:name>CoresPerSocket</maml:name> <maml:description> <maml:para>Specifies the number of cores per socket for the target VM.</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="mem"> <maml:name>Memory</maml:name> <maml:description> <maml:para>Specifies the amount of memory, in GB, for the target VM. Must be within the range supported by the selected plan.</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="crs"> <maml:name>Cores</maml:name> <maml:description> <maml:para>Specifies the number of processor cores for the target VM. Must be within the range supported by the selected plan.</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="dnic"> <maml:name>DestinationNICConfig</maml:name> <maml:description> <maml:para>Specifies the destination network interface configuration of the target VM. Use the following format to provide an array of RMHPEVMEDestinationNetworkConfiguration objects. Ex: [RMHPEVMEDestinationNetworkConfiguration]::new("network1", "static")</maml:para> </maml:description> <command:parameterValue required="True">RMHPEVMEDestinationNetworkConfiguration[]</command:parameterValue> <dev:type> <maml:name>RMHPEVMEDestinationNetworkConfiguration[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ucnc"> <maml:name>UseCustomNetworkConfig</maml:name> <maml:description> <maml:para>Specifies whether to use a custom network configuration for the target VM. When set to true, DefaultGateway, PrimaryDNS and SecondaryDNS can be provided.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dg"> <maml:name>DefaultGateway</maml:name> <maml:description> <maml:para>Specifies the default gateway for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="pdns"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Specifies the primary DNS server for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sdns"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Specifies the secondary DNS server for the target VM. Applicable when UseCustomNetworkConfig is true.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="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="mea"> <maml:name>MigrationExtensionArg</maml:name> <maml:description> <maml:para>Specifies the command line arguments to overwrite for the migration extension.</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: 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="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="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="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="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:parameter required="False" pipelineInput="False" position="Named" aliases="iawsssma"> <maml:name>InstallAWSSSMAgent</maml:name> <maml:description> <maml:para>Enable AWS Systems Manager (SSM) Agent on the target VM.</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="iawscwa"> <maml:name>InstallAWSCloudWatchAgent</maml:name> <maml:description> <maml:para>Enable AWS CloudWatch Agent on the target VM.</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:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet runs in the non-interactive mode and validates that all the required parameters are given.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RMHPEVMEDestinationNetworkConfiguration[]</maml:name> </dev:type> <maml:description> <maml:para>Provides options for specifying the destination network interface configuration.</maml:para> <maml:para> RMHPEVMEDestinationNetworkConfiguration [String] $DestinationNetworkName [String] $IPType [String] $IPAddress [String] $Netmask RMHPEVMEDestinationNetworkConfiguration.IPType - valid values are "static" and "DHCP". </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: Workload migration started successfully----------</maml:title> <dev:code> PS C:\> Start-RMHPEVMEVMBasedMigration -TargetCloud 'hpe-vme-cloud' -SourceVMName 'rhel-9' -TargetVMName 'hpe-tgt-rhel' -Group 'Group1' -Cloud 'Cloud1' -Cluster 'Cluster1' -Datastore @('datastore1') -Layout 'Layout1' -ResourcePool 'Pool1' -Plan 'Plan1' 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 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:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |