Difference between revisions of "arsmaint"

1,233 bytes added ,  15:56, 25 September 2020
Lots of minor fixes and updates to the cmod arsmaint command.
m (Added link to IBM CMOD User Group for arsmaint article.)
(Lots of minor fixes and updates to the cmod arsmaint command.)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}


The IBM Content Manager OnDemand arsmaint command performs routine maintenance on Content Manager OnDemand servers. Maintenance can consist of migrating CMOD data from Cache to Archival storage, removing data from the cache to make room for new data, or deleting expired documents and metadata.
The IBM Content Manager OnDemand arsmaint command performs routine maintenance on CMOD servers. Maintenance can consist of migrating document data from the [[IBM CMOD Cache Filesystems]] to secondary storage, removing data from the cache to make room for new data, or deleting expired documents and metadata.
arsmaint command usage


The CMOD arsmaint utility must be run by the instance owner - that is an operating system account, usually named 'archive' or 'odadmin'. There are several command line options for CMOD's arsmaint utility:
==arsmaint command usage==
 
The CMOD arsmaint utility must be run by the instance owner - an operating system account, usually named 'archive' or 'odadmin'. There are several command line options for CMOD's arsmaint utility:


== CMOD arsmaint commands ==
== CMOD arsmaint commands ==
Line 25: Line 26:


;-e
;-e
:The -e option for the arsmaint command migrates index data to long-term archival storage. This option is rarely used because of the relatively low cost of disk storage, and the performance impact on queries.  
:The -e option for the arsmaint command migrates index data to long-term archival storage. This option is rarely used because of the relatively low cost of disk storage, and the negative performance impact on queries.  


;-n
;-n
:The minimum percentage capacity that arsmaint will try to empty the cache filesystem to. Use this command to clear out the arscache filesystems in preparation for an unusually large load of documents into Content Manager OnDemand.  
:The minimum percentage capacity that arsmaint will try to empty the cache filesystem to. Use this command to clear out the arscache filesystems in preparation for an unusually large load of documents into Content Manager OnDemand, for example, year end financial reporting, or tax season.


;-x
;-x
:The maximum percentage capacity of the arscache filesystems that arsmaint will allow to remain empty.  
:The maximum percentage capacity of the arscache filesystems that arsmaint will allow to remain empty.
 
NOTE:  The -n and -x options are performed on a 'best effort' basis, and won't delete data that isn't ready for expiration, or hasn't already been moved to secondary storage.  It's best to run <code>arsmaint -m</code> by itself first, to ensure that any data eligible for migration to long-term storage has already been moved.


The CMOD arsmaint command should be run with both the -c, -d, and -e options at the same time to prevent the database and cache and long-term storage from getting out of sync.
The CMOD arsmaint command should be run with both the -c, -d, and -e options at the same time to prevent the database and cache and long-term storage from getting out of sync.
Line 37: Line 40:
=== arsmaint commands for migration ===
=== arsmaint commands for migration ===
;-f
;-f
:This option records an alert message in the Content Manager OnDemand System Log, and prints an error message to stdout (for UNIX/Linux) or the console (on Windows system) when the cache filesystem exceeds the specified percentage. An alert from this option indicates that the arsmaint command was not able to remove enough data from the cache to make additional space for new data. You'll either need to adjust the caching settings for your Application Groups, or add more storage to the Cache Filesystem.  
:This option records an alert message in the Content Manager OnDemand System Log, and prints an error message to the terminal (for UNIX/Linux) or the console (on Windows system) when the cache filesystem exceeds the specified percentage. An alert from this option indicates that the arsmaint command was not able to remove enough data from the cache to make additional space for new data. You'll either need to adjust the caching settings for your Application Groups, or add more storage to the Cache Filesystem.  


;-m
;-m
:The -m option migrates data from cache to long term archival storage if your IBM CMOD server has secondary storage is defined, and your Application Group is configured to use it.
:The -m option migrates data from cache to long term archival storage if your IBM CMOD server has secondary storage defined, and your Application Group is configured to use it.


=== arsmaint commands for database maintenance ===
=== arsmaint commands for database maintenance ===
;-r
;-r
:This arsmaint command runs database statistics. Collecting (or updating) database staticstics for IBM CMOD helps improve query performance. Because Content Manager OnDemand is an archival product, database statistics do not change dramatically on a day to day basis. Running statistics is only recommended once every week or two.  In addition, you may want to run database maintenance with the CMOD arsdb command before collecting statistics with the arsmaint command.  
:This arsmaint command runs database statistics. Collecting (or updating) database statistics helps improve IBM CMOD query performance. Since Content Manager OnDemand is an archival product, running statistics once per week is usually more than enough to help keep CMOD queries fast.  In addition, you may want to run database maintenance with the CMOD [[arsdb]] command before collecting statistics with the arsmaint command.  


