Enable ESXi Host Maintenance Mode (VMware)

This object enables maintenance mode on a single ESXi 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.

Input Parameters

Name Type Required Description
Session ID String Yes The session ID that is generated by the VMware connection object.
This is required for this object to work.
ESXi Host Name String No

The name of the ESXi host to be set to maintenance mode.

If left blank, it will set the connected host to maintenance (do not leave blank if connected to a vCenter server).

Output Parameters

Name Type Description
Maintenance State String Returns the state of the host after maintenance is turned on.
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

ESXi Host Name String Yes Esxhost1