This section explains how to import a virtual L-Server.
The VM converter provides the function for importing virtual L-Servers from the CLI.
The virtual L-Server import function is comprised of the following three functions:
Import of a virtual hard disk of a virtual machine that was exported from Resource Orchestrator in another environment or an external cloud service, into a VM host.
Linking of a virtual machine that was imported into a VM host with a virtual L-Server.
Import of a linked virtual L-Server into the specified L-Platform.
Note
Targets of virtual L-Server linking and import to L-Platform operations from the CLI using the VM converter are as follow:
Virtual machines imported using the above import function
Virtual L-Servers linked with the virtual machine mentioned above
Installing the VM Converter Agent Program
The virtual machine to be imported must have the VM Converter agent program installed beforehand.
Install the VM Converter agent program before exporting the target virtual machine from the source location.
The installer for the agent program is stored in the installation folder of VM Converter:
VM_Converter_installation_folder\VMConverter\Agent\x86\TransportAgent.msi VM_Converter_installation_folder\VMConverter\Agent\x64\TransportAgent.msi
Select the installer that supports the OS bit mode of the target virtual machine and execute it on the virtual machine to install the agent program.
Note
The VM Converter agent program must be installed on the virtual machine at the source location.
After the agent program is installed, export the virtual machine.
Confirmation and Design of a Virtual L-Server, Tenant, and L-Platform
In order to use the three functions provided by VM Converter, confirm or define the following information beforehand:
The IP address of vCenter Server that manages the destination VM host (Confirm)
The login name and password for vCenter Server that manages the destination VM host (Confirm)
The IP address of the destination VM host (Confirm)
The name of the datastore on the destination VM host (Confirm)
The name of the virtual machine in the destination VM host (Define beforehand)
The disk size of the virtual machine (Define beforehand)
The disk image format of the virtual machine (Define beforehand)
The full path to the vmdk file to be imported (Confirm)
The name of the tenant to which the virtual L-Server will be deployed (Confirm)
The name of the virtual L-Server (Define beforehand)
The destination L-Platform ID (Confirm)
The disk image ID to be set for the virtual L-Server (Confirm)
The name of the tenant to which the virtual L-Server is deployed (Confirm)
The user name of the tenant administrator of the tenant to which the virtual L-Server is deployed (Confirm)
Information
The disk image ID to be set for the virtual L-Server can be confirmed on the [Image] tab on the [Template] tab of the ROR console. It can be also confirmed using the cfmg_listimageinfo command.
For details on the command, refer to "9.9 cfmg_listimageinfo (Displaying Image Information List)" in the "Reference Guide (Command/XML) CE".
Creation of Definition files of Configuration Information/Unique Information of the Virtual Machine to be Imported
The configuration information (the number of CPUs and memory size) and unique information (NIC count, NIC connection destination, host name, and network information) of the virtual machine to be imported should be specified during the import process. The configuration and unique information of the virtual machine at the migration source is not inherited.
Enter the configuration information (the number of CPUs and the memory size) for the virtual machine to be imported in the VM configuration file.
For details on the VM configuration file, refer to "VM configuration file".
Enter the information specific to the virtual machine to be imported (i.e. computer name and network information) in the customization file.
For network information, confirm an IP address which can be allocated from the address pool of Resource Orchestrator beforehand and enter it in this file.
For details on the customization file, refer to "customization file".
Editing of the Definition File Required for Linking a Virtual L-Server
To assign the IP address of Resource Orchestrator automatically when linking the imported virtual machine with a virtual L-Server, set "true" for reserve_ip_address in the following definition file:
[Windows Manager]
Installation_folder\SVROR\Manager\etc\customize_data
l_server.rcxprop
reserve_ip_address=true
For details on definition files, refer to "17.8.1 Installation".
The following operations can be performed from the CLI provided by the VM Converter:
Starting the import of a virtual machine
Obtaining of import process (task) progress statuses
Linking of an imported virtual machine with a virtual L-Server
Importing of a Virtual L-Server into an L-Platform
CLI is provided as the following cmdlet in Windows PowerShell 2.0 or later.
To use cmdlets, it is necessary to import the module manifest file in advance. The PowerShell module manifest file is in the following folder.
VM_Converter_installation_folder\VMConverter\Client\PowerShell\Fujitsu.VMConverterClient.psd1
Move to the above folder and execute the Import-Module command.
Import-module .\Fujitsu.VMConverterClient.psd1 |
The syntax of the cmdlet is as follows.
> Connect-DestinationCloud -DestinationCloudType String -DestinationServer String -DestinationServerUserName String -DestinationServerPassword String <RETURN> |
cmdlet Name | Description | Parameters | Output | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Connect-DestinationCloud | Logs in to the destination cloud. | DestinationCloudType | String | True | Specify the destination cloud type. | None |
DestinationServer | Specify the server name of the destination cloud using its FQDN name or IP address. Only Resource Orchestrator admin servers are supported. | |||||
DestinationServerUserName | Specify the user ID for login to the destination server. | |||||
DestinationServerPassword | Specify the user password for login to the destination server. |
> Disconnect-DestinationCloud -DestinationCloudType String <RETURN> |
cmdlet Name | Description | Parameters | Output | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Disconnect-DestinationCloud | Logs out from the destination cloud system. | DestinationCloudType | String | True | Specify the destination cloud type. | None |
> Start-ImportTask -SourceCloudType String -DestinationCloudType String -VMManagementServerAddress String -VMHostAddress String -VMHostDatastore String -VMName String -VMManagementServerUserName String -VMManagementServerPassword String -TargetPath String [-VMDiskSize String] [-VMDiskFormat String] -VMConfigFile String -VMCustomizeFile String [-Wait Switch] <RETURN> |
cmdlet Name | Description | Parameters | Output | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Start-ImportTask | Starts the import task. | SourceCloudType | String | True | Specify the source cloud type. | Task ID |
DestinationCloudType | Specify the destination cloud type. | |||||
VMManagementServerAddress | Specify the IP address of the vCenter server that manages the VM. | |||||
VMHostAddress | Specify the ESX/ESXi host on which the VM will be stored. Specify IP address when you register ESX/ESXi in vCenter by IP address. | |||||
VMHostDatastore | Specify the datastore name in the ESX/ESXi host on which the VM will be stored. | |||||
VMName | Specify the imported VM name (the VM name on the destination VM host). | |||||
VMManagementServerUserName | Specify the user ID for login to the vCenter server. | |||||
VMManagementServerPassword | Specify the user password for login to the vCenter server. | |||||
TargetPath | Specify the full path name of the vmdk file to be imported. A path to a local folder or a shared folder on another machine that can be accessed by this tool can be specified. | |||||
VMDiskSize | False | Specify the disk size of the imported VM in GB. (*) | ||||
VMDiskFormat | Select one of the following as the disk format of the imported disk:
| |||||
VMConfigFile | True | Specify the full path name of the VM configuration file. | ||||
VMCustomizeFile | True | Specify the full path name of the customization file. | ||||
Wait | False | Specify this if you want to wait until the import task ends. |
* Note: Specify a disk size larger than the exported VM disk size.
>Update-ConvertTask [-Show] <RETURN> |
cmdlet Name | Description | Parameters | Output | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Update-ConvertTask | Updates the managed task status. | Show | Switch | False | If specified, the updated task status is shown. | None |
> Start-VMtoLServer -VMName String -TenantName String -LServerName String <RETURN> |
cmdlet Name | Description | Parameters | Output | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Start-VMtoLServer | Starts linking the VM to the L-Server. | VMName | String | True | Specify the VM name imported using Start-ImportTask. | None |
TenantName | Specify the name of the tenant to which the L-Server will be deployed. | |||||
LServerName | Specify the L-Server name. |
Note
When the VM host is stopped during execution of this commandlet, linking is completed without the IP address allocated to the virtual L-Server. In that case, use the rcxadm lserver modify command to allocate the IP address.
For details, refer to "3.6 rcxadm lserver" in the "Reference Guide (Command/XML) CE".
>Start-LServertoLPlatform -DestinationServerUserName String -DestinationServerPassword String -DiscImageId String -TenantAdmin String -TenantName String -LPlatformName String -LServerName String [-LPlatformApiPort String ] <RETURN> |
cmdlet Name | Description | Parameters | Output (Return Value) | |||
---|---|---|---|---|---|---|
Parameter Name | Type | Mandatory | Description | |||
Start-LServertoLPlatform | Starts importing an L-Server to the L-Platform. | DestinationServerUserName | String | True | Specify the user ID for login to the destination server. | None |
DestinationServerPassword | Specify the user password for login to the destination server. | |||||
DiscImageId | Specify the disc image ID for the L-Server. | |||||
TenantAdmin | Specify the user name of the tenant administrator of the tenant that was specified when linking to the L-Server. | |||||
TenantName | Specify the tenant name specified using Start-VMtoLServer. | |||||
LPlatformName | Specify the destination L-Platform ID. | |||||
LServerName | Specify the target L-Server name specified using Start-VMtoLServer. | |||||
LPlatformApiPort | False | Specify the port number where the L-Platform API is running. If omitted, port number 8014 is used. |
VM configuration file
By specifying a VM configuration file using the VMConfigFile option of the Start-ImportTask cmdlet, it is possible to configure the virtual machine to be imported.
VM configuration files must be created in XML format as in the following example:
Use the UTF-8 character code for this file.
VM_Converter_installation_folder\VMConverter\Client\sample\import_vmconfig.xml
Example
<?xml version="1.0" encoding="utf-8"?> <Config> <VmVersion>vmx-08</VmVersion > <OSType ovfType="1" vmwType="winNetEnterpriseGuest"/> <Processor numCPUs="2"/> <Memory sizeInMB="2048"/> <DiskController type="lsilogic"/> <NetworkInterfaces> <NicType>E1000</NicType> <NetworkInterface> <Connection>Virtual Network #1</Connection> </NetworkInterface> <NetworkInterface> <Connection>Virtual Network #2</Connection> </NetworkInterface> </NetworkInterfaces> </Config> |
Element | Attributes | Description | Mandatory |
---|---|---|---|
Config | - | The root element. | Yes |
VmVersion | - | Specify the virtual machine version. [VMware] Example
If you are not sure of the virtual machine version, do not specify the VMVersion element. If omitted, it is automatically set by the destination VM host. | No |
OSType | ovfType vmwType | Specify the guest OS type.
| Yes |
Processor | numCPUs | Specify the total number of CPUs for the virtual machine. | Yes |
Memory | sizeInMB | Specify the memory size of the virtual machine in MB. | Yes |
DiskController | type | Specify the SCSI controller type. The following values can be specified. lsilogic, buslogic, lsilogicsas, VirtualSCSI If omitted, it is automatically set by the destination host. | No |
NetworkInterfaces | Yes | ||
NicType | Specify the NIC type. The following values can be specified. E1000e, E1000, VmxNet3, VmxNet2, PCNet32 If omitted, it is automatically set by the destination host. | No | |
NetworkInterface | Yes | ||
Connection | Specify the name of the virtual network to be connected. | Yes |
For elements that are not mandatory, it is necessary to not describe the tags themselves.
OS of the Import Target VM | String to Specify |
---|---|
Windows Server 2003, Standard Edition (32bit) | winNetStandardGuest |
Windows Server 2003, Standard Edition (64 bit) | winNetStandard64Guest |
Windows Server 2003, Enterprise Edition(32bit) | winNetEnterpriseGuest |
Windows Server 2003, Enterprise Edition (64 bit) | winNetEnterprise64Guest |
Windows Server 2003, Datacenter Edition(32bit) | winNetDatacenterGuest |
Windows Server 2003, Datacenter Edition (64 bit) | winNetDatacenter64Guest |
Windows Server 2008 (32bit) | winLonghornGuest |
Windows Server 2008 (64bit) | winLonghorn64Guest |
Windows Server 2008R2 | windows7Server64Guest |
Windows Server 2012 | windows8Server64Guest |
Windows Server 2012 R2 | windows8Server64Guest |
Note
Specify a virtual machine version supported by the destination host.
When importing a virtual machine, if a version different from the source virtual machine is specified, the imported virtual machine may not operate correctly.
customization file
By specifying the customization file using the VMCustomizeFile option of the Start-ImportTask cmdlet, it is possible to configure the unique information when importing a virtual machine.
This file must be specified when importing a vmdk file.
Customization files must be created in XML format as in the following example:
Use the UTF-8 character code for this file.
VM_Converter_installation_folder\VMConverter\Client\sample\import_customize.xml
Example
<?xml version="1.0" encoding="utf-8"?> <Customization version="1"> <ComputerName>comp01</ComputerName> <Interfaces> <Interface mode="static"> <Connection>Virtual Network #1</Connection> <Name>Business LAN</Name> <IPv4Address>10.1.1.4</IPv4Address> <IPv4SubnetMask>255.255.255.0</IPv4SubnetMask> <IPv4Gateway>10.1.1.1</IPv4Gateway> <DNSServer>10.1.2.8</DNSServer> <DNSServer>10.1.3.10</DNSServer> </Interface> <Interface mode="static"> <Connection>Virtual Network #2</Connection> <Name>Management LAN</Name> <IPv4Address>192.168.10.24</IPv4Address> <IPv4SubnetMask>255.255.255.0</IPv4SubnetMask> <IPv4Gateway>192.168.10.1</IPv4Gateway> </Interface> </Interfaces> </Customization> |
Element | Parent Element | Value | Mandatory |
---|---|---|---|
Customization | - | The root element. | Yes |
ComputerName | Customization | Specify the computer name. | No |
Interfaces | Customization | The list of NIC settings. | Yes |
Interface | Interfaces | Configure for each NIC. | Yes |
Connection | Interface | Specify which virtual network is connected to the target. | Yes |
Name | Interface | Specify the network connection name. | No |
IPv4Address | Interface | Specify the IPv4 address. | Yes |
IPv4SubnetMask | Interface | Specify the IPv4 subnet mask. | Yes |
IPv4Gateway | Interface | Specify the IPv4 default gateway address. | Yes |
DNSServer | Interface | Specify the address of the DNS server. | No |
For elements that are not mandatory, it is necessary to not describe the tags themselves.
VM Migration Engine Configuration File
When executing the Start-ImportTask cmdlet, it is possible to modify the operations performed during import of virtual machines using the VM migration engine configuration file. If this file does not exist, the default operation is performed.
VM migration engine configuration files must be created in XML format as in the following example:
Use the UTF-8 character code for this file.
VM_Converter_installation_folder\VMConverter\Engine\ TransporterConfig.xml
Example
<?xml version="1.0" encoding="utf-8"?> <configuration> <timeout> <WebService>100</WebService> <FindNic>300</FindNic> <InitSys>180</InitSys> </timeout> </configuration> |
Element | Description | Mandatory | Default Value (Seconds) |
---|---|---|---|
configuration | The root element. | Yes | - |
timeout | - | ||
WebService | Specify the timeout value (in seconds) of the internal import process (Web service). When "thickeager" is specified for the VMDiskFormat option, the import process may time out depending on the performance of the destination host. In that case, set a larger value for WebService. | - | 100 |
FindNic | Specify how long the agent program should wait for completion of NIC initialization in the imported virtual machine, using seconds for the value. When a NIC is added or changed using the VM configuration file, it may take longer for the operating system to initialize NICs and setting of the values specified in individual configuration information files may fail. In that case, set a larger value for FindNic. | - | 300 |
InitSys | Specify how long the agent program should wait for completion of system initialization of the imported virtual machine, using seconds for the value. When configuring NICs using individual configuration information files, configuration may not be performed correctly due to a conflict of this configuration process and the VMware Tools configuration process, depending on the timing. If the NIC information from before migration remains on the virtual machine even after import is completed, change the InitSys value to a larger value before performing another import operation. | - | 180 |