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

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;
                       

Copyright (C) 2007-2010 VMware, Inc. All rights reserved.