3.16.1 Get List of Storage Systems from Device Manager
Function
Obtains a listing of storage information.
• If no serial number is specified, the service template obtains information about all storage systems managed by the specified HDvM server.
• If a serial number is specified, the service template obtains information about only the storage system with the specified serial number.
This service template assumes the following servers:
• HDvM server
This is a server on which Hitachi Device Manager Software is installed.
• HDvM CLI server
This is a server on which Hitachi Device Manager Software CLI is installed.
The following provides an overview of the processing.
(1) Outputs a listing of virtual server information in CSV format to a temporary file in the remote system.
(2) Forwards the temporary file from the remote system to a specified output file on the local system.
(3) Deletes the temporary file from the remote system. The service template outputs the following items to a CSV file (the items are separated by the comma):
Below are the items in the CSV file that is output.
The items are separated by commas when they are output.
(a) Serial number (header name: serialnum)
(b) Family name (header name: family)
(c) Pool ID of the DP pool (header name: poolID)
(d) Capacity of the DP pool (KB) (header name: capacityKB)
(e) Free space in the DP pool (KB) (header name: freeCapacityKB)
(f) DP pool usage rate (header name: usageRate)
Prerequisites
For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
Job Management Partner 1/Automatic Operation 12-00 or later
[Required products for the service template execution system]
(1) The product listed below must have already been set up on the servers in the system. Also, Hitachi Device Manager Software CLI must have already been set up on the HDvM CLI server.
• Hitachi Device Manager Software 07-00 or later
(2) One of the products listed below must have already been set up as the system's storage system (it must be an FC-SAN storage):
• Hitachi Adaptable Modular Storage 2100/2300/2500/2010
• Hitachi Unified Storage 110/130/150
• Hitachi Unified Storage VM
• Hitachi Universal Storage Platform V/VM
• Hitachi Virtual Storage Platform
• Hitachi Virtual Storage Platform G1000/G1500/F1500
• Hitachi Virtual Storage Platform G200/G400/G600/G800
• Hitachi Virtual Storage Platform F400/F600/F800
[Prerequisite product OS running in the system executing the service template]
(1) Required OS for the HDvM CLI server
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
[Usage conditions for the required products for the service template execution system]
(1) The storage system is managed by Hitachi Device Manager Software.
(2) DP pools and host groups have already been created in the storage system.
Cautions
(1) A storage system being updated is not included in the listing file.
(2) The contents of the listing file are not sorted. If necessary, you can sort the contents when you view the file.
(3) If the file name specified for the remote or the local system already exists, that file will be overwritten. in addition the file in the remote system will be deleted. For this reason, you should make sure that the specified file names are correct.
(4) If there is no folder on the specified path in the remote system, such a folder will be created. A folder that is created will remain and will not be deleted; for this reason, you should delete unneeded folders periodically
Execution privilege
(1) The user who will be connecting to Device Manager must belong to a user group with the following permissions:
User group with All Resources assigned as the resource group and Admin, Modify, or View permissions granted
Version
02.00.00
Tags
Gather Storage information,Device Manager
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
HDvM environment information |
Specify the HDvM information. |
Y |
|
Storage information |
Specify the storage information to be acquired. |
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 |
|---|---|---|---|---|---|---|
|
hdvm.targetHost |
Host name of Device Manager CLI server |
Specify the host name or IP address of the server where Device Manager CLI is installed. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.cliInstallPath |
Installation path of Device Manager CLI |
Specify the installation path of Device Manager CLI. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.hdvmProtocol |
Protocol for HDvM communication |
Specify the protocol (http or https) to use when connecting to Device Manager server. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.hdvmHostName |
HDvM server host name |
Specify the host name or IP address of the Device Manager server. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.hdvmPortNumber |
Port number for HDvM connection |
Specify the port number used to connect to the Device Manager server. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.hdvmUserName |
User name for HDvM connection |
Specify the user ID to use when connecting to Device Manager server. |
Input |
Disabled |
R |
HDvM environment information |
|
hdvm.hdvmPassword |
Password for HDvM connection |
Specify the password to use when connecting to Device Manager server. |
Input |
Disabled |
R |
HDvM 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 |
|---|---|---|---|---|---|---|
|
hdvm.hdvmSerialNumber |
Storage system serial number |
Specifies the serial number of the storage system to be retrieved from. |
Input |
Disabled |
O |
Storage information |
|
hdvm.listOutputFileNameRemote |
Output file name (remote) |
Specifies the full path name of the temporary file for outputting storage information to the HDvM CLI server. |
Input |
Disabled |
R |
Storage information |
|
hdvm.listOutputFileNameLocal |
Output file name (local) |
Specifies the full path name of the file on the local server for acquiring the storage information. |
Input |
Disabled |
R |
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 |
|---|---|
|
hdvm.targetHost |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
hdvm.cliInstallPath |
A character string of no more than 1024 characters can be entered. It cannot include <, >, |, ;, &, ^. |
|
hdvm.hdvmProtocol |
Select one of the following values: http,https |
|
hdvm.hdvmHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
hdvm.hdvmPortNumber |
Integer between 1 and 65553 can be entered. |
|
hdvm.hdvmUserName |
A character string of between 1 and 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as !, #, $, %, ', (, ), *, +, -, ., =, @, \, ^ and _. It cannot include a trailing \. |
|
hdvm.hdvmPassword |
A character string of between 4 and 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as !, #, $, %, ', (, ), *, +, -, ., =, @, \, ^ and _. It cannot include a trailing \. |
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 |
|---|---|
|
hdvm.hdvmSerialNumber |
Alphanumeric between 1 and 20 characters. |
|
hdvm.listOutputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, /, ^, or a trailing \. |
|
hdvm.listOutputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, 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 |
storageGetInfo |
Get storage information list |
Outputs a list of storage information to a temporary file on the HDvM CLI server. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
fileTransfer |
File-forwarding plug-in |
Transfers a remote temporary file to the specified local output file. |
Eliminate the cause of the error, and then re-execute the service. |
|
3 |
osDeleteFile |
Delete file |
Deletes the remote temporary file. |
Eliminate the cause of the error, and then re-execute the service. |