Shutdown VMware VM
This objects gracefully shuts down a running VM. If the Operating System does not have VMware Tools installed or if they are not running and communicating with the VMware host, the VM will not be shutdown.
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 this object to work. |
| Virtual Machine Name | String | Yes | This is the name of the virtual machine about which you want to get information. The field supports wildcards, so to return information about all virtual machines, use "*" as the value. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Current Power State | String | This output parameter will output the state of the virtual machine as the object was being requested to perform the action. |
| 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 |
| Virtual Machine Name | String | Yes | SRVExchange SRV* * |