Name

UnregisterVM

Description

HRESULT
UnregisterVM([in] BSTR vmxFilePath,
             [in] ICallback* jobDoneCallback,
             [out,retval] IJob** unregisterJob);

This method removes a virtual machine from the host's inventory.

Parameters

vmxFilePath
The storage path of the .vmx file on the host.
jobDoneCallback
An ICallback instance that will be called when the operation is complete.
unregisterJob
Returns an IJob object that describes the state of this asynchronous operation.

Return Value

HRESULT

Remarks

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.0.

Example


VBScript:
Dim lib
Dim err
Dim job
Dim host
Dim results

Set lib = CreateObject("VixCOM.VixLib")

Set results = Nothing

Set job = lib.Connect(VixCOM.Constants.VIX_API_VERSION, VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_VI_SERVER, "https://viserver/sdk", 0, "Admnistrator", "administratorpasswd", 0, Nothing, Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set host = results(0)

Set job = host.UnregisterVM("[standard] Windows XP\Windows XP.vmx", Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

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