Get Host(s) Maintenance Status Information (VMware)

This object returns information about a host, such as if it is connected, in maintenance mode, or disconnected.

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	The session ID that is generated by the VMware connection object. This is required for this object to work.
Host Name	String	Yes	The name or IP address of the ESXi host from which information will be returned.

Output Parameters

Name

Type

Description

Hosts Information

Collection

The list of hosts returned as an array to be used with a "Foreach" object. It contains following host information:

The array containing the following service list information:

Item	Type	Description
State	String	The state of the virtual machine. The possible states include ‘’Connected’’, ‘’Maintenance”, and “Disconnected”.
Name	String	The name of the host. This may be the IP address if no name is configured.
UID	String	The full UID of the service.

Records Found

Number

The number of found and returned.

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
Host Name	String	Yes	Esxhost1