====== 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 [[common:volume_flags|Flag]] of each [[object:volume|Volume]] and move Scratch [[object:volume|Volumes]] to another [[object:repository|Repository]].
''TMSS10MoveScratch'' is used to manage Scratch [[object:volume|Volumes]], it performs 3 functions:
- Moves all [[object:volume|Volumes]] with a Scratch [[common:volume_flags|Flag]] to the [[object:repository|Repository]] specified in the ''-R'' argument.
- Sets the Scratch [[common:volume_flags|Flag]] for all [[object:volume|Volumes]].
- Lists all [[object:volume|Volumes]] with a Scratch [[common:volume_flags|Flag]].
This command is particularly helpful for platforms such as Tivoli Storage Manager, which deletes Scratch [[object:volume|Volume]] from its [[object:volume|Volume]] Table, as you can schedule the command to run once per week to reset all [[object:volume|Volumes]] to Scratch then remove the Scratch [[common:volume_flags|Flag]] using TMSS10Sync during the week. Then when the program is run subsequently the next week, it will move each [[object:volume|Volume]] that still has the Scratch [[common:volume_flags|Flag]] set to a new [[object:repository|Repository]].
Please note that when running ''TMSS10MoveScratch'' with the ''-R'' argument set you must be sure that the process that sets the Scratch [[common:volume_flags|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 [[common:volume_flags|Flags]] that should have been removed have not been removed, it is possible that non-Scratch [[object:volume|Volumes]] will be moved.
===== Options =====
* ''-C'' Scratch capacity of Target [[object:repository|Repository]] (default = 1000)
* ''-R'' Target [[object:repository|Repository]] where Scratch [[object:volume|Volumes]] will be moved to.
* ''-S'' The Logon string argument sets the [[cli:server_argument|Server Logon Information]]
* ''-V'' [[cli:volume_filter|Volume Filter]] which can be used to filter the traversal of [[object:customer|Customer]], [[object:media|Media]], [[object:volume|Volume]], [[object:repository|Repository]] and [[common:volume_flags|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 [[object:customer|Customer]], [[object:media|Media]] and [[object:volume|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 [[common:support_details|Accessing Technical Support]] page.
==== Exit Statuses ====
- **zero** Program has ended successfully.
- **non-zero** Program has not ended successfully.
==== Environment ====
[[variable:tmssserverproxy|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 [[variable:tmssapilogdir|TMSSAPILOGDIR]].
[[variable:tmssapilogdir|TMSSAPILOGDIR]]: If defined the program will write out a trace file to this directory.
[[variable:tmsspwpath|TMSSPWPATH]]: When no password value is passed in the [[cli:server_argument|logonstring]] the program will look for the password in file \etc\tapetrack\user, where user is the user value passed in the [[cli:server_argument|logonstring]]. If you wish to change this default path, you can set the path in [[variable:tmsspwpath|TMSSPWPATH]].
==== Files ====
**stdout:** Output Reports. \\
**stderr:** Diagnostic messages. \\
**stdin:** Program input.
==== Example ====
Move maximum of 1 Scratch [[object:volume|Volume]] to [[object:repository|Repository]] LIBR for [[object:customer|Customer]] US04, [[object:media|Media]] LTO and set Scratch [[common:volume_flags|Flag]] for the rest of [[object:volume|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 [[object:customer|Customer]] US04, [[object:media|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
[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10MoveScratch]
<--
<- ^ cli:introduction|Command Line Utilities^ ->