TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools


cli:tmss10movescratch
 
 

TMSS10MoveScratch

Synopsis

TMSS10MoveScratch [-C scratch capacity] [-R target repository] [-S logon string] [-V volume filter] [-a skip move] [-b skip scratch] [-c config file] [-m scratch maximum]

Description

Resets the Scratch Flag of each Volume and move Scratch Volumes to another Repository.

TMSS10MoveScratch is used to manage Scratch Volumes, it performs 3 functions:

  1. Moves all Volumes with a Scratch Flag to the Repository specified in the -R argument.
  2. Sets the Scratch Flag for all Volumes.
  3. Lists all Volumes with a Scratch Flag.

This command is particularly helpful for platforms such as Tivoli Storage Manager, which deletes Scratch Volume from its Volume Table, as you can schedule the command to run once per week to reset all Volumes to Scratch then remove the Scratch Flag using TMSS10Sync during the week. Then when the program is run subsequently the next week, it will move each Volume that still has the Scratch Flag set to a new Repository.

Please note that when running TMSS10MoveScratch with the -R argument set you must be sure that the process that sets the Scratch Flag to false has run. In the event that this is multiple processes (where you have multiple backup catalogs) you must be sure that all processes would have run. In the event that not all Scratch Flags that should have been removed have not been removed, it is possible that non-Scratch Volumes will be moved.

Options

  • -C Scratch capacity of Target Repository (default = 1000)
  • -R Target Repository where Scratch Volumes will be moved to.
  • -S The Logon string argument sets the Server Logon Information
  • -V Volume Filter which can be used to filter the traversal of Customer, Media, Volume, Repository and Flag values.
  • -a Skip move step (default = false)
  • -b Skip Scratch step (default = false)
  • -c The config file argument specifies the path to the Batch Configuration File. The Batch Configuration File allows you to perform advanced traversal of Customer, Media and Volumes, perform advanced barcode pre and post processing and route program output to syslogd. Configuration File capabilities vary from program to program but the syntax remains the same. In the event that logic is not supported it will simply be ignored.
  • -m Scratch maximum ( default = 1000000)

Technical Support

The TapeTrack Software is commercially supported by a full time help desk staff. If you are experiencing problems or want some advice on how to configure or use the product please see the Accessing Technical Support page.

Exit Statuses

  1. zero Program has ended successfully.
  2. non-zero Program has not ended successfully.

Environment

TMSSSERVERPROXY: If defined the program will route all TapeTrack TCP/IP traffic through a HTTPS proxy. The value of the variable should be in the format user:password@host:port. To debug the proxy connection use variable TMSSAPILOGDIR.

TMSSAPILOGDIR: If defined the program will write out a trace file to this directory.

TMSSPWPATH: When no password value is passed in the logonstring the program will look for the password in file \etc\tapetrack\user, where user is the user value passed in the logonstring. If you wish to change this default path, you can set the path in TMSSPWPATH.

Files

stdout: Output Reports.
stderr: Diagnostic messages.
stdin: Program input.

Example

Move maximum of 1 Scratch Volume to Repository LIBR for Customer US04, Media LTO and set Scratch Flag for the rest of Volumes.

Command line syntax

TMSS10MoveScratch -S user:-password@server -C 1 -R LIBR -V "US04.LTO.*"

Output

             System: TapeTrack
 Report Description: Scratch List
    Production Time: Monday, May 21, 2018 - 11:13:58 (AUS Eastern Standard Time)
       Report Width: 165 bytes

 Seq.   Barcode              Current Target       New Target           Age          Message            
 ------ -------------------- -------------------- -------------------- ------------ -------------------
      1 US04.LTO.000011L5    Scratch Volumes      Library                    M31:14                    
 ------ -------------------- -------------------- -------------------- ------------ -------------------

Produce Scratch report only for Customer US04, Media LTO.

Command line syntax

TMSS10MoveScratch -S user:-password@server -b -V "US04.LTO.*"

