move_volume_files

Moves files either of the following ways: From one Teamcenter volume to another over your WAN/LAN using FMS. You can specify files to move based on file date, file age, or by volume allocation rules. Within the same volume from the current volume subdirectory structure into multiple directories. For more information about using volume allocation rules to reallocate volume files, see Teamcenter Administration. You can run this utility as a cron job or as a scheduled task using process_move_file_volumes as a .sh or .bat script, respectively. Use this script if your scheduling tools are not running in the Teamcenter environment with the appropriate TC_ROOT and TC_DATA variables set. The script sets these variables and calls tc_provilevars directly before running the move_volume_files utility. The script accepts the same arguments as the utility. The arguments specified in the script are run by the utility. Syntax move_volume_files -u=user-id {-p=password | -pf=password-file} -g=group [-listvolumes] [-distributefiles] [-f={list | move} ] [-output_file=file-name] [-srcvol=source-volume] [-destvol=destination-volume] [-before=access-time-ending-range] [-after=access-time-beginning-range] [-maxage=days] [-fszlessthan=bytes] [-fszgreaterthan=bytes] [-outrulesfile=file-name] [-rulesfile=file-name] [-excludedvollist=file-name] [-presorted_file=file-name] [-listsaf] [-transfersaf] [-retainlmd] [-v] [-h] Arguments -u Specifies the user ID. This is generally a user with 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. -h Displays help for this utility. -after Any file last accessed after this date and time will be included in the list or move operation. The format of the date is the same as the configured date/time format for the current locale. For example, in the default en_US locale, '07-Dec-2020 14:53' is the correct format. This option can be used along with the -rulesfile option to further refine the results. -before Any file last accessed before this date and time will be included in the list or move operation. The format of the date is the same as the configured date/time format for the current locale. For example, in the default en_US locale, '07-Dec-2020 14:53' is the correct format. This option can be used along with the -rulesfile option to further refine the results. -destvol Specifies the name of the Teamcenter destination volume. Can not be used with the -distributeFiles argument. -excludedvollist Specifies the path and name of the file containing a list of volumes to be excluded from both listing and transfer actions. This argument is typically used to list default local volumes (store and forward volumes) to ensure the files stored in these temporary volume location are not transferred. Use either the full path to the file, or use the partial path/file name, in which case the utility searches for the file name in the current directory. Any number of volumes can be specified in this file. Each entry must be a valid volume name, listed on its own row in the file. -f Specifies whether the utility lists or moves files. list Lists the files to be moved in the specified source volume that are candidates to be moved. This argument must be used with the -srcvol argument. move Moves the Teamcenter files to the specified destination volume. This argument must be used with the -srcvol, -destvol and -distributefiles arguments. -fszlessthan Specifies the maximum file size (in bytes) a file can reach and still be eligible for transfer. For example, if set to 64000, all files that are 64,000 bytes or smaller can be transferred. If the -fszgreaterthan argument is specified, the files selected are within that range, inclusive. -fszgreaterthan Specifies the minimum file size (in bytes) a file can reach and still be eligible for transfer. For example, if set to 2048, all files that are 2,408 bytes or larger can be transferred. If the -fszlessthan argument is specified, the files selected are within that range, inclusive. -listsaf Lists files evaluated for a store and forward operation. -listvolumes Displays a list of all Teamcenter volumes configured in the database. -maxage Specifies the maximum age (in days) a file can reach and still be eligible for transfer. For example, if set to 24, any file 24-days old or younger can be transferred. If used outside of a rules environment, the current date minus the age specified by this argument is used as the -after value. -output_file Specifies the file to which list output is written when using the -f=list or -listsf arguments. If not specified, the move_tcfiles_list.txt file is created. -outrulesfile Outputs the volume allocation rules XML template to the current directory. The XML template is given the filename specified by this argument. For example, if set to VolRules.xml, an XML template of the allocation rules named VolRules.xml is created and stored in the current directory. -presorted_file Specifies the path and name of the file containing a list of files to be moved. This argument must be used with the -f=move argument. Use either the full path to the file, or use the partial path/file name, in which case the utility searches for the file name in the current directory. Any number of files can be specified in this file. The file format is the same format as the file output by the -f=list argument. Typically, you generate a file using this -f=list argument, edit the file as necessary, and then set the -presorted_file argument with the name of the edited file. -distributefiles Distributes Teamcenter volume files into multiple subdirectories if the file count exceeds the limit set by the TC_Volume_Max_Files_Per_Dir preference. This argument must be used with the -f=move argument. Use with other utility arguments to choose the files to move. Can not be used with the -destvol argument. -rulesfile Specifies the path and name of the volume allocation rules XML file to evaluate. The file is validated against the DTD, and then its rules are evaluated. Volume files are moved or listed, based on the setting of the -f argument. This argument must be used with the -f argument. It does not work with the -listvolumes, -srcvol, -destvol, or -presorted_file arguments. -srcvol Specifies the name of the Teamcenter source volume. -transfersaf Transfers all files evaluated for a store and forward operation from all of the user’s local volumes to their corresponding default volumes. It also creates and schedules a dispatcher request to clean up files in local volumes. Note The -listsaf and -transfersaf arguments require installation of dispatcher scheduler, module, client, and the store_and_forward translator. They also require setting the TC_Store_and_Forward and FMS_SAF_Batch_Transfer_Enabled preferences to true. For more information, see Teamcenter Administration. -retainlmd Prevents the last modified date from being updated on the file named reference during a file move or transfer operation. This feature is useful to prevent the appearance that the file has been updated when its contents have not changed. If retainlmd is used when moving or transferring a file, then the 'last modified date' of the named reference maintains its value and is not updated. If retainlmd is not used, then the last modified date is updated to the current date. -v Executes the utility in verbose mode. Restrictions If the volume path definition is defined in multiple locations, the definition must be exactly the same in each location. For example, if you define a volume in the Organization application using a drive/path definition format, you must use the same drive/path definition in the FMS master configuration file (you cannot use the UNC format). Conversely, the volume can be defined in both Organization and in the master configuration file in UNC format. Examples Enter the following command on a single line to generate the list of all files in Teamcenter volume vol003: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -f=list -srcvol=vol003 -destvol=vol1001 -v Enter the following command on a single line to generate the list of all files in Teamcenter volume vol003 that were last accessed in the given date range: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -f=list -srcvol=vol003 -destvol=vol1001 -after=03-Feb-2008 -before=03-Mar-2008 -v The list of evaluated files is stored in the move_tcfiles_list.txt file, in the current directory. Enter the following command on a single line to move all the files listed in the move_tcfiles_list.txt file from volume vol003 to volume vol1001: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -f=move -presorted_file=move_tcfiles_list.txt -destvol=vol1003 -v Enter the following command on a single line to relocate all Teamcenter files from volume vol003 to the destination volume newvol002: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -f=move -srcvol=vol003 -destvol=newvol002 -v Enter the following command on a single line to relocate Teamcenter files that were last accessed on November 29, 2006, or later, from Teamcenter vol002 to the destination volume newvol003: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -f=move -srcvol=vol002 -destvol=newvol003 -after=29-Nov-2006 -v Enter the following command on a single line to generate the volume allocation rules XML template named VolSelectionRules.xml and stored in the current directory: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -outrulesfile=VolSelectionRules.xml Enter the following command on a single line to evaluate the volume allocation rules in the VolSelectionRules.xml file and store the results in the move_tcfiles_list.txt file in the current directory: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -rulesfile=VolSelectionRules.xml -f=list -v Enter the following command on a single line to evaluate the volume allocation rules in the VolSelectionRules.xml file and move the evaluated files: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -rulesfile=VolSelectionRules.xml -f=move -v Enter the following command on a single line to generate the list of all files evaluated for a store and forward operation: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -listsaf -v Enter the following command on a single line to transfer files evaluated for a store and forward operation from all of the users’ local volumes to their corresponding default volumes and to schedule a dispatcher request to clean up files in local volumes: Copy move_volume_files -u=admin-user -p=admin-password -g=dba -transfersaf -v Enter the following command on a single line to distribute the files from the current subdirectory structure to the new subdirectory structure within the same volume as controlled by the TC_Volume_Max_Files_Per_Dir preference. Copy move_volume_files -u=admin-user -p=admin-password -g=dba -distributefiles -srcvol=vol003 -v Enter the following command on a single line to evaluate the volume allocation rules in the VolSelectionRules.xml file and distribute the evaluated files into multiple directories (within the same volume) as controlled by the TC_Volume_Max_Files_Per_Dir preference. Copy move_volume_files -u=admin-user -p=admin-password -g=dba -distributefiles -srcvol=vol003 -rulesfile=VolSelectionRules.xml -v Related Topics Introduction to administering volumes