Job Management Partner 1/Software Distribution Administrator's Guide Volume 2
4.13 dcmmonrst.exe (storing operating information in a database)
This section explains the dcmmonrst command, which stores operating information (suppress history and operation history) collected by JP1/Software Distribution in a database so that the operating information can be managed from the Operation Log List window.
You can execute this command in the managing server system for JP1/Software Distribution Manager. Note that this command cannot be executed when the Store the operation monitoring history in the JP1/SD database check box is cleared on the Operation Monitoring page in the setup.
- Organization of this section
- (1) Function
- (2) Format
- (3) Arguments
- (4) Return codes
- (5) Notes
- (6) Example
(1) Function
This command stores the suppress history and operation history collected by JP1/Software Distribution in the netmdm_monitoring_security table so that the information can be managed in the Operation Log List window.
- Storing operating information using automatic storage
- If the settings below have been specified on the Operation Monitoring page in the setup, you can store operation information in the database whose retention period has elapsed by executing the dcmmonrst command:
- Save the operation monitoring history check box is selected
- Store the operation monitoring history in the JP1/SD database check box is selected
- Enable automatic storage check box is selected
- Executing the dcmmonrst command places a hold status on the stored database information, and disables subsequent operation of the periodic storage execution process. However, you can still use this command to store operating information.
- To release the hold status, execute the dcmmonrst command with the /r argument specified. This releases the hold status and re-enables the periodic storage execution process. Note that when you execute the dcmmonrst command with /r specified as an argument, operating information whose retention period specified at setup has elapsed is deleted from the database. Therefore, after you have finished storing the operating information, check the operation log in the Operation Log List window before you execute the dcmmonrst command with the /r argument specified.
- You can delete operating information stored in the database by executing this command with the /c argument specified. However, with the /c argument, if the database information is in hold status, the hold status is not released even if you delete the operating information.
- While storage or deletion of operating information is being performed via periodic execution or by means of a command, you can cancel the process by executing the dcmmonrst command with the /r argument specified. However, if you cancel a storage or deletion process, the operating information whose retention period specified at setup has elapsed is deleted from the database. If you cancel storage being performed via periodic execution, storage restarts the next time a periodic execution process executes. If you cancel a storage or deletion operation performed by means of a command, the next storage or deletion operation performed with the command executes normally. If you restart the Remote Install Server service, the hold status is released without requiring you to execute the dcmmonrst command with the /r argument specified, and execution periodic storage is enabled. This operation also deletes from the database operating information whose retention period has elapsed.
- If you execute the dcmmonrst command with the /s argument specified in order to store operation information, you can output the processing status by specifying the /n argument.
- Manually storing operating information
- If the settings below have been specified on the Operation Monitoring page in the setup, you can store the operating information in the database by executing the dcmmonrst command with the /x argument specified:
- Save the operation monitoring history check box is selected
- Store the operation monitoring history in the JP1/SD database check box is selected
- Compress and move the operation history to the storage directory radio button is selected
- Enable automatic storage check box is cleared
- Note that the stored operating information accumulates in the database unless it is deleted by the dcmmonrst command with the /c argument specified.
- Operating information that has been stored once will not be stored again by subsequent execution of this command, unless you execute the dcmmonrst command with the /z argument specified.
- If you execute the dcmmonrst command with the /x argument specified in order to store operation information, you can output the processing status by specifying the /n argument.
(2) Format
- Storing operating information whose retention period has elapsed when automatic storage is being used
dcmmonrst.exe [/h connection-destination] [/u user-ID-of-administrator]
[/p password] /s start-date
[/e end-date] [/d operation-history-backup-directory]
{ [/H host-name] | [/I IP-address] }
[/n output-units-count]
- Releasing the database hold status or canceling storage processing
dcmmonrst.exe [/h connection-destination] [/u user-ID-of-administrator]
[/p password] /r
- Storing operating information when manual storage is being used
dcmmonrst.exe [/h connection-destination] [/u user-ID-of-administrator]
[/p password] /x [/d operation-history-backup-directory]
[/s start-date] [/e end-date]
{ [/H host-name] | [/I IP-address] }
[/n output-units-count]
- Storing operating information again after it has been stored once
dcmmonrst.exe [/h connection-destination] [/u user-ID-of-administrator]
[/p password] /z [/d operation-history-backup-directory]
{ [/H host-name] | [/I IP-address] }
- Deleting operating information stored in a database
dcmmonrst.exe [/h connection-destination] [/u user-ID-of-administrator]
[/p password] /c deletion-date
(3) Arguments
- /h
Specify the host name or IP address of the managing server system to be connected in 64 characters or fewer. If this argument is omitted, localhost is used.
- /u
Specify the user ID of the administrator of the database to be connected in 30 characters or fewer. If this argument is omitted, this value defaults to the user ID of the administrator that was specified on the Database Environment page during setup.
- /p
Specify the password of the database to be connected in 30 characters or fewer. If a password has not been set, this argument can be omitted.
- /s
Specify the date on which storage to the database is to start. Operating information generated from the date specified here is stored in the database.
If the /x argument is specified, this command first backs up operating information from the operation history storage directory to the operation history backup directory, and then, from the operation history backup directory, stores in the database the operating information acquired on or after the specified date that is not stored in the database.
Specify the date in the YYYYMMDD format, with YYYY indicating the year, MM the month, and DD the day. Specify a date in the range from January 1, 1980, to December 31, 2099.
You can omit this argument when you specify the /x argument. If you omit this argument, the operation information in the software operation history storage directory is stored in the database and then is saved in the operation history backup directory.
- /e
Specify the date on which storage to the database is to end. Operating information generated up to the date specified here is stored in the database. If this argument is omitted, the operating information generated up to the latest date is stored in the database.
If the /x argument is specified, this command first backs up operating information from the operation history storage directory to the operation history backup directory, and then, from the operation history backup directory, stores in the database the operating information acquired on or before the specified date that is not stored in the database.
Specify the date in the YYYYMMDD format, with YYYY indicating the year, MM the month, and DD the day. Specify a date in the range from January 1, 1980, to December 31, 2099.
If the specified date is earlier than the date specified in the /s argument, an error occurs. If the specified date is the same as the date specified in the /s argument, operating information for that date only is stored.
- /d
This argument stores operating information to the database from an operation history backup directory other than the one specified at setup. Note that the operating information in the operation history storage directory specified during installation is not stored in the database. Specify the path of the operation history backup directory in 127 characters or fewer. If you omit this argument, the operation history backup directory that was specified in the setup is used.
- When a shared directory is specified for the operation history directory
- Specify a UNC path. The information entered in the Network Connection Settings dialog box or on the Network Connection page is set as the network drive authentication information.
- /H#
Specify the host name if you want to target a specific host name when storing the operating information in the database. Upper-case and lower-case characters are not distinguished.
- /I#
Specify the IP address if you want to target a specific IP address when storing operating information in the database.
- /n
Specify this argument if you want to output the following processing status to the standard output when storing the operating information in the database, where the parentheses enclose the unit of processing status that is output:
- Operating information storage processing in the operation history storage directory (directory)
- Operating information storage processing in the operation history backup directory (directory)
- Operating information storage processing in the operation history backup directory specified in the /d argument (directory)
- Processing for storing the suppress history stored in the database (host)
Specify a processing status output count (number of directories and hosts subject to storage processing), in the range from 1 to 10,000. Use as a guideline 5% to 20% of the number of hosts subject to storage processing. If the specified value is smaller than the number of directories and hosts subject to storage processing, only the final results are output.
- /r
When the settings shown below have been specified on the Operation Monitoring page in the setup (to automatically store operation information in the database), this argument releases the operation information stored in the database from retained status by the command. It also cancels storage and deletion of operating information in the database.
When the /r argument is specified, operating information whose retention period specified at setup has elapsed is deleted from the database.
- Save the operation monitoring history check box is selected
- Store the operation monitoring history in the JP1/SD database check box is selected
- Enable automatic storage check box is selected
- /x
This argument is enabled when the following settings have been specified on the Operation Monitoring page in the setup (to manually store operation information in the database):
- Save the operation monitoring history check box is selected
- Store the operation monitoring history in the JP1/SD database check box is selected
- Compress and move the operation history to the storage directory radio button is selected
- Enable automatic storage check box is cleared
Specify this argument to store operating information in the database. The stored operating information accumulates in the database unless it is deleted by the dcmmonrst command with the /c argument specified. Operating information that has been stored once will not be stored again.
When you execute the command, the operation information in the software operation history storage directory is stored in the database and then is saved in the operation history backup directory.
If you have specified in the /s and /e arguments a range of dates for the operating information that is to be stored in the database, only operating information that has not yet been stored is stored in the database (from among all the target operating information in the operation history backup directory).
If you have specified in the /d argument an operation history backup directory, only the operating information that has not yet been stored is stored in the database (from among all the operating information in the operation history backup directory).
Before you execute the dcmmonrst command specifying this argument, make sure that you have write permissions for the target operation history backup directory.
- /z
By specifying this argument, you can store again to the database any operating information that, by means of the dcmmonrst command with the /x argument specified, has already been stored from the operation history backup directory to the database.
Before you execute the dcmmonrst command specifying this argument, make sure that you have write permissions for the target operation history backup directory. Then, before you store the operating information again in the database, delete the existing operating information from the database; otherwise, the operating information will be duplicated in the database.
- /c
This argument deletes operating information generated on or before the specified date from the operating information stored in the database. Using the YYYYMMDD format, specify a date that falls in the range from January 1, 1980, to December 31, 2099.
#: If both /H and /I are not specified as arguments, this command targets the operating information of all hosts.
(4) Return codes
The following explains the return codes that the dcmmonrst command may return:
Code |
Meaning |
Action |
0 |
The restoration, release, or deletion of saved data was completed. |
None |
2 |
Invalid argument specified in command argument. |
Check the settings for the command arguments. |
3 |
Error during connection to managing server. |
Check the operating status of the managing server. |
5 |
Communication failure between client and managing server system. |
Check the communications settings in the setup for the managing server. |
7 |
Directory specified as storage directory not found or the user does not have access permission. |
Check the specified path. |
12 |
Other errors occurred. |
Check the event log. |
13 |
Invalid login name or password. |
Check the login name and the password. |
15 |
Data being stored in database or deleted from database. |
Re-execute the command. |
20 |
Database storage or deletion was canceled because the dcmmonrst command with /r specified as argument was executed. |
None |
21 |
- When the dcmmonrst command with the /x or /z argument specified was executed, the specified operation history backup directory was not found.
- When the dcmmonrst command with the /x or /z argument specified was executed, there was no write permission for the specified operation history backup directory.
|
Specify the operation history backup directory for which you have write permissions. |
22 |
The options specified in the command arguments cannot be executed with the current server setup settings. |
See the event log to check the server setup settings and the options specified in the command arguments. |
If JP1/Base is linked to manage JP1/Software Distribution users, see 1.3.3 Setting for executing commands.
- If storage processing is executed with a start date that is two or more days after the latest date of the operating information stored in the database, dates without operating information are produced between the earlier information and the newly stored information. If this occurs, you may not be able to add operating information for the dates without operating information until the retention period for those dates elapses.
When storing the latest operating information, execute the command according to the following procedure:
- Execute dcmmonrst.exe /s current-date - retention-period + 1.
- Execute dcmmonrst.exe /r.
- In the following cases, execute the dcmmonrst command with the /r argument specified to first release the operating information hold status, and then restore the operating information:
- You wish to store operating information again after the dcmmonrst command has been used to store it in the database
- You wish to store operating information again after an attempt to store it in the database has failed
- If operating information reception from the client and operating information storage to the database are executed at the same time, each process may take a while to complete. Therefore, set the execution times for operating information reception from the client and operation information storage to the database so that the processes are executed at different times.
- Depending on the amount of information involved, the time required for storing operating information to the database may take a while. Although the collected history contents and the system environment also affect the time, assume as a guideline that storing one day's worth of operating information for one client takes 10 seconds.
- You cannot specify reserved words in the command arguments.
- If you upgrade from JP1/Software Distribution Manager version 08-51 or earlier, allocate sufficient capacity to the operation monitoring database file, and upgrade the database as well.
- If you store operating information manually in an Embedded RDB environment, you must execute the netmdb_reclaim.bat command to free the area after you have used the dcmmonrst command to delete the operating information from the database. For details about the netmdb_reclaim.bat command, see 6.6.5 Deleting operation logs in the manual Administrator's Guide Volume 1.
- If you have changed the settings for storing operating information in the database from automatic to manual, you must execute the dcmmonrst command with the /c argument specified to delete the operating information from the database before you store the operating information in the database by executing the dcmmonrst command.
- If you accumulate operating information in the database, you should periodically execute the dcmmonrst command with the /x argument specified in order to store the operating information in the database. If you do not execute the dcmmonrst command periodically, operating information will not be saved in the operation history backup directory.
When the size of an operation history file exceeds 20 MB, a warning message is output to the event log. If a file containing more than 30 MB of operation history is stored, and then processing terminates due to an error, some of the data stored for the client being processed might be duplicated.
- If you output the processing status to the standard output by executing the dcmmonrst command with the /n argument specified, processing might require more time than when the processing status is not output. You should specify the /n argument only when you need to check the processing status.
- If you output the processing status to the standard output by executing the dcmmonrst command with the /n argument specified, new operating information might be uploaded while existing operating information is being stored in the database. In such a case, the uploaded operating information might be stored in the database, resulting in an increase only in the number of directories and hosts whose processing has been completed.
(6) Example
The following shows examples of using the dcmmonrst command:
- To store the operating information whose retention period has elapsed using automatic storage:
dcmmonrst.exe /p p@ssw0rd /s 20070801
- To release the hold status of a database:
dcmmonrst.exe /p p@ssw0rd /r
- To store operating information manually:
dcmmonrst.exe /p p@ssw0rd /x /d D:\backup
- To store again operating information that has already been stored once:
dcmmonrst.exe /p p@ssw0rd /z /d D:\backup
- To delete operating information stored in a database:
dcmmonrst.exe /p p@ssw0rd /c 20071130
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
Copyright, patent, trademark, and other intellectual property rights related to the "TMEng.dll" file are owned exclusively by Trend Micro Incorporated.