=== Other arsmaint commands ===
=== Other arsmaint commands ===
Line 57: Line 60:


;-p
;-p
:Specifies the password, or path to the IBM CMOD stash file.  
:Specifies the password, or path to the IBM CMOD stash file.  Using passwords on the command line may expose passwords to other users on the server, and as a result, you'll receive a warning.  Update your arsmaint commands to use a stash file in order to avoid the warning.  


;-1 (hyphen-number-one)
;-1 (hyphen-number-one)
:Specifies the trace file. Contents of the trace will be written to this file & path.  
:Specifies the trace file. Contents of the trace will be written to this file and path.  


;-2 (hyphen-number-two)
;-2 (hyphen-number-two)
:Specifies the trace level. A numeric value will determine how much detail is written to the trace file.  
:Specifies the trace level. See the trace.settings file in your CMOD config directory for more information on how to specify the trace level.  


=== arsmaint Performance Considerations ===
=== arsmaint Performance Considerations ===
Line 75: Line 78:
;Expiration Type of Document
;Expiration Type of Document
:Inside the Content Manager OnDemand Application Group configuration, there is a field called 'Expiration Type'. Choosing 'Document' is guaranteed to slow down performance of the arsmaint command, as this instructs IBM CMOD to review each and every document inside the Application Group tables to determine if the document is eligible for deletion.  
:Inside the Content Manager OnDemand Application Group configuration, there is a field called 'Expiration Type'. Choosing 'Document' is guaranteed to slow down performance of the arsmaint command, as this instructs IBM CMOD to review each and every document inside the Application Group tables to determine if the document is eligible for deletion.  
:Even if the Expiration Type is set to 'Load', which would normally perform better than the 'Document' setting, if you have an extremely large number of loads of small documents into the Application Group (in the millions), then the arsmaint expiration process is very similar to Document expiration instead.  
:Even if the Expiration Type is set to 'Load', which would normally perform better than the 'Document' setting, if you have an extremely large number of loads of small documents into the Application Group (in the millions), then the arsmaint expiration process is very similar to Document expiration instead.
:If you are loading tens of millions of documents per day into your CMOD server, consider performing an [https://cmod.cloud/extraction/ Extraction] of your CMOD data, and loading it into an Application Group configured to use the Segment expiration type.


;Small Object Sizes
;Small Object Sizes
Line 84: Line 88:


;Large numbers of expiring documents
;Large numbers of expiring documents
:If your system has a large number of documents to expire from IBM CMOD, then the arsmaint command may run for an extended period of time, as it performs the work required. If your Content Manager OnDemand server includes a Tivoli Storage Manager server for storing archival data, the expiration process may run more slowly as CMOD sends requests to TSM for the documents to be deleted.
:If your system has a large number of documents to expire from IBM CMOD, then the arsmaint command may run for an extended period of time, as it performs the work required. If your Content Manager OnDemand server includes a Tivoli Storage Manager server or other secondary storage for data, the expiration process may run more slowly as CMOD sends requests for the documents to be deleted.
 
== arsmaint command Examples ==


== arsmaint command errors ==
== arsmaint command errors ==
Line 93: Line 95:


== Links to IBM CMOD arsmaint command documentation ==
== Links to IBM CMOD arsmaint command documentation ==
[https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v10.5]
[https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v10.1]
[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v9.5]
[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v9.5]


Line 98: Line 105:


[https://www.ibm.com/support/knowledgecenter/SSEPCD_8.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v8.5]
[https://www.ibm.com/support/knowledgecenter/SSEPCD_8.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v8.5]


== Related Articles ==
== Related Articles ==


[[Optimizing Cache Filesystems]]
[https://cmod.cloud/ibm-cmod-cache-optimization/ Optimizing IBM Content Manager OnDemand Cache Filesystems]


[[ARS0013E|ARS0013E - DB Error]]
[[ARS0013E|ARS0013E - DB Error]]


[http://www.odusergroup.org/forums/index.php?topic=2165.0 ARSMAINT discussion on the ODUG Forums]
[http://www.odusergroup.org/forums/index.php?topic=2165.0 ARSMAINT discussion on the ODUG Forums]