Excluding files from a checksum comparison

Excluding files from a checksum comparison

Specify individual files to exclude from a comparison, specify individual components to exclude, or create a single configurable properties file to specify a list of files to exclude from the bill of materials verification.

Before you begin

Install the product before comparing checksums and using exclusion properties.

About this task

This topic describes how to use exclusion properties.
By default, IBM excludes some files from the checksum comparison. We can also exclude files. The number of files excluded is reported within the first few messages
 I CWNVU0160I: [ivu] Verifying.
 I CWNVU0170I: [ivu] The installation root directory is C:\IBM\WebSphere\AppServerV602\
 I CWNVU0300I: [ivu] The total number of user excluded files found are 0.
 I CWNVU0300I: [ivu] The total number of IBM excluded files found are 78.
 I CWNVU0180I: [ivu] Searching directory properties\version\install\6.0.0.0\
                     backup for file listing: files.list
 I CWNVU0260I: [ivu] The total number of components found is: 285
 I CWNVU0270I: [ivu] Gathering installation root data.
 I CWNVU0460I: [ivu] The utility is running.
 I CWNVU0290I: [ivu] Starting the verification for 285 components.

 I CWNVU0470I: [ivu] Starting to analyze: activity
 I CWNVU0480I: [ivu] Done analyzing: activity

...
Several different methods are provided to exclude files from the comparison.

Procedure
Compare checksums and exclude all of the files within one or more components from the comparison:

./installver.sh -excludecomponent comp1;comp2;comp3;...
installver.bat -excludecomponent comp1;comp2;comp3;...
installver -excludecomponent comp1;comp2;comp3;...

For example, you might exclude the prereq.wccm component to avoid known but acceptable issues in the component
./installver.sh -log -excludecomponent prereq.wccm
The resulting messages show the exclusion
I CWNVU0160I: [ivu] Verifying.
I CWNVU0170I: [ivu] The installation root directory is /opt/IBM/WebSphere/AppServerV602/
I CWNVU0300I: [ivu] The total number of user excluded files found are 0.
I CWNVU0300I: [ivu] The total number of IBM excluded files found are 78.
I CWNVU0180I: [ivu] Searching directory properties/version/install/6.0.0.0/
                    backup for file listing: files.list
I CWNVU0260I: [ivu] The total number of components found is: 285
I CWNVU0270I: [ivu] Gathering installation root data.
I CWNVU0460I: [ivu] The utility is running.
I CWNVU0290I: [ivu] Starting the verification for 284 components.
...
I CWNVU0400I: [ivu] Total issues found : 0
I CWNVU0340I: [ivu] Done.
Exclude certain files from the comparison:

app_server_root/bin/installver.sh -exclude fn1;fn2;fn3
app_server_root\bin\installver.bat -exclude fn1;fn2;fn3

For example, suppose that you include only the prereq.wccm component for comparison
installver.bat -log -includecomponent prereq.wccm
The comparison shows all of the missing file issues in the component
I CWNVU0160I: [ivu] Verifying.
I CWNVU0170I: [ivu] The installation root directory is C:\IBM\WebSphere\AppServerV602\
I CWNVU0300I: [ivu] The total number of user excluded files found are 0.
I CWNVU0300I: [ivu] The total number of IBM excluded files found are 78.
I CWNVU0180I: [ivu] Searching directory properties\version\install\6.0.0.0\
                    backup for file listing: files.list
I CWNVU0260I: [ivu] The total number of components found is: 285
I CWNVU0270I: [ivu] Gathering installation root data.
I CWNVU0460I: [ivu] The utility is running.
I CWNVU0290I: [ivu] Starting the verification for 1 components.

I CWNVU0470I: [ivu] Starting to analyze: prereq.wccm
I CWNVU0430I: [ivu] The following file is missing: 
web/configDocs/activitysessionejbext/ActivitySessionEJBJarExtension.html
I CWNVU0430I: [ivu] The following file is missing: 
web/configDocs/activitysessionejbext/ActivitySessionEnterpriseBeanExtension.html
I CWNVU0430I: [ivu] The following file is missing:
web/configDocs/activitysessionejbext/ContainerActivitySession.html
...
I CWNVU0390I: [ivu] Component issues found : 625
I CWNVU0480I: [ivu] Done analyzing: prereq.wccm

I CWNVU0400I: [ivu] Total issues found : 625
I CWNVU0340I: [ivu] Done.
We can exclude files. For example, exclude the highlighted files in the previous example
installver -log -includecomponent prereq.wccm
 -exclude web/configDocs/activitysessionejbext/