Output

             System: TapeTrack
 Report Description: Scratch List
    Production Time: Monday, May 21, 2018 - 11:33:41 (AUS Eastern Standard Time)
       Report Width: 165 bytes
 
 Seq.   Barcode              Current Target       New Target           Age          Message                                                                          
 ------ -------------------- -------------------- -------------------- ------------ -------------------------------------------------------------------------------- 
      1 US04.LTO.000001L3    Scratch Volumes      N/A                        M58:49                                                                                  
      2 US04.LTO.000001L5    Scratch Volumes      N/A                        M58:49                                                                                  
      3 US04.LTO.000002L5    Scratch Volumes      N/A                        M58:49                                                                                  
      4 US04.LTO.000003L5    Scratch Volumes      N/A                        M58:49                                                                                  
      5 US04.LTO.000004L5    Scratch Volumes      N/A                        M58:49                                                                                  
      6 US04.LTO.000004L6    Scratch Volumes      N/A                        M58:49                                                                                  
      7 US04.LTO.000005L5    Scratch Volumes      N/A                        M58:49                                                                                  
      8 US04.LTO.000005L6    Scratch Volumes      N/A                        M58:49                                                                                  
      9 US04.LTO.000006L5    Scratch Volumes      N/A                        M58:49                                                                                  
     10 US04.LTO.000006L6    Scratch Volumes      N/A                        M58:49                                                                                  
     11 US04.LTO.000007L5    Scratch Volumes      N/A                        M58:49                                                                                  
     12 US04.LTO.000007L6    Scratch Volumes      N/A                        M58:49                                                                                  
     13 US04.LTO.000008L5    Scratch Volumes      N/A                        M58:49                                                                                  
     14 US04.LTO.000008L6    Scratch Volumes      N/A                        M58:48                                                                                  
     15 US04.LTO.000009L5    Scratch Volumes      N/A                        M50:57                                                                                  
     16 US04.LTO.000009L6    Scratch Volumes      N/A                        M50:57                                                                                  
     17 US04.LTO.000010L5    Scratch Volumes      N/A                        M50:57                                                                                  
     18 US04.LTO.000010L6    Library              N/A                           S15                                                                                  
     19 US04.LTO.000011L5    Library              N/A                        M19:42                                                                                  
     20 US04.LTO.000012L5    Library              N/A                           S15                                                                                  
     21 US04.LTO.000013L5    Library              N/A                           S15                                                                                  
 ------ -------------------- -------------------- -------------------- ------------ --------------------------------------------------------------------------------
Changelog
2021-05-24Fixed bug when using TMSSLEVELNAME and TMSSNOLEVELSLOT variables (#127)
2020-11-24Added support for JSON output
2019-04-24Fixed bug that was stopping scratch phase from running
2019-02-25Added support for HTML output
2019-02-09Added support for Excel output
2019-01-06Added return code list to end of all command line programs that use the TapeTrack API
2016-11-18Added fast forward code to reduce runtime
2016-11-18Enhanced argument parser to allow arguments in format *FI:filename that allows loading of arguments from a file
2015-12-26Added flags to Volume Filter syntax (customer.media.volume@repository+flags)
2015-08-24Changed hascontents to contentcount and change contentcount to a filter rather than bool
2015-08-24Added iscontainer and hascontents to the config file filter logic
2015-05-16Added environmental varialbe TMSSCANFILEUNQUALIFIED which will load and check volumes without Customer-ID and Media-ID qualifiers
2015-05-16Added environmental varialbe TMSSSCANFILENOPARSE which will presume scanfile items are only Volumes and not parse them, saving time
2015-05-16When loading scanfile from import definition, added CUSTOMER and MEDIA keywords to set defaults
2015-05-16When loading scanfile from import definition, changed keyword from VOLUME to BARCODE
2015-05-16Added TMSSUNQUALIFIEDVOLUME environmental variable which forces all barcodes to be printed without Customer-ID and Media-ID
2015-05-04Added support for AD passwords to all command line programs (check for environmental variable TMSSNOMD5)
2015-03-10Added Age column to report
2015-03-10Added Maximum and Cap arguments.
2014-11-19Changed server argument parser to allow colon in password to support z/OS DD name files
2014-10-26Upgraded development environment from Visual Studio 2012 to Visual Studio 2013
cli/tmss10movescratch.txt · Last modified: 2022/05/31 00:07 by scunliffe