Use the dsmhsmclc.exe command to configure threshold migration from the Command Prompt window.
You can configure threshold migration, deactivate threshold migration, set the limit for threshold migration processes, and query the configuration.
Syntax
>>-DSMHSMCLC.exe------------------------------------------------> >--+--------------------------------------------------------------+--> +-CONFIGUREThresholdmig--volume_mount_path--+----------------+-+ | '-config_options-' | +-UNCONFIGUREThresholdmig--volume_mount_path-------------------+ +- -MAXTHRESHOLDPROC--num_val----------------------------------+ | .-,---------------------. | | V | | +-Query----+-------------------+-+-----------------------------+ | '-volume_mount_path-' | +-Help---------------------------------------------------------+ '- -?----------------------------------------------------------' >--+---------------+------------------------------------------->< '- -l--loglevel-'
Options
- CONFIGUREThresholdmig
- Use this option to configure threshold migration for the specified volume or mount path.
- UNCONFIGUREThresholdmig
- Use this option to remove threshold migration from the specified volume or mount path. When you specify this option, threshold migration is deactivated and all configuration values are erased.
- -MAXTHRESHOLDPROC num_val
Use this option to configure the number of migration tasks that can occur simultaneously. The option applies to migration, scan, and validation tasks on all volumes. If this number is reached, any pending migration tasks are delayed until one of the running tasks finishes. The range of acceptable values is 1 - 16. The default is 3.
- Query
- Use this option to query the threshold migration configuration
and reconciliation configuration of one or more volumes. Separate
volume names with a comma and no blank space. The default is all configured
volumes.
In addition to configuration values, the query can display the following information for each volume, depending on whether threshold migration, reconciliation, or both, are configured for the volume:
- Time of next reconcile process
- Space usage
- Running processes:
- Reconcile
- Threshold migration
- Scan
- Validation
- volume_mount_path
Specify the volume mount path. Because it is possible for a single volume to be mounted by more than one path, always specify that volume by the same mount path. Reconciliation, threshold migration, and migration jobs must all reference the volume by the same path.
- config_options
You can specify any of the following configuration options. Specify each option no more than once. If the volume is not configured, omitting the option from the command configures the volume with the default value for the option. If the volume is configured, omitting the option from the command leaves that configuration value unchanged.
- -FILESPace file space
Use this option to configure the file space that is used for threshold migration.
On the initial configuration, you must specify a file space. After the initial configuration, this parameter is optional. Until you specify a different file space, files that are migrated from this volume are stored in this file space.
- -MGMTclass management class
Use this option to configure the management class that is used for threshold migration of this volume. Specify an existing management class with an archive copy group, or specify DEFAULT to use the default management class of the active policy set. If the retention period of the selected management class is finite, a warning is issued.
- -HIGHthreshold percent
Use this option to configure the disk usage that triggers when to start threshold migration. After the disk capacity reaches this percent of capacity, threshold migration begins. The range of acceptable values is 1 - 100. The default is 90.
- -LOWthreshold percent
Use this option to configure the disk usage that triggers when to stop threshold migration. After the disk usage reaches this percent of capacity, threshold migration stops. The low threshold must be less than the high threshold. The range of acceptable values is 0 - 99. The default is 80.
- -MONitorinterval minutes
Use this option to configure how frequently the HSM monitor service checks space usage on the disk. The time is measured in minutes. If the monitor interval is set to 0, monitoring is deactivated. The range of acceptable values is 0 - 9999. The default is 5.
- -SCANinterval hours
Use this option to configure how frequently the HSM monitor service starts the file system scan to find candidates. The time is measured from the end of the last scan to the beginning of the next scan. The time is measured in hours. The range of acceptable values is 1 - 9999. The default is 24.
If a scan yields better quality candidates (older and larger files) than the previous scan, the interval is automatically decreased by a small amount. If a scan yields poorer quality candidates (newer and smaller files) than the previous scan, the interval is automatically increased by a small amount.
- -CHECKCANDidatesinterval minutes
Use this option to configure how frequently the HSM monitor service validates the candidates in the candidates pool. The time is measured from the end of the last validation to the beginning of the next validation. The time is measured in minutes. If the interval is set to zero, validation is deactivated. The range of acceptable values is 0 - 9999. The default is 180.
- -MINMIGFILESIZE kilobytes
Use this option to configure minimum file size for a valid migration candidate. The size is measured in kilobytes (KB). The range of acceptable values is 4 - 2147483647 (2 TB). The default is 4.
- -MINMIGFILEAGE days
Use this option to configure minimum file age for a valid migration candidate. The age is measured in days. The range of acceptable values is 0 - 99999. The default is 360.
- -MINAGETYPE Access|Create|Modify
Use this option to configure which time stamp is used to calculate the age of a file. Changing this option can make many files in the current pool of migration candidates no longer valid. The choices correspond to the file system time stamps for file creation, file modification, and file access.
- -AGEWeight percent
Use this option to configure the importance of file age (relative to file size) when determining migration candidates.
The age weight and size weight of a file are computed relative to the configured minimum age and minimum size. Hence, a file that is twice as old as the minimum age has an age weight of 2. If the file is the minimum size, it has a size weight of 1.
When the importance of age relative to size is considered, the file's weight is computed in this way: computed weight = (AGEWeight * (age weight)) + ((1-AGEWeight ) * (size weight)).
For example, when AGEWeight = 50 , the file has the same weight ((.5*(2)) + ((1-.5)*(1)) = 1.5) as a file that is only as old as the minimum age, but twice as big as the minimum size ((.5*(1)) + (.5*(2)) = 1.5). The weight of both files is 1.5 .
If the AGEWeight option is not 50%, but 75%, the first file has a computed weight of 1.75 ((.75*(2)) + ((1-.75)*(1)) = 1.75), while for the younger but larger file, the computed weight is 1.25 ((.75*(1)) + ((1-.75)*(2)) = 1.25).
Specify a value from 0 to 100. The default is 50.
- -BACKUPBEforemigrate yes|no
Use this option to configure whether migration requires backup. The default is the value that you set in the initial configuration wizard. If you use the -backupbeforemigrate option but do not specify yes or no, a file is backed up before it is migrated.
- -OPTFILE options_file
Use this option to specify the options file for backup before migration. If you specify -OPTFILE=DEFAULT, the backup-archive client chooses the options file. The backup-archive client chooses the options file even if the volume was previously configured to use another options file. The backup-archive client chooses the options file even if you specified another options file in the initial configuration wizard.
- -THRESHOLDMIGNOW yes|no
Use this option to configure an immediate threshold migration. If disk usage is greater than the low threshold, files are migrated until the low threshold is reached. The default is no.
- -SCANNOW yes|no
Use this option to configure an immediate scan of the volume. The default is no.
- -SECurity yes|no
Use this option to configure whether file security attributes are migrated when the file is migrated. The default is the value that you set in the initial configuration wizard.
- -ADStreams no|yes
Use this option to configure whether Windows alternate data streams data is migrated when the file is migrated. The default is the value that you set in the initial configuration wizard.
- -L loglevel
Specify the type of information that is to be recorded in logs and trace files. You can specify one or more values with no commas or blank space separators. Severe and error messages are always recorded. The default combination is severe, error, warning, information, and library (SEWIL). The following values are valid:
- C (event)
- D (debug)
- E (error)
- F (flush)
- I (information)
- K (driver)
- L (library)
- S (severe)
- T (trace)
- U (user)
- W (warning)
- X (dump)
- Help
- Use this option to display help for the command. Entering the command with no options also displays help for the command.
- ?
- Use this option to display help for the command. Entering the command with no options also displays help for the command.
Examples
- Task
- Volume e:\ is not yet configured for threshold
migration. Configure volume e:\ for threshold
migration. Accept the default values for all parameters. (The file
space name must be specified on the initial configuration).
Command: dsmhsmclc configuret e:\ -files computer10
- Task
- Volume e:\ was configured with default values.
Raise the high and low thresholds for volume e:\. Monitor the volume more frequently.
Command: dsmhsmclc configuret e:\ -high 95 -low 90 -monitor 2
- Task
- Volume e:\ was configured with default values.
Change the importance of size (relative to age) when picking migration
candidates. Scan the volume for new candidates immediately.
Command: dsmhsmclc configuret e:\ -agew 25 -scannow yes
- Task
- Immediately begin a migration of volume e:\. Continue migrating files until the disk usage is 40% of capacity.
Command: dsmhsmclc configuret e:\ -low 40 -migratenow yes
- Task
- Limit threshold migration among all volumes to one threshold migration
process at a time.
Command: dsmhsmclc -maxthresholdproc 1
- Task
- Deactivate threshold migration but do not erase threshold migration
configuration of volume e:\.
Command: dsmhsmclc configuret e:\ -monitorinterval 0
- Task
- Deactivate threshold migration and erase threshold migration configuration
for volume e:\.
Command: dsmhsmclc unconfiguret e:\
- Task
- Set a new management class MC2 for files that
are migrated from volume f:\ by threshold migration.
Command: dsmhsmclc configuret f:\ -mgmt MC2
- Task
- Query the configuration of volumes e:\ and g:\.
Command: dsmhsmclc q e:\,g:\
- Task
- Change the information that is recorded in log and trace files.
Record dump and trace information, and (by default) severe and error
information.
Command: dsmhsmclc -l XT
- Task
- Change the information that is recorded in log and trace files
to the default.
Command: dsmhsmclc -l
- Task
- Display help for the dsmhsmclc.exe command
(three methods are shown).
Command: dsmhsmclc ?
Command: dsmhsmclc help
Command: dsmhsmclc