3.7.5 Obtain the virtual server information list

Function

This service template obtains the virtual server information list in the Hyper-V environment.

The following servers are required for this service template:

- Hyper-V server

This is the server where Hyper-V is installed.

- Virtual server

This is a virtual server managed by Hyper-V.

An overview of the processing is as follows.

(1) The virtual server information list is output to a specified remote temporary file in CSV format. The encoding format of the output file uses the default encoding of the Hyper-V server system.

(2) The remote temporary file is transferred to a specified local output file.

(3) The remote temporary file is deleted.

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)

(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 this product 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 to the virtual server, this is the value of the startup RAM.

Prerequisites

For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.

[Required product in the System]

JP1/Automatic Operation 12-00 or later

[Prerequisite products in the system executing the service template]

(1)Prerequisite product of Hyper-V Server

- Windows Server 2008 R2 Hyper-V

[Prerequisite product OS running in the system executing the service template]

(1) Prerequisite OS of Hyper-V Server

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

This does not apply to Server Core installation environments.

(2) Prerequisite OS of the virtual server

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

This does not apply to Server Core installation environments.

[Usage conditions of prerequisite products in the system executing the service template]

(1) The virtual server name must be unique within the Hyper-V server.

Cautions

(1) If a file name specified remotely or locally already exists, the existing file is overwritten. Also, the files on the remote side are deleted. For this reason, carefully check that there are no mistakes in the specified file name.

(2) If a folder with the path specified remotely does not exist, the folder is created. The created folder remains and is not deleted. Delete unused folders on a regular basis.

Version

02.00.00

Tags

Gather VM information,Hyper-V 2008

Property list

The following shows the list of the property groups set in the property:

Property group	Description	Initial display
Virtual system environment information	Specify the Hyper-V information.	Y
Output file storage information	Specify the storage location of the output file.	Y

The following shows the list of the properties to be displayed in the "Service Definition" window:

(Legend)

R: The property must be specified.

O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.

Property key	Property name	Description	I/O type	Shared	Required	Property group
hyperv.targetHost	Hyper-V server host name	Specifies the host name or IP address of the Hyper-V server. IPv6 addresses are not supported.	Input	Disabled	R	Virtual system environment information

The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
hyperv.listOutputFileNameRemote	Output file name (remote)	Specifies, as a full path, the temporary file name for when virtual server information is output to the Hyper-V server.	Input	Disabled	R	Output file storage information
hyperv.listOutputFileNameLocal	Output file name (local)	Specifies, as a full path, the file name of the local server that obtains the virtual server information.	Input	Disabled	R	Output file storage information

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

Property key	Characters that can be input
hyperv.targetHost	Enter up to 256 halfwidth alphanumeric characters. You can also use periods (.) and hyphens (-).

The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Characters that can be input
hyperv.listOutputFileNameRemote	Enter a character string of up to 256 characters. The character string must not end with a backslash (\) or contain the following characters: < > \| ; & * ? " % / ' [ ] `
hyperv.listOutputFileNameLocal	Enter no more than 256 characters. Do not include the following characters: < > \| ; & * ? " % or a trailing \ or /

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
Hierarchy	Display name	Plug-in name	Description	Error recovery method
1	hypervGetInfo	Obtain a virtual server information list	Outputs the virtual server information list to a temporary file of Hyper-V server.	After removing the cause of the error, run the service again.
2	fileTransferPlugin	File-Forwarding Plug-in	Transfers the remote temporary file to an output file specified locally.	The file transfer failed. Transfer and then delete the temporary file in the Hyper-V server specified in the hyperv.listOutputFileNameRemote property.
3	osDeleteFile	Delete file	Deletes the remote temporary file.	The file specified in the hyperv.listOutputFileNameRemote property in the Hyper-V server still remains. Delete it manually.

To Page Top