5.11.27 Set the virtual server DRS group
Function
This plugin adds to or deletes a virtual server from the virtual server DRS group set up in a vSphere DRS cluster in a VMware vSphere environment.
If the virtual server DRS group specified for adding a virtual server does not exist, a new virtual server DRS group will be created.
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.
- DRS cluster
A vSphere DRS cluster, or a set of servers that make up a vSphere DRS cluster
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes the virtual server DRS group setup mode (VMware.setVmDrsGroupMode property).
- Specify "Add" to add a virtual server to the virtual server DRS group.
- Specify "Delete" to delete a virtual server from the virtual server DRS group.
Use situation
This plugin can be used to add to or delete a virtual server from the virtual server DRS group when the virtual server is added or deleted in a DRS cluster environment.
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 DRS 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 the 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.
- DRS cluster name
- Virtual server name
- DRS group names (host DRS group name and virtual server DRS group name)
(3) The vSphere DRS cluster must be created.
(4) The virtual server must belong to the vSphere DRS cluster specified by the DRS cluster name (VMware.drsClusterName property).
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 a registered virtual server name (for the VMware.vmName property) when adding a virtual server to the DRS group (specified by the VMware.vmDrsGroupName property), this plugin ends abnormally. Similarly, if you specify an unregistered virtual server name (for the VMware.vmName property) when deleting a virtual server from the virtual server DRS group (specified by the VMware.vmDrsGroupName property), this plugin ends abnormally.
(3) This plugin does not delete the virtual server DRS group. Therefore, if the number of virtual servers registered in the virtual server DRS group reaches zero as a result of deleting the virtual servers from the virtual server DRS group, 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
vsphereSetDrsVmGroup
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.drsClusterName |
DRS cluster name |
Specifies the name of the vSphere DRS cluster managed by VMware vCenter Server. |
-- |
Input |
R |
|
VMware.vmDrsGroupName |
Virtual server DRS group name |
Specifies the name of the virtual server DRS group to which you want to add or delete a virtual server. |
-- |
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.setVmDrsGroupMode |
Virtual server DRS group setting mode |
To add a virtual server to the virtual server DRS group, specify "Add". To delete a virtual server from the virtual server DRS group, specify "Delete". |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |