Enter Maintenance Mode operation


The Enter Maintenance Mode operation enables you to put the specified host in the maintenance mode. If you are executing this operation and the host is in maintenance mode, you cannot power on virtual machines or perform provisioning operations on the host. After the operation completes, it is safe to turn off a host without disrupting any virtual machines.

The operation completes if there are no powered-on virtual machines on the host and no provisioning operations are in progress on the host. The operation does not directly initiate any operations to evacuate or power-down virtual machines. However, if the host is part of a cluster with VMware DRS enabled, DRS provides migration recommendations to evacuate the virtual machines. If DRS is in fully-automatic mode, the migrations are automatically scheduled.

Note

The operation is cancellable.

If the <status> response element contains success, the <Task> response element contains the ID of the queued task, which you can use to obtain the task status.

The following table describes the elements for the adapter request.

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

The following code sample shows the sample adapter request for the Enter Maintenance Mode operation. 

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

The following code sample shows the response for the sample Enter Maintenance Mode operation. 

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

The following table shows the response element for the Enter Maintenance Mode operation. 

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*