Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


3.9.5 Obtain virtual server information list

Function

This service template obtains a list of information about virtual servers in a Hyper-V environment.

This service template requires the following servers:

- Hyper-V server

A server on which Hyper-V is installed

- Virtual server

A virtual server managed by Hyper-V

The following is an overview of the processing:

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

(2) The temporary file on the remote PC is transferred to an output file on the local PC.

(3) The temporary file on the remote PC is deleted.

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)

(c) State of the virtual server (header name: State)

(d) CPU usage (%) of a 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

Prerequisites

For the most recent information about the prerequisite products for the system, prerequisite products for the system executing the service templates, and the supported OSs for the prerequisite products for the system executing the service templates, see the Release Notes.

Prerequisite product for the system:

JP1/Automatic Operation 12-00 or later

Prerequisite products in the system executing the service template:

(1) Prerequisite product for the Hyper-V server

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

Supported OSs for the prerequisite products in the system executing the service template:

(1) OS of the Hyper-V server

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

Note: Environments where Server Core is installed are excluded.

(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.

Conditions for using the prerequisite products on the system executing the service template:

None.

Cautions

(1) If you specify an existing file for the remote or local file, the existing file will be overwritten. In addition, the file on the remote PC will be deleted, so make sure the specified file name is correct.

(2) If you specify a remote file path that includes non-existent folders, those folders are automatically created. These folders are not automatically 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

Tags

Gather VM information,Hyper-V 2012

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 information about the Hyper-V server.

Y

Output file storage information

Specify the storage destination for the file to be output.

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 the name of the file (in full-path format) that contains the virtual server information to be saved to the local server.

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

Plug-in name

Description

Error recovery method

1

hyperv2012GetVMInfo

Obtain virtual server information list

Outputs a list of virtual server information to a temporary file on the Hyper-V server.

After removing the cause of the error, run the service again.

2

FileTransferPlugin

File-Forwarding Plug-in

Forwards a remote temporary file to the specified local output file.

Forward the temporary file from the Hyper-V server to the local server, and then delete the temporary file from the Hyper-V server.

3

osDeleteFile

Delete file

Deletes a remote temporary file.

Manually delete the temporary file from the Hyper-V server.