5.11.8 Monitoring settings for the virtual server in the HA cluster
Function
In the VMware vSphere environment, specifies the monitoring settings for the virtual server belonging to the vSphere HA cluster.
The specifiable items are: virtual server monitoring and monitoring sensitivity.
The following servers are the prerequisites for this plug-in:
- vCenter server
Server where VMware vCenter Server is installed.
- vCenter control server (execution target server)
Server where VMware vSphere PowerCLI is installed. Plug-ins are transferred to this server and executed by JP1/AO.
- HA cluster
Server that configures the vSphere HA cluster or the vSphere HA cluster.
- Virtual server
Virtual server that is managed by the vCenter server and VMware vSphere ESXi.
You can set virtual server monitoring (VMware.vmMonitoring property) as follows:
- Specify the monitoring status settings to be specified for the virtual server.
- You can specify the following values:
Setting Definition
vmMonitoringDisabled Disabled
vmMonitoringOnly Virtual server monitoring only
vmAndAppMonitoring Virtual server and application monitoring
clusterSettings As per the cluster setting
You can set the monitoring sensitivity (failure interval) (VMware.failureInterval property) as follows:
- Specify the failure interval (units: seconds) for the monitoring sensitivity to be set.
- Specify an integer value in the range from 1 to 100,000.
You can set the monitoring sensitivity (minimum uptime value) (VMware.minUpTime property) as follows:
- Specify the minimum uptime value (units: seconds) for the monitoring sensitivity to be set.
- Specify an integer value in the range from 1 to 100,000.
You can set the monitoring sensitivity (maximum number of resets per virtual server) (VMware.maxFailures property) as follows:
- Specify the maximum number of resets per virtual server for the monitoring sensitivity to be set.
- Specify an integer value in the range from 1 to 1,000.
You can set the monitoring sensitivity (maximum reset time period) (VMware.maxFailureWindow property) as follows:
- Specify the maximum reset time period (units: seconds) for the monitoring sensitivity to be set.
- Specify -1 or an integer value in the range from 1 to 1,000. If you specify -1, the maximum reset time period is set to no period.
Use situation
This plug-in can be used to set to monitor a virtual server added to the HA cluster that has already been constructed.
Prerequisites
For the most recent information about the prerequisite products for the system, the prerequisite products for the execution-target system, the prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.
Prerequisite products for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products for the execution-target system:
(1) Prerequisite products for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, and 5.0
(2) Prerequisite products for the VMware vSphere ESX instance that manages the virtual server
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, and 5.0
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESXi must be managed by VMware vCenter Server.
(2) Conditions related to the settings on VMware vCenter Server
- Virtual servers must have a unique name.
- The VMware-related name shown below is case-sensitive in VMware. However, it is not case-sensitive in a vSphere PowerCLI instance that is executed from this plug-in.
For this reason, you cannot use this plug-in in an environment where some of the VMware-related names being used are identical to each other except for case differences.
- Virtual server name
(3) The virtual server must belong to the vSphere HA cluster.
Prerequisite products for the execution-target server:
- VMware vSphere PowerCLI 6.3 Release 1, 6.0 Release 3, 6.0 Release 1, 5.8 Release 1, 5.5 Release 2, 5.5 Release 1, 5.1 Release 2, and 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 a single quotation mark (') in a property of this plug-in.
(2) The virtual server monitoring setting for the virtual server is dependent on the virtual server monitoring setting specified for the HA cluster.
If the disable setting is specified for the HA cluster, all settings for the virtual server become disabled.
If the HA cluster is set to monitor the virtual server only, the setting for the virtual server will be disabled or enabled only for monitoring the virtual server.
Execution privilege
(1) Users who access VMware vCenter Server must have permission for the system administrator role.
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetVMMonitoring
Return code
0: Normal
12: Error (Mistake by user) Invalid property
27: Error (Check the error details by using the task log.) Unidentified error
41: Error (An error has been detected in the component.) Property not entered (An error has been 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.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 |
R |
|
VMware.vmMonitoring |
Monitoring of a virtual server |
Specify the monitoring status of a virtual server. You can specify vmMonitoringDisabled, vmMonitoringOnly, vmAndAppMonitoring, or clusterSettings. |
-- |
Input |
R |
|
VMware.failureInterval |
Monitoring sensitivity (failure interval) |
Specifies the failure interval as a condition for determining the monitoring sensitivity. |
-- |
Input |
O |
|
VMware.minUpTime |
Monitoring sensitivity (minimum uptime) |
Specifies the minimum uptime as a condition for determining the monitoring sensitivity. |
-- |
Input |
O |
|
VMware.maxFailures |
Monitoring sensitivity (maximum number of resets per virtual server) |
Specifies the maximum number of resets per virtual server as a condition for determining the monitoring sensitivity. |
-- |
Input |
O |
|
VMware.maxFailureWindow |
Monitoring sensitivity (maximum period in which resets can occur) |
Specifies the maximum time period during which resets can occur as a condition for determining the monitoring sensitivity. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |