en-US/Start-RMGCPOSBasedMigration-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-RMGCPOSBasedMigration</command:name> <command:verb>Start</command:verb> <command:noun>RMGCPOSBasedMigration</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-RMGCPOSBasedMigration</maml:name> <command:parameter required="True" pipelineInput="False" position="Named" aliases="tc"> <maml:name>TargetCloud</maml:name> <maml:description> <maml:para>Specifies the name of the migration appliance to be used.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="sip"> <maml:name>SourceIP</maml:name> <maml:description> <maml:para>Specifies the IP address of the source machine to be migrated.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sat"> <maml:name>ScheduledAt</maml:name> <maml:description> <maml:para>Specifies a date and time to start the migration automatically. Format: MM/dd/yyyy HH:mm</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="tvmn"> <maml:name>TargetVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SourceVMName</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mp"> <maml:name>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="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>Project of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rgn"> <maml:name>Region</maml:name> <maml:description> <maml:para>Specifies the region 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>Region of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="zn"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the zone 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>Zone of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mstn"> <maml:name>MigrateToSoleTenantNode</maml:name> <maml:description> <maml:para>Indicates whether to migrate to sole tenant node on the target, defaults to 'false'.</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="ngn"> <maml:name>NodeGroupName</maml:name> <maml:description> <maml:para>Specifies a node group name when migrating to a sole tenant node.</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="mt"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>Specifies the machine type of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="dt"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the disk type (Standard_Persistent, Balanced_Persistent, SSD_Persistent) of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="il"> <maml:name>InstanceLabel</maml:name> <maml:description> <maml:para>Use to create instance labels for the target machine. 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="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">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="sn"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para>Specifies a subnet 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>SubnetName of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="piip"> <maml:name>PrimaryInternalIP</maml:name> <maml:description> <maml:para>Specifies a primary internal IP (Ephemeral-automatic, Ephemeral-custom) for the target machine. Defaults to 'Ephemeral-automatic'.</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="ceipad"> <maml:name>CustomEphemeralIPAddress</maml:name> <maml:description> <maml:para>Specifies a custom ephemeral IP address 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="eip"> <maml:name>ExternalIP</maml:name> <maml:description> <maml:para>The external IP of the target machine. (None, Automatic). Defaults to 'Automatic'.</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="ntr"> <maml:name>NetworkTier</maml:name> <maml:description> <maml:para>The network tier (Premium, Standard) of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dtdnsr"> <maml:name>DisableTargetDNSRegistration</maml:name> <maml:description> <maml:para>Indicates whether to disable automatic DNS registration on the target for windows machine. Windows Only.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dadnsrot"> <maml:name>EnableSerialPortAccess</maml:name> <maml:description> <maml:para>Indicates whether to enable serial port access. Defaults to 'False'.</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="ahttpt"> <maml:name>AllowHTTPTraffic</maml:name> <maml:description> <maml:para>Indicates whether to allow HTTP traffic.</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="ahttpst"> <maml:name>AllowHTTPSTraffic</maml:name> <maml:description> <maml:para>Indicates whether to allow HTTPS traffic.</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="etni"> <maml:name>EnforceTargetNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enforce target network isolation on the target. Defaults to 'True'.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="nt"> <maml:name>NetworkTag</maml:name> <maml:description> <maml:para>Assign Network Tags to apply firewall rules to the VM. The default value is "rivermeadow-tw". For Linux, in some instancese "rivermeadow-agent" will be included.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Automatically shutdown source after data is fully migrated. This option has the following consequences. No ability to perform differential migration (sync or changes) after shutdown, data that changed during migration (and is not part of the snapshot) will not get migrated and source is shut down before target is inspected.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="st"> <maml:name>ShutdownTarget</maml:name> <maml:description> <maml:para>Automatically shutdown target after data is fully migrated.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="OSBYOL"> <maml:name>OSBYOL</maml:name> <maml:description> <maml:para>Indicates whether to enable the bring your own license option.</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="sqll"> <maml:name>SQLLicense</maml:name> <maml:description> <maml:para>Specifies the SQL license for the running 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="uosv"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies the OS version that the target will be upgraded to.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="usqls"> <maml:name>UpgradeSQLServer</maml:name> <maml:description> <maml:para>Specifies the SQL server for the running a migration. Use the following format to provide a hashtable. Ex: @{InstanceName = “ ”;UpgradeVersion = “ "}</maml:para> </maml:description> <command:parameterValue required="True">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rrmsa"> <maml:name>RemoveRMSAgent</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent after the migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies special instructions for running a migration in the format 'key=value'.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationError</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" pipelineInput="False" position="Named" aliases="tc"> <maml:name>TargetCloud</maml:name> <maml:description> <maml:para>Specifies the name of the migration appliance to be used.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="sip"> <maml:name>SourceIP</maml:name> <maml:description> <maml:para>Specifies the IP address of the source machine to be migrated.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="sat"> <maml:name>ScheduledAt</maml:name> <maml:description> <maml:para>Specifies a date and time to start the migration automatically. Format: MM/dd/yyyy HH:mm</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="tvmn"> <maml:name>TargetVMName</maml:name> <maml:description> <maml:para>Specifies the VM name of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SourceVMName</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="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="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>Project of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rgn"> <maml:name>Region</maml:name> <maml:description> <maml:para>Specifies the region 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>Region of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="zn"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the zone 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>Zone of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mstn"> <maml:name>MigrateToSoleTenantNode</maml:name> <maml:description> <maml:para>Indicates whether to migrate to sole tenant node on the target, defaults to 'false'.</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="ngn"> <maml:name>NodeGroupName</maml:name> <maml:description> <maml:para>Specifies a node group name when migrating to a sole tenant node.</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="mt"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>Specifies the machine type of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" pipelineInput="False" position="Named" aliases="dt"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the disk type (Standard_Persistent, Balanced_Persistent, SSD_Persistent) of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="il"> <maml:name>InstanceLabel</maml:name> <maml:description> <maml:para>Use to create instance labels for the target machine. 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="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">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="sn"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para>Specifies a subnet 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>SubnetName of the cloud account</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="piip"> <maml:name>PrimaryInternalIP</maml:name> <maml:description> <maml:para>Specifies a primary internal IP (Ephemeral-automatic, Ephemeral-custom) for the target machine. Defaults to 'Ephemeral-automatic'.</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="ceipad"> <maml:name>CustomEphemeralIPAddress</maml:name> <maml:description> <maml:para>Specifies a custom ephemeral IP address 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="eip"> <maml:name>ExternalIP</maml:name> <maml:description> <maml:para>The external IP of the target machine. (None, Automatic). Defaults to 'Automatic'.</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="ntr"> <maml:name>NetworkTier</maml:name> <maml:description> <maml:para>The network tier (Premium, Standard) of the target machine.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dtdnsr"> <maml:name>DisableTargetDNSRegistration</maml:name> <maml:description> <maml:para>Indicates whether to disable automatic DNS registration on the target for windows machine. Windows Only.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="dadnsrot"> <maml:name>EnableSerialPortAccess</maml:name> <maml:description> <maml:para>Indicates whether to enable serial port access. Defaults to 'False'.</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="ahttpt"> <maml:name>AllowHTTPTraffic</maml:name> <maml:description> <maml:para>Indicates whether to allow HTTP traffic.</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="ahttpst"> <maml:name>AllowHTTPSTraffic</maml:name> <maml:description> <maml:para>Indicates whether to allow HTTPS traffic.</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="etni"> <maml:name>EnforceTargetNetworkIsolation</maml:name> <maml:description> <maml:para>Indicates whether to enforce target network isolation on the target. Defaults to 'True'.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="nt"> <maml:name>NetworkTag</maml:name> <maml:description> <maml:para>Assign Network Tags to apply firewall rules to the VM. The default value is "rivermeadow-tw". For Linux, in some instancese "rivermeadow-agent" will be included.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ss"> <maml:name>ShutdownSource</maml:name> <maml:description> <maml:para>Automatically shutdown source after data is fully migrated. This option has the following consequences. No ability to perform differential migration (sync or changes) after shutdown, data that changed during migration (and is not part of the snapshot) will not get migrated and source is shut down before target is inspected.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="st"> <maml:name>ShutdownTarget</maml:name> <maml:description> <maml:para>Automatically shutdown target after data is fully migrated.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="OSBYOL"> <maml:name>OSBYOL</maml:name> <maml:description> <maml:para>Indicates whether to enable the bring your own license option.</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="sqll"> <maml:name>SQLLicense</maml:name> <maml:description> <maml:para>Specifies the SQL license for the running 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="uosv"> <maml:name>UpgradeOSVersion</maml:name> <maml:description> <maml:para>Specifies the OS version that the target will be upgraded to.</maml:para> </maml:description> <command:parameterValue required="True">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="usqls"> <maml:name>UpgradeSQLServer</maml:name> <maml:description> <maml:para>Specifies the SQL server for the running a migration. Use the following format to provide a hashtable. Ex: @{InstanceName = “ ”;UpgradeVersion = “ "} </maml:para> </maml:description> <command:parameterValue required="True">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="rrmsa"> <maml:name>RemoveRMSAgent</maml:name> <maml:description> <maml:para>Indicates whether to remove the RMS agent after the migration has completed.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mi"> <maml:name>MigrationInstruction</maml:name> <maml:description> <maml:para>Specifies special instructions for running a migration in the format 'key=value'.</maml:para> </maml:description> <command:parameterValue required="True">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="ive"> <maml:name>IgnoreValidationError</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" pipelineInput="False" position="Named" aliases="oem"> <maml:name>OverrideExistingMigration</maml:name> <maml:description> <maml:para>Set this parameter to 'true' when you want to override an existing running migration for the given source machine.</maml:para> </maml:description> <command:parameterValue required="True">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet goes into the interactive mode when no parameters are given.</maml:para> <maml:para>When at least one parameter is specified, the cmdlet runs in the non-interactive mode and validates that all<linebreak/> the required parameters are given.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RMMigrationReturn Object</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a RMMigrationReturn object, which has the following attributes:</maml:para> <maml:para> RMMigrationReturn [String] MigrationId RMPreflightCheck[] [String] Name [String] DisplayName [String] Description [String] Status RMError RMWarning [int] ReturnCode RMError [String] ErrorCode [String] Message [String] Resolution RMWarning [String] ErrorCode [String] Message [String] Resolution [Hashtable] OutputData </maml:para> <maml:para> RMMigrationReturn.ReturnCode = 0, indicates migration started successfully. RMMigrationReturn.ReturnCode = 1, indicates that there was an error in starting the migration. RMMigrationReturn.OutputData, contains any additional data that the cmdlet can return. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> </maml:alertSet> <command:examples> <command:example> <maml:title>----------Example 1: Full migration started successfully----------</maml:title> <dev:code>PS C:\> Start-RMGCPOSBasedMigration -sip 10.10.13.47 -tc demo-gcp-vm-ca -tvmn Demo-Target-VM -mt c2-standard-16 -dt 'Standard_Persistent' -etni $true Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. Starting migration preflight... Waiting for migration preflight to complete... Migration started successfully, migration ID : b3bbe957-c2c2-4438-bff8-768fc04f0d6b MigrationId : b3bbe957-c2c2-4438-bff8-768fc04f0d6b RMPreflightCheck : {source_attributes_check, Conflicting Migration Attempts, source_transfer_ports_check, source_hyper_v_check…} ReturnCode : 0 RMError : RMWarning : {RMWarning} OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 2: Full migration started successfully with migration instructions----------</maml:title> <dev:code>PS C:\> Start-RMGCPOSBasedMigration -sip 10.10.13.47 -tc demo-gcp-vm-ca -tvmn Demo-Target-VM -mt c2-standard-16 -dt 'Standard_Persistent' -mi @('template_override_name=rivermeadow-tw-linux-64--0-117-6448') -etni $true Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. Starting migration preflight... Waiting for migration preflight to complete... Migration started successfully, migration ID : b3bbe957-c2c2-4438-bff8-768fc04f0d6b MigrationId : b3bbe957-c2c2-4438-bff8-768fc04f0d6b RMPreflightCheck : {source_attributes_check, Conflicting Migration Attempts, source_transfer_ports_check, source_hyper_v_check…} ReturnCode : 0 RMError : RMWarning : {RMWarning} OutputData : </dev:code> </command:example> <command:example> <maml:title>----------Example 3: Full migration started with preflight errors ignored----------</maml:title> <dev:code>tart-RMGCPOSBasedMigration -sip 10.10.13.47 -tc demo-gcp-vm-ca -tvmn Demo-Target-VM -mt c2-standard-16 -dt 'Standard_Persistent' -mi @('template_override_name=rivermeadow-tw-linux-64--0-117-6448') -etni $true Starting target cloud attribute collection... Waiting for cloud attribute collection to complete... Starting source preflight... Waiting for source preflight to complete... Preflight Check Warning(s) --------------- ---------- Conflicting Migration Attempts A previous migration attempt was detected on the Source machine. A new migration will be started. Starting migration preflight... Waiting for migration preflight to complete... Preflight Check Error(s) --------------- -------- Migration readiness validation A VM named 'Demo-Target-VM' already exists in the selected destination folder. Migration started successfully, migration ID : 0e401d37-0c6e-4aa5-b 3c-dd636fcbb8ba MigrationId : 0e401d37-0c6e-4aa5-bb3c-dd636fcbb8ba RMPreflightCheck : {Conflicting Migration Attempts, source_guest_customization_check, source_disks_present_check, source_nics_present_check...} ReturnCode : 1 RMError : {RMError} RMWarning : {RMWarning} OutputData : </dev:code> </command:example> </command:examples> </command:command> </helpItems> |