Edit C:\Program Files (x86)\VMware\VMware VIX\doc\lang\perl\functions\UnregisterVM.html
<html> <head> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> <meta HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> <link rel="stylesheet" href="../../../foundrydoc.css" type="text/css" charset="ISO-8859-1"> <link rel="stylesheet" href="foundrydoc.css" type="text/css" charset="ISO-8859-1"> </head> <body> <h1>Name</h1> <b>UnregisterVM</b> <h1>Description</h1> <pre> $err = UnregisterVM($hostHandle, $vmxFilePath); </pre> <p> This function removes a virtual machine from the host's inventory. <h1>Parameters</h1> <dl> <dt><i>hostHandle</i></dt> <dd> The host handle returned by HostConnect(). </dd> <dt><i>vmxFilePath</i></dt> <dd> The storage path of the .vmx file on the host. </dd> </dl> <h1>Return Value</h1> $err. The error code returned by the operation. For returned values, see Topics > Error Codes. <h1>Remarks</h1> <ul> <li> 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. <li> 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. <li> For VMware Server 1.x, supply the full path name instead of storage path, and specify VIX_SERVICEPROVIDER_VMWARE_SERVER to connect. <li> This function returns VIX_OK but has no effect on Workstation or Player, which lack a virtual machine inventory. <li> 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. <li> For ESX/ESXi hosts and vSphere, the user account specified in the call to HostConnect must have "System.View" privilege at the level of the Datacenter containing the ESX server that hosts the VM to be unregistered. </ul> <h1>Side Effects</h1> None. <h1>Requirements</h1> <pre> use VMware::Vix::Simple; use VMware::Vix::API::Constants; </pre> since VMware Server 1.0 <h1>Example</h1> <pre> 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; </pre> </body> </html> <hr>Copyright (C) 2007-2017 VMware, Inc. All rights reserved.
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de