Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Export Tool 2

Installing Export Tool 2

Installation of Export Tool 2 includes the following activities:

  • Verifying the system requirements for Export Tool 2
  • Installing the Export Tool 2 software on the management client
  • Configuring the Export Tool 2 properties file
  • Configuring the management client

System requirements for Export Tool 2

Before installing the Export Tool 2 software on the management client, verify that the management client meets the system requirements listed in the following table.

Item Requirements
Operating system Windows:
  • Windows 7 SP1 (32-bit, 64-bit)
  • Windows 8.1 (32-bit, 64-bit)
  • Windows 10 (32-bit, 64-bit)
  • Windows Server 2008 R2 SP1 (64-bit)
  • Windows Server 2012 SP1 (64-bit)
  • Windows Server 2012 R2 SP1 (64-bit)
  • Windows Server 2016 (64-bit)

Solaris:

  • Solaris 10 (32-bit)

Linux:

  • Red Hat Entperprise Linux AS v6.2 (64-bit)
  • Red Hat Entperprise Linux AS v7.3 (64-bit)
JRE JRE 8.0 or later
Hardware

Processor (CPU): Intel® Core™ i5-6600 processor or equivalent

Memory (RAM): 4 GB or larger1,2

Free storage capacity: 50 GB or larger1 (Free storage capacity is also required each time the exported data is compressed to create a CSV file.)

TCP/IP: 1 GB Ethernet or 10 GB Ethernet (1000BASE-T, 1000BASE-TX, 10GBASE-T)

Notes:

  1. To run Export Tool 2 for multiple storage systems at the same time, multiply the Free storage capacity requirement by the number of storage systems in order to calculate the total storage capacity required. 8 GB of memory is also required.
  2. If there are many resources (such as LDEVs or LUs), the memory required might be greater than 8 GB.
The following table shows the estimated used memory size, drive size, and time required for each configuration.
Model Number of LU paths Used memory Drive size Time required (All plots, CSV) Time required (All plots, ZIP)
VSP G350/VSP F350 5000 or less 1 GB 3 GB 1.0 hour 1.0 hour
10000 or less 1 GB 5 GB 1.0 hour 1.0 hour
Maximum or less 2 GB or more 30 GB 2.0 hours 2.5 hours
VSP G370/VSP F370/VSP G700/VSP F700/VSP G900/VSP F900 5000 or less 1 GB 3 GB 1.5 hours 2.0 hours
10000 or less 1 GB 5 GB 1.5 hours 2.0 hours
50000 or less 2 GB or more 30 GB 2.0 hours 2.5 hours
100000 or less 2 GB or more 50 GB 3.5 hours 4.5 hours
Maximum or less 2 GB or more 100 GB 7.0 hours 9.0 hours

Notes:

  • Used memory×4 or greater needs to be installed.
  • The time required depends on the machine specification.

Installing Export Tool 2 (Windows)

Before you begin

Procedure

  1. On the Windows computer, create a new directory to store the export tool program.

  2. Insert the installation media into the computer.

  3. Copy the \program\monitor2 directory in the installation media to the directory that you created in step 1. (Copy all directories and files including the \program\monitor2 directory under the directory.)

    The Export Tool 2 program is in the Java class file format (exportTool.jar), and it is located in the \program\monitor2 directory.

Installing Export Tool 2 (Linux or UNIX)

Before you begin

Procedure

  1. On the computer, create a new directory to store the export tool program.

  2. Mount the installation media.

  3. Copy the \program\monitor2 directory in the installation media to the directory that you created in step 1. (Copy all directories and files including the \program\monitor2 directory under the directory.)

  4. Give the execution authority to runUnix.sh. Use the command chmod a+x runUnix.sh to do this.

Configuring the Export Tool 2 properties file

Settings that are shared across commands are configured in the properties file. The content of the properties file is the same for Windows and Linux. The linefeed code of the properties file is <CR+LF> for both Windows and Linux. The following table describes the configurable settings available in the properties file.

Item Properties file setting Description Value
REST API connection information restapi.timeout Timeout Configurable value: 1 to 9999 (min.)

Default value: 1

restapi.maxRetryCount Maximum retry count Configurable value: 0 to 99 (0 indicates that it is tried again without limit)

Default value: 5

restapi.retryInterval Retry wait time Configurable value: 1 to 59 (min.)

Default value: 5

DUMP API connection information dumpapi.timeout Timeout Configurable value: 1 to 9999 (min.)

Default value: 20

