5.11.7 Set virtual server options for the HA cluster
Function
This plugin sets the options that define the operation of virtual servers in a vSphere HA cluster in a VMware vSphere environment.
The following describes the items you can set. However, you cannot specify the HA cluster name (vmware.haClusterName property) and the virtual server name (VMware.vmName property) at the same time.
- If you specify the HA cluster name (VMware.haClusterName property):
The virtual server restart priority and the host isolation response can be specified in the default cluster settings.
- If you specify the virtual server (VMware.vmName property):
The virtual server restart priority and the host isolation response can be specified in virtual server settings.
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.
- HA cluster
A vSphere HA cluster, or a set of servers that make up a vSphere HA cluster
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes the virtual server restart priority (VMware.haRestartPriority property).
- You can specify any of the following values except for ClusterRestartPriority, which can be used only in virtual server settings:
Setting Meaning
Disabled Disabled
Low Low
Medium Medium
High High
ClusterRestartPriority The cluster settings are used.
The following describes the host isolation response (VMware.haIsolationResponse property).
- You can specify any of the following values except for AsSpecifiedByCluster, which can be used only in virtual server settings:
Setting Meaning
PowerOff Power on
DoNothing Leave powered on
Shutdown Shut down
AsSpecifiedByCluster The cluster settings are used.
Use situation
This plugin can be used to specify the options that define the operation of virtual servers during setup of a vSphere HA cluster or during configuration changes.
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) Conditions for settings on VMware vCenter Server
- vSphere HA cluster names and virtual server names must be unique.
- The VMware-related names shown below are case sensitive in VMware, but the specified names are not case sensitive in a vSphere PowerCLI instance that is executed by this plugin.
Therefore, this plugin cannot be used in an environment in which duplicate names with different case letters are used.
- HA cluster name
- Virtual server name
(3) The vSphere HA cluster must be created.
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) You need to specify either the HA cluster name (VMware.haClusterName property) or virtual server name (VMware.vmName property). If both names are specified or omitted, this plugin ends abnormally.
(3) You need to specify either the virtual server restart priority (VMware.haRestartPriority property) or host isolation response (VMware.haIsolationResponse property), or both. If neither is specified, this plugin ends abnormally.
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
vsphereSetHaVMOption
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.haClusterName |
HA cluster name |
Specifies the name of the vSphere HA cluster managed by VMware vCenter Server. |
-- |
Input |
O |
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. (This is the virtual server name in VMware vCenter Server. Do not specify a host name.) |
-- |
Input |
O |
VMware.haRestartPriority |
Virtual server restart priority |
Specifies the restart priority of the virtual server. |
-- |
Input |
O |
VMware.haIsolationResponse |
Behavior during host isolation |
Specifies the behavior to be taken if the host is isolated. |
-- |
Input |
O |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |