Name
UnregisterVM
Description
$err = UnregisterVM($hostHandle,
$vmxFilePath);
This
function
removes a virtual machine from the host's inventory.
Parameters
- hostHandle
-
The host handle returned by HostConnect().
- vmxFilePath
-
The storage path of the .vmx file on the host.
Return Value
$err. The error code returned by the operation. For returned values, see Topics > Error Codes.
Remarks
- This
function
unregisters the virtual machine identified by vmxFilePathName, which is
a storage path to the configuration file (.vmx) for that virtual machine.
A virtual machine must be powered off to unregister it.
- The format of the storage path depends on the host operating system.
If the storage path 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 unregister an already-unregistered virtual machine,
nor is it a Vix error to unregister a non-existent virtual machine.
Side Effects
None.
Requirements
use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Server 1.0
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 = UnregisterVM($hostHandle,
"[standard] Windows XP\\Windows XP.vmx");
die "UnregisterVM() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;