arsmaint - Revision history

Jderrick: /* Related Articles */

2024-08-20T18:10:16Z

← Older revision		Revision as of 18:10, 20 August 2024
Line 112:		Line 112:
	[[ARS0013E\|ARS0013E - DB Error]]		[[ARS0013E\|ARS0013E - DB Error]]

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

Jderrick: Lots of minor fixes and updates to the cmod arsmaint command.

2020-09-25T15:56:15Z

Lots of minor fixes and updates to the cmod arsmaint command.

← Older revision		Revision as of 15:56, 25 September 2020
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]

Jderrick: Added link to IBM CMOD User Group for arsmaint article.

2017-02-15T12:36:45Z

Added link to IBM CMOD User Group for arsmaint article.

← Older revision		Revision as of 12:36, 15 February 2017
Line 105:		Line 105:

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

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

Jderrick: Jderrick moved page Arsmaint to arsmaint without leaving a redirect

2017-02-11T02:39:49Z

Jderrick moved page Arsmaint to arsmaint without leaving a redirect

← Older revision	Revision as of 02:39, 11 February 2017
(No difference)

Jderrick: Added links to IBM Documentation on IBM CMOD arsmaint command parameters

2017-02-10T18:25:13Z

Added links to IBM Documentation on IBM CMOD arsmaint command parameters

← Older revision		Revision as of 18:25, 10 February 2017
Line 5:		Line 5:

	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:		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:

	~~== Links to IBM CMOD arsmaint command documentation ==~~

	== CMOD arsmaint commands ==		== CMOD arsmaint commands ==
Line 93:		Line 91:

	If an error is encountered during database maintenance, then arsmaint may return an [[ARS0013E]] error. For example, the ARS0013E error may be encountered while trying to reorganize a time, or collecting statistics on a table that is having data loaded with the arsload command, or the System Log table is recording server activity. Try running the command again during a period of low activity, or take CMOD offline and ask your local Database Administrator to perform a reorg on the offending table.		If an error is encountered during database maintenance, then arsmaint may return an [[ARS0013E]] error. For example, the ARS0013E error may be encountered while trying to reorganize a time, or collecting statistics on a table that is having data loaded with the arsload command, or the System Log table is recording server activity. Try running the command again during a period of low activity, or take CMOD offline and ask your local Database Administrator to perform a reorg on the offending table.

			== Links to IBM CMOD arsmaint command documentation ==
			[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.0.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v9.0]

			[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 ==

Jderrick: Added arsmaint command example of ARS0013E error.

2017-02-10T17:09:15Z

Added arsmaint command example of ARS0013E error.

← Older revision		Revision as of 17:09, 10 February 2017
Line 89:		Line 89:

	== arsmaint command Examples ==		== arsmaint command Examples ==

			== arsmaint command errors ==

			If an error is encountered during database maintenance, then arsmaint may return an [[ARS0013E]] error. For example, the ARS0013E error may be encountered while trying to reorganize a time, or collecting statistics on a table that is having data loaded with the arsload command, or the System Log table is recording server activity. Try running the command again during a period of low activity, or take CMOD offline and ask your local Database Administrator to perform a reorg on the offending table.

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

Jderrick: Added link to IBM CMOD ARS0013E error as it relates to arsmaint

2017-02-10T16:58:58Z

Added link to IBM CMOD ARS0013E error as it relates to arsmaint

← Older revision		Revision as of 16:58, 10 February 2017
Line 93:		Line 93:

	[[Optimizing Cache Filesystems]]		[[Optimizing Cache Filesystems]]

			[[ARS0013E\|ARS0013E - DB Error]]

Jderrick: Second edit after the database problems.

2017-02-10T10:24:29Z

Second edit after the database problems.

Show changes

Jderrick: Created page with "arsmaint Contents 1 arsmaint command usage 2 Links to arsmaint documentation 3 CMOD arsmaint commands 3.1 Special arsmaint commands 3.2 arsmaint c..."

2017-02-10T07:55:24Z

Created page with "arsmaint Contents 1 arsmaint command usage 2 Links to arsmaint documentation 3 CMOD arsmaint commands 3.1 Special arsmaint commands 3.2 arsmaint c..."

New page

arsmaint
Contents

1 arsmaint command usage
2 Links to arsmaint documentation
3 CMOD arsmaint commands
3.1 Special arsmaint commands
3.2 arsmaint commands for expiration
3.3 arsmaint commands for migration
3.4 arsmaint commands for database maintenance
3.5 Other arsmaint commands
4 arsmaint Performance Considerations
4.1 Application Group Configuration
4.2 CMOD cache filesystem configuration
4.3 Large numbers of expiring documents
5 arsmaint Examples
6 Related Articles

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.
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:
Links to arsmaint documentation
CMOD arsmaint commands
Special arsmaint commands

There are some arsmaint options that change the behaviour of the other arsmaint commands:

-g
Specifies the Application Group to process. You may specifiy this option multiple times in the same command.
This option limits the other command options to be applied to the listed Application Group names.
Application Groups that contain spaces must be quoted with a single double-quotation-mark: "
When using the -g option, you may only use the -c, -d, -e, -i, -m & -r commands.

-t
The -t ("time") arsmaint option will perform the requested commands as if they were being executed on the specified date.
Specifying a time period in the future will lead to the expiration of data ahead of schedule.
Do not use this command in a production environment without having first completed substantial testing in development or test environments.

arsmaint commands for expiration

-c
The -c option for the arsmaint command deletes document data from the cache filesystem.

-d
The -d option for the arsmaint command deletes metadata from the database.

-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.

-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.

-x
The maximum percentage capacity of the arscache filesystems that arsmaint will allow to remain empty.

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.
arsmaint commands for migration

-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.

-m
The -m option migrates data from cache to long term archival storage.

arsmaint commands for database maintenance

-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.

Other arsmaint commands

-s
Produces a report on CMOD cache filesystems ("arscache"), which is stored in the System Log.

-v
Validates the IBM CMOD cache ("arscache") filesystems, and reports back any unexpected problems.

-u
Specifies the IBM CMOD User ID which will be used to authenticate to IBM Content Manager OnDemand.

-p
Specifies the password, or path to the IBM CMOD stash file.

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

-2 (hyphen-number-two)
Specifies the trace level. A numeric value will determine how much detail is written to the trace file.

arsmaint Performance Considerations

A common complaint about CMOD's arsmaint command is the amount of time that is takes in order to run. Often, the configuration of CMOD Application Groups, and the steady growth of the system are the causes of slow performance.
Application Group Configuration

Application Group settings that will lead to long arsmaint run times are:

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.
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.

Small Object Sizes
The default stored object size in CMOD is 10MB. This relatively small size means that there may be billions of files inside CMOD. It may make sense to consider tuning this value to a larger number, to reduce the total number of objects, and to decrease the amount of files that the arsmaint command needs to inspect in order to complete.

CMOD cache filesystem configuration

If your system has an extremely large cache filesystem, or has a large number of very small files, then the CMOD arsmaint command can take a very long time to complete, as each file in the cache filesystem must be examined to determine if it's eligible for deletion. In many systems, this problem gets worse as a server ages, and more cache filesystems are added.
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.
arsmaint Examples
Related Articles

Optimizing Cache Filesystems