FSCWholeFileCacheUtil

The primary purpose of this utility is to purge files from the whole file cache. This utility purges the cache based on file age, subdirectory size, and/or available disk space. This utility also purges misplaced files (files that are stored in the wrong cache partition or subdirectory). This utility can also be used to clear entire cache partitions, or to redistribute cached files among a new list of partitions. By default, this utility is stored in the FSC_HOME/bin directory. Syntax FSCWholeFileCacheUtil {-clear | -purge | -redistrib} [-d=cache-root-directory-path] [-l=file-name] [-maxf=maximum-files-per-subdirectory] [-maxage=maximum-file-age] [-pctfree=percent-disk-free] [-temp=temporary-cache-directory-path] [-to=destination-partitions] [-from=source-partitions] [-copy] [-h] Arguments -clear Clears all permanent cache files from the cache. -purge Performs a single purge cycle on the cache. -redistrib Redistributes files to new partitions. This is useful when partitions are added to (or removed from) the cache, when the cache is cloned (copied), or when the cache is moved to another location. -d Specifies the cache partition data path. Because each partition is purged or cleared independently, only one partition path is accepted here. If not set, the current directory is used. Use with either the -clear or -purge arguments. -l Specifies the full path name of the log file. If not set, no logging is performed. Use with either the -clear or -purge arguments. -maxf Specifies the maximum number of files per subdirectory. If the number of files stored in the subdirectory exceeds the configured amount, files are automatically purged to the maximum number of files specified. Valid values are 1024 through 10240. The default setting is 10240. Use only with the -purge argument. -maxage Specifies (in days) the maximum file age. All cache files older than the specified age are purged. Valid values are 0 through 3650. The default setting is 3650. Setting this argument to 0 clears the entire cache. Use only with the -purge argument. -pctfree Specifies the minimum percentage of disk space to remain free. Valid values are 0 through 100. The default setting is 0. Setting this argument to 0 purges the cache by only the subdirectory count specified by the -maxf argument and the file age specified by the -maxage argument. Setting this argument to 100 clears the entire cache. Use only with the -purge argument. -temp Specifies the directory location to store temporary cache purge data. The default setting is the directory set by the -d argument. Use only with the -purge argument. -to Specifies the source cache partition data path list. Redistribution almost always involves multiple partitions. This is a comma-separated list of all of the cache partition paths to be included in the final FSC whole file cache at the conclusion of the redistribution, in the same format as the FSC_WholeFileCacheLocation property in the XML configuration. Some or all partition paths may appear in both the -to and -from arguments, except when -copy is also specified. This argument is required when the -redistrib argument is specified; it is not optional, and has no default value. Use only with the -redistrib argument. -from Specifies the source cache partition data path list. Because redistribution almost always involves multiple partitions, this is a comma-separated list of all of the cache partition paths that constitute the existing FSC whole file cache. The default setting is the partition list set by the -to argument. Use only with the -redistrib argument. -copy Specifies that files are to be copied rather than moved. This argument is useful for cloning cache partitions as a complete set. Do not use if the -from and -to arguments have partitions in common. Use only with the -redistrib argument, when the -from and -to arguments have no partitions in common. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples To clear files from the partition, enter the following command: Copy FSCWholeFileCacheUtil -clear -d="J:\FSC_WFC\FSC_WFC_p2\0" -l="C:\Program Files\Teamcenter\FSC\ClearCache.log" This removes all files from the FSC whole file cache partition at J:\FSC_WFC\FSC_WFC_p2\0 and logs the activity in the C:\Program Files\Teamcenter\FSC\ClearCache.log file. The existing partition owner must run this utility to obtain permission to delete each file. To purge files from the partition, enter the following command: Copy FSCWholeFileCacheUtil -purge -d="//FSC_WFC/FSC_WFC_p1/3" -maxf=5120 -maxage=60 -pctfree=35 -temp="/scratch/FSCWholeFileCachePurge.tmp" This purges excess files from the FSC whole file cache partition at //FSC_WFC/FSC_WFC_p1/3 such that: All files more than 60 days old are deleted (as set by the -maxage argument). No more than 5120 files remain in each subdirectory after the first pass (as set by the -maxf argument). At least 35% of the partition size are free after the second pass (as set by the -pctfree argument). Temporary purge files are stored in the /scratch/FSCWholeFileCachePurge.tmp directory (as set by the -temp argument). The existing partition owner must run this utility to obtain permission to delete each excess file. To add a new partition, enter the following command: Copy FSCWholeFileCacheUtil -redistrib -from="J:\FSC_WFC\FSC_WFC_p1,K:\FSC_WFC\FSC_WFC_p2" -to="J:\FSC_WFC\FSC_WFC_p1,K:\FSC_WFC\FSC_WFC_p2,L:\FSC_WFC\FSC_WFC_p3" This adds a third partition L:\FSC_WFC\FSC_WFC_p3 to an existing FSC whole file cache already stored on partitions at J:\FSC_WFC\FSC_WFC_p1 and K:\FSC_WFC\FSC_WFC_p2. Some files may be moved from the existing partitions to the new partition as the data is redistributed among the three new partitions. The three partitions must be approximately the same size (within 10%). The existing partition owner must run this utility to redistribute each file properly and maintain file permission integrity. To split a cache from existing partitions, enter the following command: Copy FSCWholeFileCacheUtil -redistrib -from="//FSC_WFC/FSC_WFC_p1,//FSC_WFC/FSC_WFC_p2" -to="//FSC_WFCCopy/p1,//FSC_WFCCopy/p2,//FSC_WFCCopy/p3" -copy This copies and splits an FSC cache from the two existing partitions //FSC_WFC/FSC_WFC_p1 and //FSC_WFC/FSC_WFC_p2 to three new partitions //FSC_WFCCopy/p1, //FSC_WFCCopy/p2, and //FSC_WFCCopy/p3. The existing partitions at //FSC_WFC/FSC_WFC_p1 and //FSC_WFC/FSC_WFC_p2 remain and can continue to be used. The two existing partitions must be approximately the same size as each other (within 10%). The three new partitions must also be approximately the same size as each other (within 10%). They do not need to be the same size as the two original partitions. The existing partition owner must run this utility to copy each file properly and maintain file permission integrity. The same user owns the destination files at the conclusion of the redistribution.