VMware Host - Unregister
Declaration
<AMVMWAREVM ACTIVITY="unregister_vm" SESSION="text" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text (encrypted)" CONNECTIONTIMEOUT="number" VMPATH="text" TIMEOUT="number" OPENVMTIMEOUT="number" />
Description
Unregisters a registered virtual machine from the specified host system.
NOTE: This activity is supported
only by VMware Server. VMware Workstation does not support registering
virtual machines.
Practical usage
Normally used to remove a specific VM from the inventory.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection | --- | --- | --- | --- | Indicates where
this activity's connection properties should originate from. Different
parameters become active depending on the option selected. This
is a visual parameter used only during design-time, therefore,
contains no properties or markups. The available options are:
|
Session | Text | Yes, if Connection is set to Session | VMOpsSession1 | SESSION="VMO101" | The name of a session (created in a previous VWmware Host - Connect step) in which to link this activity. This parameter is active only if the Connection parameter is set to Session. |
Host type | Text (options) | Yes, if Connection is set to Host | VIServer |
|
The type of VM
host to establish a connection with. This parameter is active
only if the Connection
parameter is set to Host.
The available options are:
|
Host name | Text | Yes | (Empty) | SERVER="host.server.com" | The hostname or IP address of the computer where the virtual machine is located. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
Username | Text | No | (Empty) | USERNAME="MsPacman" | The username identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
Password | Text | No | (Empty) | PASSWORD="encrypted" | The password identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0). |
Connection timeout | Number | No | 60 | CONNECTIONTIMEOUT="50" | The maximum time period in seconds during which a connection must be established between the guest and host, otherwise, the step times out. The default value is 60 seconds. |
Virtual Machine
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Virtual machine path | Text | Yes | (Empty) | VMPATH="C:\VMFolder\VMfile.vmx" | The absolute path of the virtual machine configuration (.vmx) file in which to unregister. This parameter varies by product platform. With ESX/ESXi hosts and VMware Server 2.0, use a URL of the form "https://<hostName>:<port>/sdk" where <hostName> is either the DNS name or IP address, and <port> might be optional; credentials are required even for connections made locally. With VMware Workstation, use undef to connect to the local host. With VMware Server 1.0.x, use a DNS name or IP address for remote connections, or the same as Workstation for local connections. |
Timeout (seconds) | Number | No | 60 | TIMEOUT="50" | The maximum time period in seconds during which this activity must be completed or the task times out. |
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task unregisters a virtual machine.
Copy
<AMVMWAREVM ACTIVITY="unregister_vm" VMPATH="C:\Virtual Machines\Windows 10 x64 (FULL)\Windows 10 x64.vmx" HOSTTYPE="VIServer" SERVER="209.123.456.789" USERNAME="root" PASSWORD="AM1hd66umsQRtNbulaHHhbEOBF423belTvAaME" />