5.5.10 Obtain the virtual server information list

Function

This plug-in outputs a CSV file containing a list of information about the virtual servers managed by the Hyper-V server.

The file is encoded in the default encoding of the system of the Hyper-V server.

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 following items are output to the file in CSV (comma-separated value) format:

(a) Name of the Hyper-V server (header name: ComputerName)

(b) Name of the virtual server (header name: VMName)

(d) CPU usage (%) of the virtual server (header name: CPUUsage)

(e) Size of the memory (in MB) allocated to the virtual server# (header name: MemoryAssigned)

(f) Running time of the virtual server (header name: Uptime)

(g) Status of the virtual server (header name: Status)

(h) Number of virtual processors on the virtual server (header name: ProcessorCount)

(i) Startup RAM (in MB) of the virtual server (header name: MemoryStartup)

(j) Whether dynamic memory is enabled on the virtual server (header name: DynamicMemoryEnabled)

#: Size of the memory (in MB) that is actually used by the virtual server

Use situation

This plug-in obtains information about the virtual servers managed by the Hyper-V 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 product for the system:

JP1/Automatic Operation 11-00 or later

Prerequisite products for the execution-target server:

(1) Prerequisite product for the Hyper-V server

- Windows Server 2012 Hyper-V, Windows Server 2012 R2 Hyper-V

(2) OS of the virtual server

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

Note: Environments where Server Core is installed are excluded.

Supported OSs for the prerequisite products on the execution-target server:

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

Note: Environments where Server Core is installed are excluded.

Conditions for using the prerequisite products on the execution-target server:

None.

Cautions

(1) If you specify the name of an existing file, the existing file will be overwritten. For this reason, make sure the specified file name is correct.

(2) If you specify a path that includes non-existent folders, those folders are automatically created. However, these folders are not automatically deleted when the file is deleted. Periodically delete these folders if they are unnecessary.

(3) If two or more virtual servers have the same name, you will not be able to distinguish these virtual servers in the output CSV file.

Version

02.00.00

Plug-in tags

Gather VM information,Hyper-V 2012

Plug-in name displayed in the task log

hyperv2012OutputVmSpec

Return code

0: Normal

12: Error (Mistake by user): Invalid property

23: Error (Invalid environment): The environment requirements are not met.

27: Error (Check the task log for details of the error): 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.vmInfoListOutputFileName	Virtual Server Information Output File	Specify the full path of the file to which the list of virtual server information is to be output.	--	Input	R
common.returnValue	Return value for the plugin	The return value of this plugin stored.	--	Output	--

To Page Top