5.4.9 Obtain the virtual server status
Function
This component obtains the virtual server status in the Hyper-V environment.
The following servers are required for this component:
- Hyper-V server (Execution target server)
This is the server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
Stores the value for the obtained virtual server status in the hyperv.vmState property.
For details on the relationship between the value to be stored and the virtual server status, see "List of statuses of virtual servers managed by Hyper-V" in the JP1/AO manual.
Use situation
This component can be used to check the virtual server status and to take action according to the status, such as starting, stopping, or deleting the virtual server.
Prerequisites
For the latest support information about [Required product in the 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-00 or later
[Required products on the execution target server]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
(2)Prerequisite OS running in the virtual servers
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Prerequisite product OS running in the execution target server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions for required products on the execution target server]
(1) The virtual server name must be unique within the Hyper-V server.
Version
02.00.00
Plug-in tags
Gather VM information,Hyper-V 2008
Plug-in name displayed in the task log
hypervGetVMState
Return code
0: Normal
12: Error (Mistake by user) A property is invalid.
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check the task log for error details.)
41: Error (An error was detected in the component.) A property was 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 |
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 |
O |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |