ssoextractlog
Format
- To output collected data in text format:
ssoextractlog [-S connection-destination-server-name] -text [A | B | C | D | E | F | G | H] [1 | 2 | 3] {-logfile file-name | -masterlog resource-ID,collection-target-server-name | -dbname resource-ID,collection-database-name} [-instance instance-name,...] [-subrsc subresource-ID,...] [-start {DATE date-and-time | BDATE date | BMONTH month [,date]}] [-stop {DATE date-and-time | BDATE date | BMONTH month [,date]}] [-savefile file-name] [-notitle]
- To copy collection databases:
ssoextractlog [-S connection-destination-server-name] -bin {-logfile file-name | -masterlog resource-ID,collection-target-server-name | -dbname resource-ID,collection-database-name} [-instance instance-name,...] [-start {DATE date-and-time | BDATE date | BMONTH month [,date]}] [-stop {DATE date-and-time | BDATE date | BMONTH month [,date]}] [-savefile file-name] [-user user-information]
- To output a list of collection databases:
ssoextractlog [-S connection-destination-server-name] -list [-savefile file-name]
- Other:
ssoextractlog {? | ?id | ?text}
Function
The ssoextractlog command extracts collection data from an SSO collection database. You can output the extracted data as a text file. You can also copy specified data.
Options
-S connection-destination-server-name
Specifies a monitoring manager on which a collection database exists. Specify the host name or IP address in 255 bytes or less. If you omit this option, the command extracts the collected data of the server on which you executed the command.
-text [A | B | C | D | E | F | G | H] [1 | 2 | 3]
Extracts collected data in text format. You can specify the display type and delimitation type.
- display-type
-
Specifies an output unit and output item. Select A, B, C, D, E, F, G, or H as the display type. The default is A. The table below lists the output units and output items that can be specified.
Type
Output unit
Output item
A
Instance
Value per collection date, collection time, and sub-resource; maximum value, minimum value, and mean value per sub-resource
B
Instance
Value per collection date, collection time, and sub-resource; threshold (from Normal to Warning and from Warning to Critical); maximum value, minimum value, and mean value per sub-resource
C
Instance
Value, maximum value, and minimum value per collection date and sub-resource; maximum value, minimum value, and mean value per sub-resource
D
Instance
Value, maximum value, and minimum value per collection month and sub-resource; maximum value, minimum value, and mean value per instance
E
Subresource
Value per collection date, collection time, and instance; maximum value, minimum value, and mean value per instance
F
Subresource
Value per collection date, collection time, and instance; threshold (from Normal to Warning and from Warning to Critical); maximum value, minimum value, and mean value per instance
G
Subresource
Value, maximum value, and minimum value per collection date and instance; maximum value, minimum value, and mean value per maximum value, minimum value, and instance
H
Subresource
Value, maximum value, and minimum value per collection month and instance; maximum value, mean value, minimum value, and mean value per instance
- delimitation-type
-
Specifies a character for delimiting data.
1: Delimits by the comma
2: Delimits by the tab
3: Delimits by the space
The default is 1. The following shows an example of data output when A is specified as the display type and 1 as the delimition type.
-logfile file-name
Extracts data of the specified file name. If you specify the file name specified in the -savefile option as the file name in this option, specify .log at the end of the file name.
Specify the file name by its absolute path. You cannot specify this option together with the -S option.
-masterlog resource-ID,collection-target-server-name
Specifies the master database whose data you want to extract, by its resource ID and server name. Specify the server name by the server's host name or IP address in 255 bytes or less. Verify the resource ID and server name by using the -list option. You cannot specify this option together with the -S option.
-dbname resource-ID,database-name
Specifies the master database or copy database whose data you want to extract, by its resource ID and database name. Verify the resource ID and database name by using the -list option.
-instance instance-name,...
Extracts collected data of the specified instance. To specify multiple instances, delimit the instances with a comma (,). If you omit this option, the command extracts collected data of all instances. If the instance name includes a comma (,) enclose it in double quotation marks (" "). If the instance name includes double quotation marks, enclose the entire instance name in double quotation marks.
-subrsc subresource-ID,...
Extracts collection data by using the specified subresource ID. If you want to specify multiple subresource IDs, delimit them with commas (,). If you omit this option, all the subresource IDs are to be extracted.
For details about subresource IDs added to subresources of user resources, see 6.3.14(6)(d) Subresource ID.
For details about subresource IDs of resources provided by SSO, see E. Resource IDs.
-start {DATE date-and-time | BDATE date | BMONTH month[,date]}
Specifies the range of data to be extracted.
- DATE date-and-time
-
Starts extraction at the collected data for the specified date and time.
Specify the date and time in the format yyyy.mm.dd.hh.mm.ss. The specifiable range is January 1, 1980 00:00:00 to December 31, 2099 23:59:59.
- BDATE date
-
Starts extraction at data for 00:00:00 on the date preceeding the current date by the specified number of days. The specifiable range is 0 to 30 (days). If you specify 0, the command extracts data starting with data for 00:00:00 on the date the command is executed.
- BMONTH month[,date]
-
Starts extraction at data for 00:00:00 on the specified date of the month preceeding the current month by the specified number of months.
The specifiable range for the month is 0 to 12 (months). The specifiable range for the date is 1 to 31 (date). If you specify 0 for the month, the command extracts data for the month in which you executed the command.
If you do not specify date, the command extracts data from the first day of the month.
-stop {DATE date-and-time | BDATE date | BMONTH month[,date]}
Specifies the range of data to be extracted.
- DATE date-and-time
-
Extracts collected data up to the specified date and time.
Specify the date and time in the format yyyy.mm.dd.hh.mm.ss. The specifiable range is January 1, 1980 00:00:00 to December 31, 2099 23:59:59.
- BDATE date
-
Extracts data up to 23:59:59 on the date preceeding the current date by the specified number of days.
The specifiable range is 0 to 30 (days). If you specify 0, the command extracts data up to 23:59:59 on the date the command is executed.
- BMONTH month[,date]
-
Extracts data up to 23:59:59 on the specified date of the month preceeding the current month by the specified number of months.
The specifiable range for the month is 0 to 12 (months). The specifiable range for the date is 1 to 31 (date). If you specify 0 for the month, the command extracts data up to the month in which you executed the command.
If you do not specify date, the command extracts data up to 23:59:59 on the last day of the month.
-savefile file-name
-
Output to a text file (specify -text)
Specifies the file name to which you want to output the extracted data, by its absolute path. The command creates a file having the specified file name on the host on which you executed the command. If the specified file already exists, the command overwrites it.
If you omit this option, the command outputs the result to the standard output.
-
Copy (specify -bin)
Specifies the copy destination file by its absolute path. The command creates three files on the connection destination host. The files have the specified file name followed by .log, .inf, and .ins respectively. If the specified file already exists, the command overwrites it.
If you omit this option, the command creates a copy database. The copy database is created in the directory storing the collection database of the connection destination host. A file name is given to the database automatically when it is created. To create multiple copy databases, we recommend specifying the -user option to identify the databases.
You cannot omit this option if you specified -logfile or -masterlog.
-
To output the list of collection databases (with -list specified):
Specify a file name to which you want to output the list of collection databases by using its full pathname. The specified file is created on the host on which the command is executed. If the specified file name already exists, it is overwritten. If you omit this option, the result is output to the standard output.
When you create a file with the -text, -bin, or -list option specified, if the disk space is filled, an incomplete set of data is stored in the file (an error message is not output). Confirm that the disk has enough free space, and then execute the command.
-notitle
Deletes the title and summary value from the output result.
-bin
Copies collection databases.
-list
Outputs a list of collection databases. The following shows the output format for the list of collection databases.
-user user-information
Specify information which you want to add to a copy database in 255 bytes or less. Multi-byte codes cannot be specified for user information.
?
Outputs the command usage. This option cannot be specified together with other options.
?id
Outputs a list of resource IDs.
?text
Outputs the usage of the -text option.
Examples
The following shows examples of specifying the start and stop options.
-
The following example extracts data from December 15, 2000 00:00:00 to April 2, 2001 15:00:00:
-start DATE 2000.12.15.00.00.00 -stop DATE 2001.04.02.15.00.00
-
The following example extracts data of the previous week (Monday to Friday) on the date on which the command is executed (Friday):
-start BDATE 4 -stop BDATE 0
-
The following example extracts data from the first day of the current month to the last day of the month, on the last day of the current month:
-start BMONTH 0 -stop BMONTH 0
-
The following example extracts data from the 21st day of the month three months previously to the 20th day of the current month, on the 21st day of the current month:
-start BMONTH 3,21 -stop BMONTH 0,20
Return values
0 |
Normal termination |
-1 |
Execution error such as incorrect arguments |
Notes
-
If the disk becomes full while the file is being saved, only part of the data is saved in the file (no error message is output). Before saving data, verify that the disk has sufficient free space.
-
Notes on concurrently executing the ssodbdel command and the ssoextractlog command
Do not concurrently execute the ssodbdel command and the ssoextractlog command (during execution of one of the commands, you try to execute the other command). If these commands are concurrently executed, the ssoextractlog command outputs the following error message, and the processing might be interrupted if data extraction and copy are incomplete.
In such a case, after the ssodbdel command is completed, re-execute the ssoextractlog command.
The applicable database does not exist. Extraction of the collection database failed.
-
About the extraction time for the ssoextractlog command
The extraction time for the ssoextractlog command is different depending on the display type setting. In display types A to D, data is extracted for each instance. Accordingly, extraction time becomes longer in proportion to the number of instances. In display types E to H, data is extracted for each subresource. Accordingly, extraction time becomes longer in proportion to the number of subresources. Therefore, setting a larger one of the number of instances and the number of subresources will shorten extraction time.
-
Executing this command takes time in proportion to the size of the collection database. Therefore, make sure that you regularly delete collection data (either by deleting all data or by deleting part of the data by specifying a time period).
-
Fractional resource values are rounded to two decimal places.
-
If the date specified for the -start option and the -stop option is invalid (such as February 30), the operation becomes undefined.