5.4.8 Obtain a virtual server information list
Function
This component outputs the list of the information on the virtual server under control of the Hyper-V server to a file in CSV format.
The encoding of the output file is the default encoding of the Hyper-V server system.
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.
The items in the output CSV file are shown below.
The items are separated by commas in the output file.
(a) Hyper-V server name (Header name: HostName)
(b) Virtual server name (Header name: VmName)
(c) Virtual server status#1 (Header name: VmState)
(d) Number of virtual server CPUs#2 (Header name: NumCpu)
(e) Virtual server memory size (MB)#3 (Header name: MemoryMB)
#1: For details on the virtual server status, see "List of statuses of virtual servers managed by Hyper-V" in the JP1/AO manual.
#2: The value for the number of CPUs is the number of virtual processors assigned to the virtual server.
#3: If dynamic memory is set for the virtual server, this is the value of the startup RAM.
Use situation
This can be used to obtain the information on the virtual server under control of the Hyper-V 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
hypervOutputVmSpec
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.)
28: Error (No information obtained) No virtual server exists.
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 |
|
common.fileName |
File name |
Specifies the file name as a full path. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |