5.11.3 Set maintenance mode for the ESX server
Function
This plugin switches to maintenance mode or exits maintenance mode for an ESX server in a VMware vSphere environment.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- ESX server
A server on which VMware vSphere ESXi is installed
- vCenter control server (execution target server)
A server on which VMware vSphere PowerCLI is installed. The plugin is transferred to and executed on this server by JP1/AO.
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes maintenance mode (VMware.esxSetMaintenanceMode property).
- Specify ON to switch to maintenance mode. Specify OFF to exit maintenance mode.
Use situation
This plugin can be used to enter or exit maintenance mode during maintenance of the ESX server.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products for the system, prerequisite products for the execution-target system, prerequisite products on the execution-target server, and the supported OSs for the prerequisite products for the execution-target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(2) Prerequisite product for VMware vSphere ESX to manage virtual servers
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESX must be managed by VMware vCenter Server.
(2) The status of VMware vSphere ESX must be "Connected" or "Connected (maintenance mode)".
Prerequisite products on the execution-target server:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release 1, 5.5 Release 2, 5.5 Release 1, 5.1 Release 2, 5.0
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
Cautions
(1) Do not specify a string containing a double quotation mark (") or single quotation mark (') for a property of this plugin.
(2) If you specify ON for maintenance mode (VMware.esxSetMaintenanceMode property) when the ESX server is in maintenance mode, this plugin ends normally without attempting to enter maintenance mode. If you specify OFF for maintenance mode (VMware.esxSetMaintenanceMode property) when the ESX server is not in maintenance mode, this plugin ends normally without attempting to exit maintenance mode.
(3) When an ESX server (specified by the VMware.vmHostName property) belonging to a cluster switches to maintenance mode, powered-off or suspended virtual servers on that ESX server do not move to another ESX server in the same cluster. If you need to move powered-off or suspended virtual servers, move such virtual servers in advance.
Execution privilege
(1) Users who connect to VMware vCenter Server must have system administrator permissions.
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetMaintenanceMode
Return code
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component script.)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
VMware.vCenterServerName |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
VMware.vmHostName |
Host name of the ESX server |
Specify the host name of the ESX server. |
-- |
Input |
R |
VMware.esxSetMaintenanceMode |
Maintenance mode |
To enter maintenance mode, specify "ON". To exit maintenance mode, specify "OFF". |
-- |
Input |
R |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |