en-US/Start-RMVSphereOSBasedMigration-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-RMVSphereOSBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMVSphereOSBasedMigration</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 a full migration of a given OS based source and the parameters of the cmdlet allows the user to provide various configuration options for the target VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RMVSphereOSBasedMigration</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="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>MountPoint</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="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="tvmvcpuc"> <maml:name>TargetVMVCPUCount</maml:name> <maml:description> <maml:para>Specifies the number of virtual CPUs to be assigned to the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The number of CPUs on the source machine</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 processor cores per socket.</maml:para> </maml:description> <command:parameterValue required="True">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="tvmms"> <maml:name>TargetVMMemorySize</maml:name> <maml:description> <maml:para>Specifies the amount of memory in GiB to be allocated to the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Same as the amount of memory currently allocated to the source machine.</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="dcn"> <maml:name>DatacenterName</maml:name> <maml:description> <maml:para>The name of the datacenter where the target VM will be created.</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="edni"> <maml:name>EnableDestinationNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enable destination network isolation for a windows migration.</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="mnc"> <maml:name>MigrationNetworkConfig</maml:name> <maml:description> <maml:para>Use this parameter to specify the network configuration for each network interface depending on the 'EnableDestinationNetworkIsolation' parameter.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereMigrationNetworkConfiguration</command:parameterValue> <dev:type> <maml:name>RMVSphereDestinationNetworkConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="False" position="Named" aliases="inc"> <maml:name>IsolatedNetworkConfig</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolated network configuration for each network interface depending on the 'EnableDestinationNetworkIsolation' parameter.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereIsolatedNetworkConfiguration</command:parameterValue> <dev:type> <maml:name>RMVSphereIsolatedNetworkConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="nicc"> <maml:name>DestinationNICConfig</maml:name> <maml:description> <maml:para>Specifies the network configuration for each network interface on the target VM.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereDestinationNetworkConfiguration[]</command:parameterValue> <dev:type> <maml:name>RMVSphereDestinationNetworkConfiguration[]</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.</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="True" pipelineInput="False" position="Named" aliases="cln"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Specifies the cluster where the target VM will be created.</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="rpn"> <maml:name>ResourcePoolName</maml:name> <maml:description> <maml:para>Specifies the resource pool that will be assigned to the target VM. The resource pool name can be the complete path with the path separator being "/". The resource pool will be created if it does not exist.</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="fn"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>Specifies the folder name under which the target VM will be created. The folder name can be the complete path with the path separator being "/". The folder will be created if it does not exist.</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="dcln"> <maml:name>DatastoreClusterName</maml:name> <maml:description> <maml:para>Specifies the cluster name of the datastore.</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="dsn"> <maml:name>DatastoreName</maml:name> <maml:description> <maml:para>Specifies one or more datastore names depending on the number of disks on the source machine. If the number of datastore names given are less than the number of disks on the source, then the last datastore name will be used for all the remaining disks of the source 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="dpt"> <maml:name>DiskProvisioningType</maml:name> <maml:description> <maml:para>Specifies one or more disk provisioning types applied to the disks. Defaults to disk provisioning type of 'thin'.</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="hv"> <maml:name>HardwareVersion</maml:name> <maml:description> <maml:para>Overrides the VMware Hardware version that the Migration Appliance is leveraging. This option can assist in legacy migration scenarios where older VMware Hardware versions may be required.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</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="rrmsas"> <maml:name>RemoveRMSAgentFromSource</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent from the source.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rrmsat"> <maml:name>RemoveRMSAgentFromTarget</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent from the source.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mi"> <maml:name>MigrationInstructions</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="uosv"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies the new value for upgrade os version.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationError</maml:name> <maml:description> <maml:para>Indicates whether to ignore any preflight errors that may occur.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" pipelineInput="False" position="Named" aliases="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="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>MountPoint</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="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="tvmvcpuc"> <maml:name>TargetVMVCPUCount</maml:name> <maml:description> <maml:para>Specifies the number of virtual CPUs to be assigned to the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The number of CPUs on the source machine</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 processor cores per socket.</maml:para> </maml:description> <command:parameterValue required="True">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="tvmms"> <maml:name>TargetVMMemorySize</maml:name> <maml:description> <maml:para>Specifies the amount of memory in GiB to be allocated to the target VM.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Same as the amount of memory currently allocated to the source machine.</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="dcn"> <maml:name>DatacenterName</maml:name> <maml:description> <maml:para>The name of the datacenter where the target VM will be created.</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="edni"> <maml:name>EnableDestinationNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enable destination network isolation for a windows migration.</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="mnc"> <maml:name>MigrationNetworkConfig</maml:name> <maml:description> <maml:para>Use this parameter to specify the network configuration for each network interface depending on the 'EnableDestinationNetworkIsolation' parameter.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereMigrationNetworkConfiguration</command:parameterValue> <dev:type> <maml:name>RMVSphereDestinationNetworkConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineInput="False" position="Named" aliases="inc"> <maml:name>IsolatedNetworkConfig</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolated network configuration for each network interface depending on the 'EnableDestinationNetworkIsolation' parameter.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereIsolatedNetworkConfiguration</command:parameterValue> <dev:type> <maml:name>RMVSphereIsolatedNetworkConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="nicc"> <maml:name>DestinationNICConfig</maml:name> <maml:description> <maml:para>Specifies the network configuration for each network interface on the target VM.</maml:para> </maml:description> <command:parameterValue required="True">RMVSphereDestinationNetworkConfiguration[]</command:parameterValue> <dev:type> <maml:name>RMVSphereDestinationNetworkConfiguration[]</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.</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="True" pipelineInput="False" position="Named" aliases="cln"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Specifies the cluster where the target VM will be created.</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="rpn"> <maml:name>ResourcePoolName</maml:name> <maml:description> <maml:para>Specifies the resource pool that will be assigned to the target VM. The resource pool name can be the complete path with the path separator being "/". The resource pool will be created if it does not exist.</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="fn"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>Specifies the folder name under which the target VM will be created. The folder name can be the complete path with the path separator being "/". The folder will be created if it does not exist.</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="dcln"> <maml:name>DatastoreClusterName</maml:name> <maml:description> <maml:para>Specifies the cluster name of the datastore.</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="dsn"> <maml:name>DatastoreName</maml:name> <maml:description> <maml:para>Specifies one or more datastore names depending on the number of disks on the source machine. If the number of datastore names given are less than the number of disks on the source, then the last datastore name will be used for all the remaining disks of the source 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="dpt"> <maml:name>DiskProvisioningType</maml:name> <maml:description> <maml:para>Specifies one or more disk provisioning types applied to the disks. Defaults to disk provisioning type of 'thin'.</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="hv"> <maml:name>HardwareVersion</maml:name> <maml:description> <maml:para>Overrides the VMware Hardware version that the Migration Appliance is leveraging. This option can assist in legacy migration scenarios where older VMware Hardware versions may be required.</maml:para> </maml:description> <command:parameterValue required="True">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</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="rrmsas"> <maml:name>RemoveRMSAgentFromSource</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent from the source.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rrmsat"> <maml:name>RemoveRMSAgentFromTarget</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent from the source.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mi"> <maml:name>MigrationInstructions</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="uosv"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies the new value for upgrade os version.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationError</maml:name> <maml:description> <maml:para>Indicates whether to ignore any preflight errors that may occur.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet goes into the interactive mode when no parameters are given.</maml:para> <maml:para>When at least one parameter is specified, the cmdlet runs in the non-interactive mode and validates that all<linebreak/> the required parameters are given.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RMVSphereMigrationNetworkConfiguration</maml:name> </dev:type> <maml:description> <maml:para>Provides options for specifying the migration network interface configuration.</maml:para> <maml:para> RMVSphereMigrationNetworkConfiguration [string] $MigrationNetworkName [string] $IPType [string] $IPAddress [string] $Netmask [string] $DefaultGateway [string] $PrimaryDNS [string] $SecondaryDNS RMVSphereMigrationNetworkConfiguration.MigrationNetworkName - If the network is under a Distributed Virtual<linebreak/> (DV) switch, then the it can be specified as "DV switch name/network name", otherwise just specify the<linebreak/> destination network name. RMVSphereMigrationNetworkConfiguration.IPType - valid values are "static" and "DHCP". </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RMVSphereIsolatedNetworkConfiguration</maml:name> </dev:type> <maml:description> <maml:para>Provides options for specifying the isolated network interface configuration.</maml:para> <maml:para> RMVSphereIsolatedNetworkConfiguration [string] $IsolatedNetworkName [string] $IPType [string] $IPAddress [string] $Netmask [string] $DefaultGateway [string] $PrimaryDNS [string] $SecondaryDNS RMVSphereIsolatedNetworkConfiguration.IsolatedNetworkName - If the network is under a Distributed Virtual<linebreak/> (DV) switch, then the it can be specified as "DV switch name/network name", otherwise just specify the<linebreak/> destination network name. RMVSphereIsolatedNetworkConfiguration.IPType - valid values are "static" and "DHCP". </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RMVSphereDestinationNetworkConfiguration[]</maml:name> </dev:type> <maml:description> <maml:para>Provides options for specifying the destination network interface configuration.</maml:para> <maml:para> RMVSphereDestinationNetworkConfiguration [String] $DestinationNetworkName [String] $IPType [String] $IPAddress [String] $Netmask [String] $DefaultGateway [String] $PrimaryDNS [String] $SecondaryDNS RMVSphereDestinationNetworkConfiguration.DestinationNetworkName - If the network is under a Distributed Virtual<linebreak/> (DV) switch, then the it can be specified as "DV switch name/network name", otherwise just specify the<linebreak/> destination network name. RMVSphereDestinationNetworkConfiguration.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: Full migration started successfully----------</maml:title> <dev:code> PS C:\> $nic0 = @{DestinationNetworkName = "HP Cluster dvSwitch/VM Traffic - 3 x 1Gbit"; IPType = "dhcp"} PS C:\> Start-RMVSPhereOSBasedMigration -tc "demo_vsphere_vm_ca" -sip 10.10.2.27 -tvmn "vsphere-shell-tgt-4" -tm "file-based" -tvmvcpuc 2 -cps 2 -tvmms 2 -dcn "NUC3 DC" -edni $false -nicc @([RMVSphereDestinationNetworkConfiguration]::new("VM Network", "dhcp")) -dadnsrot $false -cln "NUC3 Cluster" -fn "RiverMeadow/Najeeb" -dsn @("datastore","datastore") -dpt @("thin","thin") -hv 11 -ss $false -st $false -rrmsas $false -rrmsat $false 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:example> <maml:title>----------Example 2: Full migration started with multiple network interfaces and using disk provisioning type----------</maml:title> <dev:code>PS C:\> $nic0 = @{DestinationNetworkName = "HP Cluster dvSwitch/VM Traffic - 3 x 1Gbit"; IPType = "dhcp"} PS C:\> $nic1 = @{DestinationNetworkName = "VM Network"; IPType = "static"; IPAddress = "10.10.8.12"; Netmask = "255.255.0.0"; DefaultGateway = "10.10.0.254"; PrimaryDNS = "4.4.4.4"; SecondaryDNS = "8.8.8.8"} PS C:\> Start-RMVSphereVMBasedMigration -sip 10.10.2.27 -tvmn "Demo-Target-VM" -tvmvcpuc 4 -cps 2 -dcn "Toronto Datacenter" -nicc $nic0, $nic1 -pmaca $true -cln "HP Cluster" -fn RiverMeadow/Najeeb -dsn hp1-lun3-raid1-1TB -dpt "thin" -ut $true -hv 15 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 : 3fc1517e-bd54-4dbd-a9f0-9a0f1cba27f0 MigrationId : 3fc1517e-bd54-4dbd-a9f0-9a0f1cba27f0 RMPreflightCheck : {Conflicting Migration Attempts, source_guest_customization_check, source_disks_present_check, source_nics_present_check...} ReturnCode : 0 RMError : RMWarning : OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 3: Full migration started with preflight errors ignored----------</maml:title> <dev:code>PS C:\> $nic0 = @{DestinationNetworkName = "HP Cluster dvSwitch/VM Traffic - 3 x 1Gbit"; IPType = "dhcp"} PS C:\> Start-RMVSphereVMBasedMigration -SourceIP 10.10.0.27 -TargetVMName "Demo-Target-VM" -TargetVMVCPUCount 4 -CoresPerSocket 2 -DatacenterName "Toronto Datacenter" -DestinationNICConfig $nic0 -ClusterName "HP Cluster" -FolderName RiverMeadow/Najeeb -DatastoreName hp1-lun3-raid1-1TB -DiskProvisioningType "thin" -UpgradeTools $true -HardwareVersion 15 -IgnoreValidationErrors $true Starting target inventory... Waiting for target inventory 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 : 0 RMError : {RMError} RMWarning : {RMWarning} OutputData : </dev:code> </command:example> </command:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |