hsm_report

Evaluates any or all hierarchical storage management (HSM) policies to generate a report. Because of performance considerations using the rich client application interface, Siemens Digital Industries Software recommends the system administrator execute this utility to create pending migration file sets. Sites can schedule this utility to execute overnight through a Linux cron job or Microsoft Windows at command. This utility can take considerable time to evaluate all migration policies. Syntax hsm_report [-u=user-id {-p=password | -pf=password-file} -g=group] -tier={1 | 2 | 3} -migrationreport=[ALL |migration-policy] [-before=before-date] [-after=after-date] -filepath=filepath [-listpolicies=ALL | policy-name] [-v] [ -h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -tier Specifies migration tier. Valid values are: 1 Primary to secondary. 2 Secondary to tertiary. 3 Primary to tertiary. -migrationreport Specifies migration policy for which the report need to be reported. To generate a report for all active migration policies, specify -migrationreport=ALL. -before Specifies the beginning date for reporting migration, for example, 23_Mar_2004. -after Specifies the ending date for reporting migration, for example, 23_May_2006. -filepath Specifies the operating system file path to which the report is saved. -listpolicies Indicates that the utility is to list all active policies. -v Verbose mode provides information about results and progress. -h Displays help for this utility. Environment The generic command window set with all Teamcenter-related environments. As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None Examples Execute the following command to generate report on all policies in the database: Copy hsm_report -u=admin-user -p=admin-password -g=dba -migrationreport=ALL -tier=1 -filepath=c:\temp\report.txt Execute the following command to generate report about a specific policy in the database: Copy hsm_report -u=admin-user -p=admin-password -g=dba -migrationreport=policy-name -filepath=c:\temp\report.txt Execute the following command to list of all active policies names defined for a database: Copy hsm_report -u=admin-user -p=admin-password -g=dba -listpolicies Related Topics Introduction to administering volumes