dumpapi.maxRetryCount Maximum retry count Configurable value: 0 to 99 (0 indicates that it is tried again without limit)

Default value: 10

dumpapi.retryInterval Retry wait time Configurable value: 1 to 59 (min.)

Default value: 1

Storage connection information exportdata.protocol Protocol Configurable value: HTTP/HTTPS

Default value: HTTPS

exportdata.portNumber Port number Configurable value: 1 to 65535

Default value: 443

CSV output information exportdata.isCsvHeader Header line output Configurable value: TRUE/FALSE

Default value: TRUE

log.level Log level Configurable value: NORMAL/DEBUG

Default value: NORMAL

Log information log.directory Location of log output Configurable value: A maximum of 150 characters when a full path is specified.

To specify "\", specify "\\" (Example: C:\\log).

When specifying a relative path, consider the number of characters in a full path.

Default value: ./log

log.keepPeriod Log retention period Configurable value: 7 days to 365 days

Default value: 30

The following list shows the settings of the properties file available to you.

  • Storage connection information
  • CSV output information
  • Log information

Example of the properties file setting:

# ***Storage Connect properties***
exportdata.protocol=HTTPS
exportdata.portNumber=443
# ***CSV properties***
exportdata.isCsvHeader=TRUE
# ***Log properties***
log.level=NORMAL
log.directory=./log

Example of the properties file setting (including the API information settings):

# ***REST API properties***
restapi.timeout=1
restapi.maxRetryCount=5
restapi.retryInterval=5
# ***DUMP API properties***
dumpapi.timeout=20
dumpapi.maxRetryCount=5
dumpapi.retryInterval=2
# ***Storage Connect properties***
exportdata.protocol=HTTPS
exportdata. portNumber =443
# ***CSV properties***
exportdata.isCsvHeader=TRUE
# ***Log properties***
log.level=NORMAL
log.directory=./log
log.keepPeriod=30

Configuring the management client

Before using Export Tool 2, make sure that the PATH environment variable and command prompt on the management client are properly configured.

Procedure

  1. On the management client, verify that the PATH environment variable includes a path to the Java virtual machine (java.exe). If not, edit the PATH variable to add a path to the Java virtual machine.

    If the PATH environment variable does not include a path to the Java virtual machine, Export Tool 2 will not run.
  2. Open a command prompt, and verify that the screen buffer size height (in Properties > Layout) is set to at least 300.

    When the maximum number of plots (288) has accumulated in the storage system and you run the show range command, you cannot check the execution result in the command prompt if the screen buffer size height is less than 300.

Removing Export Tool 2

The procedure for removing Export Tool 2 is the same for both Windows and Linux.

Before you remove Export Tool 2, if the exported data, logs, and files that you edited are required, save them in another directory. To remove Export Tool 2, delete the directory that you created when you installed the tool. When you delete the directory, the exported data, logs, and files that you edited are also deleted.

Using Export Tool 2

After installing Export Tool 2, you must prepare a batch file before you can export any monitoring data.

Functions provided by Export Tool 2

Export Tool 2 provides numerous functions, allowing you to check or set the current sampling interval of accumulated data, check the retention period information of accumulated data, and output the performance metrics in the CSV format.

The following table shows the functions that are provided by Export Tool 2.

Function name Description
Sampling interval check function This function checks the current sampling interval of accumulated data.
Sampling interval setting function This function sets the sampling interval of accumulated data.

It is reflected to the next accumulation timing after the specified point.

The sampling interval of each plot accumulated before it is set is not changed.

Accumulated data period check function This function checks the retention period information of accumulated data at the current point of time.

Performance information can be output only in the period in which it is output by this function.

Information output by this function is used for narrowing down the period in the Performance metrics export function.

Performance metrics export function This function outputs performance metrics calculated by analyzing accumulated data in the CSV format.

Performance metrics are compressed in the ZIP format by default when they are output, but they can also be output in the CSV format.

Performance metrics of any period in the Accumulated data period check function can be output.

Help function This function displays help for commands that are provided by Export Tool 2.

Running Export Tool 2 using a batch file or shell file

To save monitoring data in files, launch Export Tool 2 by running the batch file or shell file.

Double-click the batch or shell file to run it.

Dots (...) appear on the screen until the system finishes exporting data. If an internal error occurs, an exclamation mark (!) appears and then Export Tool 2 restarts automatically.

Batch file and shell file contents for Export Tool 2

