When you install the PlateSpin Migrate Client, the installation creates a separate directory for a number of preconfigured jobs (actually, .ini files) that can do the following:
Workload conversion (that is, a migration operation)
Server Sync
Imaging capture and deployment of image target
You execute a job by using the run command at the command line. The values in the files are the optional parameters that run along with the job. Each of these functions has a “default” .ini file version that runs with basic settings, and one or more “platform-specific” .ini file(s) that run with custom settings:
Conversion-Default.ini
Conversion-Windows.ini (customized)
Conversion-Linux.ini (customized)
ServerSync-Default.ini
ServerSync-Windows.ini (customized)
ServerSync-Linux.ini (customized)
CaptureImage-Default.ini
CaptureImage.ini (customized)
DeployImage-Default.ini
DeployImage.ini (customized)
IncrementalImaging-Default.ini
IncrementalImaging.ini (customized)
This section includes more details about these jobs in the following subsections:
The CLI tool supports converting Windows and Linux workloads (source) to vCenter/ESX servers (target). There are two types of .ini files, one for a basic job configuration, and one for custom configurations. While the job is running you can abort the job or check its status.
Before you start a conversion job, make sure you run the discover command on the source computer and then on the target container. The following is example syntax for running the discover command:
discover /machineaddress=10.10.10.10 /username=administrator /password=anything@123 /type=vmware_vcenter
NOTE:Conversions do not support creating new disks and volumes or mapping.
For details about the settings in the conversion jobs, see Conversion Jobs in the CLI appendix of the online PlateSpin Migrate User Guide, online.
The tables in this section are named by the respective conversion jobs .ini files they represent. The table contents include the file section names within the .ini and the available settings you can configure according to your conversion needs:
Table B-2 Details of Conversion-Default.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2V |
{required} This value must be used for every conversion. |
|
[JobConfig] |
|
|
Default=true |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[TargetContainer] |
|
|
Address= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
Password= |
{required} Specify the password credential for the target container. If ESX is discovered via VCenter, specify the vCenter password. |
|
[NewMachine] |
|
|
DisplayName= |
{required} Specify the name you want to display in vCenter or ESX console |
|
HostName= |
{required} |
Table B-3 Details of Conversion-Windows.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2V |
{required} This value must be used for every conversion. |
|
[JobConfig] |
|
|
Default=false |
|
|
[Transfer] |
|
|
TransferType=VSSFileBased/VSSblockBased/FileBased |
Possible settings shown. If the Windows source machine support VSS snapshotting, use the VSS… settings, if it doesn’t support VSS, use the Filebased setting. |
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
EndState=ShutDown/Donothing/Reboot |
Possible settings shown. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (that is, the ESX address or the vCenter address). If ESX is discovered via VCenter, specify the ESX IP. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
Password= |
{required} Specify the password credential for the target container. f ESX is discovered via VCenter, specify the vCenter password. |
|
VirtualNetwork= |
Specify the VMware virtual network name you want to use. |
|
TakeControl=static/dhcp |
Specify static or dhcp, depending on your networking configuration. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[NewMachine] |
|
|
DisplayName= |
{required} Specify the name you want to display in vCenter or ESX console. |
|
DataStore= |
Specify the name of datastore you want to use. |
|
ConfigPath= |
Specify the path to the .vmx file. |
|
Memory= |
Specify the amount of RAM you want for the target computer. The setting can be in MB or GB and must be specified with integers (no decimal values). |
|
InstallTools=true/false |
Possible settings shown. Default is true. |
|
NumberofCPU= |
Specify the number of CPUs you want for the target computer. |
|
HostName= |
{required} Specify the target hostname. |
|
WorkGroup= |
{optional} Specify the workgroup name you want to join. |
|
Domain= |
|
|
DomainUserName= |
|
|
DomainUserPassword= |
|
|
EndState=VMPowerOFF/VMPowerON/VMSuspend |
Possible settings shown. |
|
[EthernetNic1] |
You can repeat this section of the .ini file for every NIC at the target container. For example, the second NIC section would be named [EthernetNic2]. Configuration settings would be specified for each NIC section in the file. |
|
DHCPEnabled=true/false |
|
|
VirtualNetwork= |
Specify the VMware virtual network name you want to use. |
|
Address= |
Specify the IP address for the target machine. |
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[DriveGeneral] |
If you have multiple disks at the source, you can specify them here. You can specify as many disks as there are at the source. |
|
DataStore1= |
|
|
Disk1= |
|
|
DataStore2= |
|
|
Disk2= |
|
|
[Volume1] |
You can repeat this section of the .ini file for every volume at the target container. For example, the second volume section would be named [Volume2]. Configuration settings would be specified for each volume section in the file. |
|
VolumeToCopy= |
Specify the volume to copy to the target. |
|
MapTo= |
Specify the disk to map. |
The sections in the Conversion-Windows.ini and in the Conversion-Linux.ini file are identical, except for the settings in [Transfer] section, along with the settings for workgroup and domain configuration. The differences for the Linux source job are shown in the following table.
Table B-4 Conversion-Linux.ini: Differences in Setting Details of the [Transfer] section
|
File Sections and Default Settings (differences only) |
Comment |
|---|---|
|
[Transfer] |
|
|
TransferType=BlockBased/FileBased |
Possible settings shown. Linux does not support VSS. |
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
The CLI tool supports jobs that prepare a server for synchronization and also the ServerSync operation itself. The prepareForSync CLI command (also a job) prepares the server for the Server Sync operation. Run this command (with applicable parameters) prior to running the ServerSync job (that is, ServerSync-xxx.ini).
The Server Sync operation as run in the CLI tool supports both Windows and Linux workloads on the ESX/vCenter targets. There are two types of .ini files, one for a basic job configuration, and one for custom configurations. While the job is running you can abort the job or check its status. If you specify the required settings, it will start the job. Then, when it runs, the job populates the other values with default settings.
For details about the settings in the serversync jobs, see ServerSync Jobs in the CLI appendix of the PlateSpin Migrate User Guide, online.
The tables in this section are named by the respective serversync jobs .ini files they represent. The table contents include the file section names within the .ini and the available settings you can configure according to your conversion needs:
Table B-5 Details of ServerSync-Default.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2EV |
{required} This value must be used for every Server Sync operation. |
|
[JobConfig] |
|
|
Default=true |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (that is, the ESX address or the vCenter address). If ESX is discovered via VCenter, specify the ESX IP. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
HostName= |
{required} Specify the password credential for the target container. If ESX is discovered via VCenter, specify the vCenter password. |
|
[ExistingTargetMachine] |
|
|
DisplayName= |
{required} |
|
HostName= |
{required} |
Table B-6 Details of ServerSync-Windows.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2EV |
{required} This value must be used for every Server Sync operation. |
|
[JobConfig] |
|
|
Default=false |
|
|
[Transfer] |
|
|
TransferType=VSSFileBased/VSSblockBased/FileBased |
Possible settings shown. If the Windows source machine support VSS snapshotting, use the VSS… settings, if it doesn’t support VSS, use the Filebased setting. |
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
EndState=ShutDown/Donothing/Reboot |
Possible settings shown. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (that is, the ESX address or the vCenter address). If ESX is discovered via VCenter, specify the ESX IP. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
Password= |
{required} Specify the password credential for the target container. If ESX is discovered via VCenter, specify the vCenter password. |
|
VirtualNetwork= |
Specify the VMware virtual network name you want to use. |
|
TakeControl=static/dhcp |
Specify static or dhcp depending on your networking configuration. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[ExistingTargetMachine] |
|
|
DisplayName= |
{required} Specify the name you want to display in vCenter or ESX console. |
|
HostName= |
. |
|
InstallTools=true/false |
. |
|
WorkGroup= |
Specify the workgroup name if you want to join workgroup. |
|
Domain= |
. |
|
DomainUserName= |
. |
|
DomainUserPassword= |
. |
|
EndState=VMPowerOFF/VMPowerON/VMSuspend |
Possible settings shown. |
|
[EthernetNic1] |
You can repeat this section of the .ini file for every NIC at the target container. For example, the second NIC section would be named [EthernetNic2]. Configuration settings would be specified for each NIC section in the file. |
|
DHCPEnabled=true/false |
|
|
VirtualNetwork= |
Specify the VMware virtual network name you want to use. |
|
Address= |
Specify the IP address for the target machine. |
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
The sections in the ServerSync-Windows.ini and in the ServerSync-Linux.ini file are identical, except for the settings in [Transfer] section, along with the settings for the workgroup and domain configuration. The differences for the Linux source job are shown in the following table.
Table B-7 ServerSync-Linux.ini: Differences in Setting Details of the [Transfer] section
|
File Sections and Default Settings (differences only) |
Comment |
|---|---|
|
[Transfer] |
|
|
TransferType=BlockBased/FileBased |
Possible settings shown. Linux does not support VSS. |
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
The CLI tool supports several imaging operations (for example, install, uninstall, and update tools) through its imageserver command. Before you start an imageserver job, make sure you run the discover command on the source computer and then on the target container.
In addition to the imageserver job, the CLI tool supports imaging Windows workloads (source) to vCenter/ESX servers (target). There are two types of imaging .ini files, one for a basic job configuration, and one for custom configurations. While the job is running you can abort the job or check its status.
For details about the settings in the imaging jobs, see Imaging Jobs in the CLI appendix of the PlateSpin Migrate User Guide, online.
The tables in this section are named by the respective imaging jobs .ini files they represent. The table contents include the file section names within the .ini and the available settings you can configure according to your conversion needs:
Table B-8 Details of CaptureImage-Default.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2I |
{required} This value must be used for every image capture. |
|
[JobConfig] |
|
|
Default=true |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
[ImageConfiguration] |
|
|
ImageDisplayName= |
{required} Specify the display name of the image in the image server. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify IP address for target machine. |
|
UserName= |
{required} Specify target username. |
|
Password= |
{required} Specify a password credential for the target machine. |
Table B-9 Details of CaptureImage.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2I |
{required} This value must be used for every image capture. |
|
[JobConfig] |
|
|
Default=false |
|
|
[Transfer] |
|
|
TransferType=VSSFileBased/FileBased |
Possible settings are shown. If the Windows source machine support VSS snapshotting, use the VSSFileBased setting, if it doesn’t support VSS, use the Filebased setting. |
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
EndState=ShutDown/Donothing/Reboot |
Possible settings are shown. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[ImageConfiguration] |
|
|
ImageDisplayName= |
Specify a name that you want to appear in the Image Server. |
|
CompresionEnabled=true/false |
Specify whether or not to use NTFS file compression. Default is false. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (Windows Image Server). |
|
UserName= |
{required} Specify the username for the target container. |
|
Password= |
{required} Specify the password credential for the target container. |
|
[Volume1] |
|
|
VolumeToCopy= |
Specify the name of the volume you want to capture. |
|
MapTo= |
Specify the path where you want to create the package file for the volume. |
Table B-10 Details of DeployImage-Default.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=I2V |
{required} This value must be used for every image deployment. |
|
[JobConfig] |
|
|
Default=true |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the image container. |
|
UserName= |
{required} Specify a username credential for the image container. |
|
Password= |
{required} Specify a password credential for the image container. |
|
ImageDisplayName= |
Specify the name of the image that you want to deploy. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (that is, the ESX address or the vCenter address). If ESX is discovered via VCenter, specify the ESX IP. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username. |
|
Password= |
{required} Specify the password credential for the target container. If ESX is discovered via VCenter, specify the vCenter password. |
|
[NewMachine] |
|
|
DisplayName= |
{required} Specify the name you want to display in the target container. |
|
HostName= |
Specify the target hostname. |
Table B-11 Details of DeployImage.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=I2V |
{required} This value must be used for every image deployment. |
|
[JobConfig] |
|
|
Default=false |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the image container. |
|
UserName= |
{required} Specify a username credential for the image container. |
|
Password= |
{required} Specify a password credential for the image container. |
|
ImageDisplayName= |
Specify a name for the image that you want to deploy. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the target container (that is, the ESX address or the vCenter address). If ESX is discovered via VCenter, specify the ESX IP. |
|
UserName= |
{required} Specify the username for the target container. If ESX is discovered via VCenter, specify the vCenter username |
|
Password= |
{required} Specify the password credential for the target container. If ESX is discovered via VCenter, specify the vCenter password |
|
TakeControl=static/dhcp |
Specify static or dhcp,depending on your networking configuration. |
|
VirtualNetwork= |
|
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
[NewMachine] |
|
|
DisplayName= |
{required} Specify the name you want to display in target container. |
|
DataStore= |
Specify the name of datastore you want to use. |
|
ConfigPath= |
Specify the path to the .vmx file. |
|
Memory= |
Specify the amount of RAM you want for the target computer in MB or GB. |
|
WorkGroup= |
Specify the name of the workgroup you want to join. |
|
InstallTools=true/false |
Possible settings shown. Default is true. |
|
NumberofCPU= |
Specify the number of CPUs you want for the target computer. |
|
Memory= |
.Specify the amount of RAM you want for the target computer. |
|
Domain= |
|
|
DomainUserName= |
|
|
DomainUserPassword= |
|
|
HostName= |
|
|
EndState=VMPowerOFF/VMPowerON/VMSuspend |
Possible settings shown. |
|
[EthernetNic1] |
If you have two (or more) NICs at the target, you can specify them and their configurations |
|
DHCPEnabled=true/false |
|
|
VirtualNetwork= |
Specify the VMware virtual network name you want to use |
|
Address= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
DNS= |
|
|
[DriveGeneral] |
If you have multiple disks at the source, you specify them here (create more if needed). The .ini file shows examples of two disks being specified. You can specify as many disks as there are at the source. |
|
DataStore1= |
Specify the name of the datastore. |
|
Disk1= |
Specify the name of the disk and its location. |
|
DataStore2= |
Specify the name of the datastore. |
|
Disk2= |
Specify the name of the disk and its location. |
Table B-12 Details of IncrementalImaging-Default.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2EI |
{“Existing Image”: required} Every incremental image capture uses this setting. |
|
[JobConfig] |
|
|
Default=true |
|
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
ImageDisplayName= |
Specify an image name that already exists in the image server. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify an IP address for the image. |
|
UserName= |
{required} Specify a username for the image. |
|
Password= |
{required} Specify a password credential for the image server. |
Table B-13 Details of IncrementalImaging.ini
|
File Sections and Default Settings |
Comment |
|---|---|
|
[Type] |
|
|
Conversion=X2EI |
{“Existing Image: required} Every incremental image capture uses this setting. |
|
[JobConfig] |
|
|
Default=false |
|
|
[Transfer] |
|
|
LiveTransferEnabled=true/false |
Possible settings shown. This setting is dependent on the TransferType setting. If that setting is Filebased and you want to perform an offline conversion, this setting must be set to false. |
|
[Source] |
|
|
Address= |
{required} Specify an IP address for the source workload. |
|
UserName= |
{required} Specify a username credential for the source workload. |
|
Password= |
{required} Specify a password credential for the source workload. |
|
TakeControl=static/dhcp |
{conditional} Use this value only if the source is WINXP, Win2k3, Windows 2000. Otherwise, it is not required. |
|
TakeControlAddress= |
|
|
SubnetMask= |
|
|
DefaultGateway= |
|
|
EndState=ShutDown/Donothing/Reboot |
Possible settings shown. |
|
ImageDisplayName= |
Specify an image name that already exits in image server. |
|
[TargetContainer] |
|
|
Address= |
{required} Specify the IP address for the image server. |
|
UserName= |
{required} Specify the username for the image server. |
|
Password= |
{required} Specify a password for the image server. |