Name

Description

$err = RegisterVM($hostHandle,
                  $vmxFilePath);

This function adds a virtual machine to the host's inventory.

Parameters

hostHandle

The host handle returned by HostConnect().

vmxFilePath

The path name of the .vmx file on the host.

Return Value

Remarks

• This function registers the virtual machine identified by vmxFilePathName, which is a storage path to the configuration file (.vmx) for that virtual machine. You can register a virtual machine regardless of its power state.
• The format of the path name depends on the host operating system. If the path name includes backslash characters, you need to precede each one with an escape character. Path to storage [standard] or [storage1] may vary.
• For VMware Server 1.x, supply the full path name instead of storage path, and specify VIX_SERVICEPROVIDER_VMWARE_SERVER to connect.
• This function does not apply to Workstation, which has no virtual machine inventory.
• It is not a Vix error to register an already-registered virtual machine, although the VMware Server UI shows an error icon in the Task pane. Trying to register a non-existent virtual machine results in error 2000, VIX_E_NOT_FOUND.

Side Effects

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;

Example

my $err = VIX_OK;
my $hostHandle = VIX_INVALID_HANDLE;

($err, $hostHandle) = HostConnect(VIX_API_VERSION,
                                  VIX_SERVICEPROVIDER_VMWARE_VI_SERVER,
                                  "https://viserver/sdk", # hostName
                                  0, # hostPort
                                  "root", # userName
                                  "rootpasswd", # password
                                  0, # options
                                  VIX_INVALID_HANDLE); # propertyListHandle

die "HostConnect() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

$err = RegisterVM($hostHandle,
                  "[standard] Windows XP\\Windows XP.vmx");
die "RegisterVM() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;