5.11.33 Shut down virtual server
Function
Shuts down the OS of a virtual server in a VMware vSphere environment.
This plugin assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed.The plugin is sent to this server by JP1/AO and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESX.
When the virtual server is stopped, the process of waiting the number of seconds specified in the VMware.checkPowerStateInterval property and then verifying that the power state is OFF is repeated the number of times specified in the VMware.checkPowerStateCount property. If the default values do not work properly, adjust the values to suit your environment.
If the plugin terminates normally, it sets "PoweredOff" in the VMware.powerState output property.
Use situation
You use this plugin to shut down a virtual server.
The shutdown processing involves execution of the vsphereGetPower plugin, followed by execution of this plugin if the power status is "PoweredOn".
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target system]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-10 or later
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages the virtual servers
• VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0 or VMware ESX Server 4.1, 4.0
(3) Prerequisite OS running in the virtual servers
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual 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
• Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
• Red Hat Enterprise Linux Server 7 (64-bit x86_64)
• Red Hat Enterprise Linux Server 8 (64-bit x86_64)
• CentOS 6 (64-bit x86_64)
• CentOS 7 (64-bit x86_64)
• CentOS 8 (64-bit x86_64)
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2) The virtual server is running.
(3) The virtual server name is unique among the vCenter servers.
(4) VMwareTools has been installed on the target virtual server.
[Required products on the execution target server]
• VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 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
[Prerequisite product OS running in 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
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with power-off permission for the target virtual server or system administrator role
Version
02.11.00
Plug-in tags
Control VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetPowerOff
Return code
0: Normal
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
29: Error (shutdown termination verification error) Termination of shutdown process cannot be verified
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
VMware.vCenterServerName |
VMware vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
-- |
Input |
R |
|
VMware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for VMware vCenter Server connection |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
443 |
Input |
O |
|
VMware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
https |
Input |
R |
|
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
-- |
Input |
R |
|
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.checkPowerStateCount |
Power status check count |
Specify the number of times to check the power status when confirming that the virtual server is stopped. In combination with the power status checking interval, this determines the maximum wait time. |
60 |
Input |
R |
|
VMware.checkPowerStateInterval |
Power status check interval |
Specify the interval in seconds for checking the power status when confirming that the virtual server is stopped. |
10 |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
|
VMware.powerState |
Power state of the virtual server |
This property is used to store the power state of the specified virtual server. |
-- |
Output |
O |