Remove VMware VM
This object removes one or more VMware virtual machines from a host.
Install VMware.PowerCLI
Before using this VMware Automation Manager Object, you must install the PowerShell module VMware.PowerCLI.
This VMware Automation Object runs on 64-bit PowerShell, and the module must also be added to 64-bit PowerShell.
Requires PowerShell 5.0
Before using this VMware Automation Manager Object, you must install PowerShell 5.0.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Session ID | String | Yes | This is the session ID that is generated by the VMware connection object. This is required for the object to work. |
| VM Name | String | Yes | The name of the virtual machine that you want to remove from the host. The field support wildcards, so to remove all virtual machines on the host, use “*” as the value. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
| Result String | String | Object execution error details. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Session ID | String | Yes | "ab4c55c1273cb609678a2bb6a15104e927ac8dec", 10.199.2.23 |
| VM Name | String | Yes | Vmore |