Name

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

Remarks

• This method 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. 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 method returns VIX_OK but has no effect on Workstation or Player, which lack a virtual machine inventory.
• This method is asynchronous. Completion is reported by a IJob object.
• 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.
• For ESX/ESXi hosts and vSphere, the user account specified in the call to Host::Connect must have "System.View" privilege at the level of the Datacenter containing the ESX server that hosts the VM to be unregistered.

Side Effects

Requirements

Example

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, "Administrator", "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 = Nothing

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

class Program
{

   static void Main(string[] args)  
   {
      VixCOM.VixLibClass lib = new VixCOM.VixLibClass();
      UInt64 err;
      object results = null;
      
      VixCOM.IJob job = lib.Connect(VixCOM.Constants.VIX_API_VERSION,
                                    VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_VI_SERVER,
                                    "https://viserver/sdk",
                                    0,
                                    "Administrator",
                                    "administratorpasswd",
                                    0,
                                    null,
                                    null);
      err = job.Wait(new int[] { VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE },
                     ref results);
      if (lib.ErrorIndicatesFailure(err)) {
         // Handle the error... 
      }     

      VixCOM.IHost host = (VixCOM.IHost)((object[])results)[0];
      CloseVixObject(job);

      job = host.UnregisterVM("[standard] Windows XP\\Windows XP.vmx", null);
      job.WaitWithoutResults();
      CloseVixObject(job);
     
      host.Disconnect();
   }

   static void CloseVixObject(Object vixObject)
   {
      try
      {
         ((IVixHandle2)vixObject).Close();
      }
      catch(Exception)
      {
         //Close is not supported in this version of Vix COM - Ignore
      }
   }
}