5.6.4 Shut down a virtual server
Function
This plug-in forcibly shuts down the OS of the virtual server in a Hyper-V environment.
The following describes the servers that this plug-in requires:
- Hyper-V server (execution target server)
A server on which Hyper-V is installed.
- Virtual server
A virtual server managed by Hyper-V.
Use situation
This plug-in can be used to shut down the OS of a virtual server.
Prerequisites
For the most recent information about the prerequisite products for the system, 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-00 or later
Prerequisite products for the execution-target server:
(1) Prerequisite products for the Hyper-V server
- Windows Server 2016 Hyper-V
(2) Prerequisite OS for the virtual server
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
Conditions for using prerequisite products on the execution target server:
(1) The virtual server name must be unique within the Hyper-V server.
(2) The following service of Hyper-V Integration Service on the target virtual server must be active:
- Operating system shutdown
(3) The virtual server has been started.
Cautions
(1) This plug-in forcibly shuts down the OS of the specified virtual server. If this plug-in is used, the data in the files being edited on the virtual server is not saved.
Version
02.12.00
Plug-in tags
Control VM,Hyper-V 2016
Plug-in name displayed in the task log
hyperv2016ShutdownVM
Return code
0: Normal
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
28: Error (Invalid status change of the virtual server) A change to the virtual service status was invalid
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 |
|
hyperv.vmName |
Virtual server name |
Specifies the name of the virtual server. (This is the name of the virtual server as it is displayed in Hyper-V. This is not the host name in the OS.) |
-- |
Input |
R |
|
hyperv.vmState |
Virtual server status |
Stores the status of the virtual server. |
-- |
Output |
-- |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |