The export data command exports the performance data for the CUs being monitored. The data can be exported as (uncompressed) CSV files or as a compressed ZIP file. You can export performance data for any period of time within the available timeframe. To set the time period for which data is collected, use the set interval command.
The export data command outputs two types of CSV files:
- CSV file for performance information
- CSV file for meta information (export_metadata.csv)
If an error occurs and the export data command is terminated, or when the command is interrupted by pressing Ctrl+c, files that were already output are not deleted.
Syntax
Windows:
runWin.bat export data -ip <ip-address> [-login <user-name> <password>] [-proxy {<ip-address> | <host-name>} <port-number> <user-name> <password>] [-outpath <output-directory>] [-range <stored-data-range>] [-group <group-name>] [-option <option-contents>]
UNIX:
runUnix.sh export data -ip <ip-address> [-login <user-name> <password>] [-proxy {<ip-address> | <host-name>} <port-number> <user-name> <password>] [-outpath <output-directory>] [-range <stored-data-range>] [-group <group-name>] [-option <option-contents>]
Options and parameters
- -ip {ip-address | host-name}
Specifies the service IP address (IPv4 or IPv6 format) or host name.
- -login <user name> <password>
Specifies the user name and password of the Export Tool 2 user. If this option is omitted, you are prompted to enter your user name and password.
- -proxy <IP address or host name> <port number> <user name> <password>
If the management client is connected to the storage system through a proxy server, this option specifies the proxy information (IP address [IPv4 or IPv6 format] or host name, port number, user name and password). If <user name> and <password> are omitted here, but <user name> and <password> are specified for the -login parameter, the proxy is used without authentication. If <user name> and <password> are omitted and the -login parameter is omitted, you are prompted to enter the user name and password for the proxy server.
- -outpath
This option defines the output path of the files to export.
A maximum of 150 characters can be used when specifying a full path.
When specifying a relative path, consider the number of characters in a full path.
When this option is omitted, the files are output to the monitor2\out directory.
- Relative paths are supported.
- Output to a network drive is not supported.
- To include a space in a path, enclose it in double quotation marks ("" "").
- To specify "\", specify "\\").
- If the specified directory does not exist, the directory is automatically created.
This parameter is optional.
- -range
Format: YYYYMMDDHHMM：YYYYMMDDHHMM
This parameter defines the range of accumulated data you want to export (specifies date and time).
All data that was accumulated in the specified range (date and time) is output.
When this parameter is not specified, all data accumulated in the storage system is exported (up to 1440 plots).
Because performance values are obtained from differences in accumulated data, the output performance values are reduced by 1 plot. (Time at the head is not output.)
This parameter is optional.
- -group
This parameter defines the performance metrics group name of the accumulated data you want to export.
Specify one of the following performance metrics group names for the accumulated data you want to export:
- MPU
- Cache
- ParityGroup
- LDEV
- LU
- Port
- PortError
- BackendPort
- TrueCopy
- UR
- ACCL ("ACCL" indicates ACLB)
You can specify group names in any order. To specify multiple groups, use a space to separate the group names (for example, MPU Cache ParityGroup). When this parameter is not specified, accumulated data for all groups is exported.
- -option
This parameter specifies the option to export data.
You can specify one or more of the following options in any order:
- Whether to delete a file in the save directory.
ask: Ask the user whether to delete a file or subdirectory (in the save directory) that has the same name as the output file.
clear: Delete both CSV and ZIP files (in the save directory) that have the same name as the output file.
When this parameter is not specified, the process is the same as when you specify clear.
- Whether to compress exported data
compress: Compresses data (ZIP format)
nocompress: Does not compress data
When this parameter is not specified, the process is the same as when you specify compress.
- Whether to list the resource ID per row or per column
resourceid_on_row: Lists the resource ID in a row for the exported data
When this option is specified, the ID of a resource (for example, port) is listed in a row in the exported data (CSV file for performance information). Therefore, each record contains performance information for each collection time and resource.
Example CSV file output:"Date","Time","ID","Total_IOPS" "2024/04/10","18:00","CL1-A/1122334455667788<HOST_A>","10" "2024/04/10","18:00","CL1-A/1122334455667788<HOST_A>","10"
resourceid_on_column: Lists the resource ID in a column for the exported data
When this option is specified, the ID of a resource (for example, port) is output in multiple rows in the exported data (CSV file for performance information). Therefore, each record contains performance information for multiple resources collected at the same time.
When neither of these options is specified, the output is the same as when you specify resourceid_on_row.
Example CSV file output:Total_IOPS.csv Serial Number : 810025(VSP One B26) From : 2024/03/20 23:40 To : 2024/03/20 23:45 Sampling : 5 "Date","Time","CL1-A/1122334455667788<HOST_A>","CL1-A/ 1122334455667788<HOST_B>" "2024/03/20","23:40","10","10" "2024/03/20","23:45","10","10"
- Whether to delete a file in the save directory.
Output example
In this example, the service IP address is IPv4 address with 192.168.0.100, the user ID is User, the password is Pass, the data export target is c:\\exportlog, the export range is from 12:00 on April 6th, 2024 to 13:00 on April 6th, 2024, the performance metrics group is MPU ParityGroup LDEV LU PortPortError BackendPort TrueCopy UR, and the options are nocompress and clear.
c:\export> runWin.bat export data -ip 192.168.0.100 -login User Pass -outpath c:\\exportlog -range 202404061200:202404061300 - group MPU ParityGroup LDEV LU Port PortError BackendPort TrueCopy UR -option nocompress clear
Output results:
Start export performance data +----+----+----+----+----+----+----+----+----+----+ ================================> 65.0%
CSV file format
The format of the performance information CSV file differs depending on the value specified for the -option parameter (resourceid_on_row or resourceid_on_column). When neither is specified, the output format is the same as when resourceid_on_row is specified.
- When resourceid_on_row is specified, each record is output for each collection time and resource. You can modify certain aspects of the CSV file format by editing the exportTool.properties file.
- To determine whether the CSV header is included, set the value for the exportdata.isCsvHeader parameter. The default setting value is "output".
The following shows the content of the CSV header.
"Date", "Time", "ID", "metrics name"
- The record format is as follows:
"YYYY/MM/DD","HH:MM","Resource ID","Performance value"
- The record placement is one line per record.
The following shows an output example of the CSV file:
"Date","Time","ID","Total_IOPS" "2024/04/10","18:00","CL1-A/1122334455667788<HOST_A>","10" "2024/04/10","18:00","CL1-A/1122334455667788<HOST_A>","10" "2024/04/10","18:00","CL1-A/1122334455667788<HOST_A>","10"
- When resourceid_on_column is specified, one line contains performance information of multiple resources collected at the same time.. You can modify certain aspects of the CSV file format by editing the exportTool.properties file.
- To determine whether the CSV header is included, set the value for the exportdata.isCsvHeader parameter. The default setting value is "TRUE". If you specify FALSE (meaning that the CSV header is not included), an error occurs when the export data command runs.The CSV header includes the following information:
CSV file name Serial Number: <Serial number>(<Storage model name>) From: To: Sampling "Date", "Time", "Resource ID",…," Resource ID "
- The record format is as follows:
"YYYY/MM/DD","HH:MM","Performance value", ..., "Performance value"
- The record placement is one line contains performance information of multiple resources collected at the same time.The following shows an output example of the CSV file:
Total_IOPS.csv Serial Number : 810025(VSP One B26) From : 2024/03/20 23:40 To : 2024/03/20 23:45 Sampling : 5 "Date","Time","CL1-A/1122334455667788<HOST_A>","CL1-A/ 1122334455667788<HOST_B>" "2024/03/20","23:40","10","10" "2024/03/20","23:45","10","10"
Note: The CSV file includes the following IDs that identify the product model names:- VSP One B24
- VSP One B26
- VSP One B28
- To determine whether the CSV header is included, set the value for the exportdata.isCsvHeader parameter. The default setting value is "TRUE". If you specify FALSE (meaning that the CSV header is not included), an error occurs when the export data command runs.
- To determine whether the CSV header is included, set the value for the exportdata.isCsvHeader parameter. The default setting value is "output".