5.6.11 Obtain Status of Virtual Server
Function
This plug-in is used to obtain the statuses of virtual servers in a Hyper-V environment.
This plug-in requires the following servers:
- Hyper-V server (execution-target server)
A server on which Hyper-V is installed
- Virtual server
A virtual server managed by Hyper-V
The status of the virtual server is obtained and then stored as a numeric value in the property hyperv.vmState. To check the meaning of the stored value, see the line that begins with "vmState:" in the task log. To check this, you must set the logging level of the task log to 30 or 40, so that the default output items are logged.
Use situation
This plug-in can be used to check the statuses of virtual servers, so that the appropriate operation (such as starting, stopping, or deleting a virtual server) can be performed.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) Prerequisite products on the Hyper-V server
- Windows Server 2016 Hyper-V
(2) Prerequisite OS for the virtual server
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
Environments where Server Core/Nano Server is installed are excluded.
OSs for the prerequisite products on the execution-target server:
- Windows Server 2016 Standard/Datacenter
Environments where Server Core/Nano Server is installed are excluded.
Condition for using the prerequisite products on the execution-target server:
(1) The virtual server name must be unique within a single Hyper-V server.
Version
02.12.00
Plug-in tags
Gather VM information,Hyper-V 2016
Plug-in name displayed in the task log
hyperv2016GetVMState
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
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 |
-- |