ActivitySessionEJBJarExtension.html;web\configDocs\activitysessionejbext\
ActivitySessionEnterpriseBeanExtension.html
Tip: Use slashes to delimit directories.
The result shows that the excluded files were not compared
I CWNVU0160I: [ivu] Verifying.
I CWNVU0170I: [ivu] The installation root directory is C:\IBM\WebSphere\AppServerV602\
I CWNVU0300I: [ivu] The total number of user excluded files found are 0.
I CWNVU0300I: [ivu] The total number of IBM excluded files found are 78.
I CWNVU0180I: [ivu] Searching directory properties\version\install\6.0.0.0\
                    backup for file listing: files.list
I CWNVU0260I: [ivu] The total number of components found is: 285
I CWNVU0270I: [ivu] Gathering installation root data.
I CWNVU0460I: [ivu] The utility is running.
I CWNVU0290I: [ivu] Starting the verification for 1 components.

I CWNVU0470I: [ivu] Starting to analyze: prereq.wccm
I CWNVU0430I: [ivu] The following file is missing:
web/configDocs/activitysessionejbext/ContainerActivitySession.html
...
I CWNVU0390I: [ivu] Component issues found : 623
I CWNVU0480I: [ivu] Done analyzing: prereq.wccm

I CWNVU0400I: [ivu] Total issues found : 623
I CWNVU0340I: [ivu] Done.
If the two files were in the comparison, they would be in the list and the count would be 625, as in the previous example.
Tip: The highlighted line in the example is reserved for excluded files listed in the user template file, as described in the next step. The highlighted line does not count files that you list in the installver command line with the -exclude parameter.
Compare checksums and exclude certain files from the comparison by creating and using a user template file:
A single user configurable properties file is available to specify a list of files to exclude from the bill of materials verification.
Create an empty template file.

app_server_root/bin/installver.sh -createtemplate template_name
app_server_root\bin\installver.bat -createtemplate template_name

For example, create the default user template file on a Windows system
installver -createtemplate
I CWNVU0200I: [ivu] Creating template: 
C:\IBM\WebSphere\AppServerV602\profiles\
Dmgr01\properties\ivu_user.template
I CWNVU0340I: [ivu] Done.
The ivu_user.template file is created in the properties directory of the default profile, which in this case, is a deployment manager profile.
The -template_name parameter is optional. However, a template file must reside in the properties directory of the default profile, such as the app_server_root/profiles/Dmgr01/properties directory.
List files to exclude in the templates file.
The properties file has the following format
<template>
 <componentfiles componentname="name_of_component">
   <file>
     <relativepath action="exclude">file_name</relativepath>
   </file>
 </componentfiles>
</template>
For example, list the component and files from the previous example
<template>
 <componentfiles componentname="prereq.wccm">
  <file>
   <relativepath action="exclude">
web/configDocs/activitysessionejbext/ActivitySessionEnterpriseBeanExtension.html
   </relativepath>
  </file>
  <file>
   <relativepath action="exclude">
web/configDocs/activitysessionejbext/ActivitySessionEJBJarExtension.html
   </relativepath>
  </file>
 </componentfiles>
</template>
Tip: Do not use quotation marks or double quotation marks to delimit a file name.
Use the template file to exclude files from the comparison:
installver -log
If the ivu_user.template file exists in the properties directory of the default profile, the installver command uses it.
The result shows that some user files are excluded
I CWNVU0160I: [ivu] Verifying.
I CWNVU0170I: [ivu] The installation root directory is C:\IBM\WebSphere\AppServerV602\
I CWNVU0300I: [ivu] The total number of user excluded files found are 2.
I CWNVU0300I: [ivu] The total number of IBM excluded files found are 78.
I CWNVU0180I: [ivu] Searching directory properties\version\install\6.0.0.0\
                    backup for file listing: files.list
I CWNVU0260I: [ivu] The total number of components found is: 285
I CWNVU0270I: [ivu] Gathering installation root data.
I CWNVU0460I: [ivu] The utility is running.
I CWNVU0290I: [ivu] Starting the verification for 1 components.

I CWNVU0470I: [ivu] Starting to analyze: prereq.wccm
I CWNVU0430I: [ivu] The following file is missing: 
web/configDocs/activitysessionejbext/ContainerActivitySession.html

...
I CWNVU0430I: [ivu] The following file is missing: 
web/configDocs/wssecurity/generator-binding.html
I CWNVU0390I: [ivu] Component issues found : 623
I CWNVU0480I: [ivu] Done analyzing: prereq.wccm

I CWNVU0400I: [ivu] Total issues found : 623
I CWNVU0340I: [ivu] Done.
Results

When you issue one of the checksum commands from the app_server_root/bin directory, the status of the command is displayed on the terminal console or in a log file.

What to do next

Go to Comparing specific file and component checksums to learn more about the installver command.
Related tasks
Computing a new baseline checksum for an inventory of configured files Comparing specific file and component checksums Verifying checksums of installed files

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.