Use a batch file to run Export Tool 2, which starts and saves monitoring data in files when you run the batch file/shell file. Therefore, the batch file/shell files (runWin.bat and runUnix.bat respectively) for Windows and Linux are provided. If your computer runs Windows, use runWin.bat and if your computer runs UNIX, use runUnix.bat.

The following describes the contents of the batch file and the shell file. These batch files include a command line that runs a Java command. When you run the batch file, the Java command runs the subcommands specified in the command file and then saves monitoring data in files.

NoteIf Out of Memory occurs, increase the maximum heap memory size as needed (for example, -Xmx2g).

Batch file for starting Export Tool 2 for Windows (runWin.bat):

java -classpath "./exportTool.jar";"./external/log4j-core-2.7.jar";"./external/log4j-api
-2.7.jar";"./external/commons-codec-1.3.jar";"./external/lz4-1.3.0.jar"
 com.hitachi.exporttool.cli.Main %*<CR+LF>
<CR+LF> indicates the end of a command line.

Shell file for starting Export Tool 2 for Linux (runUnix.sh):

#! /bin/sh<LF>
java –classpath
"./exportTool.jar":"./external/log4j-core-2.7.jar":"./external/log4j-api-2.7.jar":"./external/commons-
codec-1.3.jar":"./external/lz4-1.3.0.jar" com.hitachi.exporttool.cli.Main "$@"<LF>
<LF> indicates the end of a command line.

Outputting the performance information file

The performance information file is output either in the CSV or ZIP format, depending on the setting of the “-option” parameter of the export data command.

The performance information file contains the following information:

  • Date: Date on which the performance data was recorded (YYYY/MM/DD)
  • Time: Time at which the performance data was recorded (HH:MM)
  • ID: Resource ID (for example, CL1-A when "port" was specified)
  • <performance metric>: Description of the calculated performance data (for example, Total_IOPS, Write_Pending_Rate)

When you output the performance information file, a separate file called "export_metadata.csv" is also output to the same directory as the performance information file. This metadata file contains the following information that identifies the data in the performance information file:

  • Serial number: 6-digit serial number of the storage system
  • Product name: Product name of the storage system (for example, VSP G700)
  • From: Start date and time (YYYY/MM/DD HH:MM) of the data in the performance information file (specified by the -range parameter of the export data command)
  • To: End date and time (YYYY/MM/DD HH:MM) of the data in the performance information file (specified by the -range parameter of the export data command)
  • Sampling: sampling interval (minutes) of the data in the performance information file

The following example shows the meta information file output.

“Serial Number”,”Product Name”,”From”,”To”,”Sampling”
"410025",”VSP G700”,”2017/04/13 15:00”,”2017/04/14 15:00”,”5”

The following example shows output of the CSV file.

"Date","Time","ID","Total_IOPS"
"2017/07/10","18:00","CL1-A/1122334455667788<HOST_A>","10"
"2017/07/10","18:00","CL1-A/1122334455667788<HOST_A>","10"
"2017/07/10","18:00","CL1-A/1122334455667788<HOST_A>","10"

SAS Port#

The resource “SAS Port#” that is output by the MP group can be converted to the package location (PK LOC) format. The following table describes the correspondence between PK LOC and SAS Port#, so that you can calculate “PK LOC”.

PK LOC VSP G900/VSP F900 VSP G700/VSP F700 VSP G350/VSP F350, VSP G370/VSP F370
SAS Port# (port0,port1 in SAS) SAS Port# (port0,port1 in SAS) SAS Port# (port0,port1 in SAS)
1A
1B
1C 0x00,0x01
1D
1E 0x04,0x05
1F 0x06,0x07
1G 0x00,0x01 0x00,0x01
1H 0x02,0x03 0x02,0x03
2A
2B
2C 0x08,0x09
2D
2E 0x0C,0x0D
2F 0x0E,0x0F
2G 0x08,0x09 0x08,0x09
2H 0x0A,0x0B 0x0A,0x0B

Return codes

The following table shows Export Tool 2 return codes. The following return codes are common to all functions (all commands).

Return code Description
0 Normal end
1 If the command is tried again without changing the parameter, it might succeed.
2 The function does not end normally unless you remove the cause of the failure, such as changing the parameter. For example:
  • The password of the account of the storage system is incorrect.
  • Command analysis failed.
  • The properties file is corrupted, or reading it failed.
3 The Storage Administrator (performance management) or Support Personnel (Vendor Only) role is not assigned.

 

  • Was this article helpful?