Differences

This shows you the differences between two versions of the page.

--- cli:tmss10movelist [2017/06/07 22:25] – [Description] Gerard Nicol
+++ cli:tmss10movelist [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== TMSS10MoveList ======
-This program produces a report of all Volumes that have a 'Move' status.
+This program produces a report of all [[object:volume|Volumes]] that are in a Move Status.
-====== Synopsis ======
+===== Synopsis =====
-''TMSS10MoveList [-S logonstring] [-V volumefilter] [-C option-C] [-T option-T] [-v]
+''TMSS10MoveList [-S logonstring] [-V volume filter] [-C current repository] [-T target repository] [-v print virtual location] [-c configfile]''
-[-c configfile]''
+===== Description =====
-====== Description ======
+''TMSS10MoveList'' produces a report listing all tape [[object:volume|Volumes]] that are in a "Move Status", i.e. they have a different Current and Target [[object:repository|Repository]].
+===== Options =====
+The options which apply to the TMSS10MoveList command are:
-TMSS10MoveList produces a report listing all tape Volumes that are in a "Move Status", i.e. they have a different Current and Target Repository.
+  * ''-S'' The logonstring argument sets the Server logon information (see [[cli:server_argument|Command Line Server Argument]]).
-====== Options ======
+  * ''-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.
+  * ''-C'' Current [[object:repository|Repository]] Filter.
+  * ''-T'' Target [[object:repository|Repository]] Filter.
+  * ''-v'' Print [[primer:virtual_physical_slot|Virtual Slot]] Locations (default = false).
+  * ''-c'' The config file argument specifies the path to the Batch Configuration File.
+{{page>cli:fi}}
+===== Notes =====
+Moving Volumes List \\
+Report-ID: 102
+Moving Directions List \\
+Report-ID: 103
+===== Exit Status =====
+  - **zero** Program has ended successfully.
+  - **non-zero** Program has not ended successfully.
+===== Environment =====
+  * [[variable:tmssapilogdir|TMSSAPILOGDIR]]
+  * [[variable:tmssbeep|TMSSBEEP]]
+  * [[variable:tmssnomd5|TMSSNOMD5]]
+  * [[variable:tmsspwpath|TMSSPWPATH]]
+  * [[variable:tmssserverproxy|TMSSSERVERPROXY]]
+  * [[variable:tmssapilogdir|TMSSAPILOGDIR]]
+===== Files =====
+  * ''stdout'' Output Reports.
+  * ''stderr'' Diagnostic messages.
+  * ''stdin'' Program input.
+===== Examples =====
+=== Command line syntax ===
+<code>
+TMSS10MoveList -S user:-password@server
+</code>
+=== Output ===
+<code>
+             System: TapeTrack
+          Report ID: 102
+ Report Description: Moving Volumes List
+       Report Notes: Customer(New York Data Center) Media Type(LTO Cartridge)
+    Production Time: Thursday, July 18, 2019 - 09:30:39 (AUS Eastern Standard Time)
+       Report Width: 190 bytes
+ Seq.   Barcode              Current Location               Target Location                Move Time        Time            Container            Attribute
+ ------ -------------------- ------------------------------ ------------------------------ ---------------- --------------- -------------------- --------------------------------------------
+US01.LTO.300300L5    Offsite Vault                  Library                        2019-07-18 09:04          M25:56
+US01.LTO.500500L5    Offsite Vault                  Library                        2019-07-16 11:23     D1:22:07:38
+US01.LTO.600600L5    Offsite Vault                  Library                        2019-07-16 11:23     D1:22:07:38
+US01.LTO.100100L5    Library                        Offsite Vault                  2019-07-18 09:21           M9:03
+US01.LTO.200200L5    Library                        Offsite Vault                  2019-07-18 09:21           M9:03
+US01.LTO.900900L5    Library                        Offsite Vault                  2019-07-18 09:17          M12:42
+ ------ -------------------- ------------------------------ ------------------------------ ---------------- --------------- -------------------- --------------------------------------------
+             System: TapeTrack
+          Report ID: 103
+ Report Description: Movement Directions Report
+       Report Notes: Customer(New York Data Center) Media Type(LTO Cartridge)
+    Production Time: Thursday, July 18, 2019 - 09:30:39 (AUS Eastern Standard Time)
+       Report Width: 54 bytes
+ Current Repository   Target Repository    Total
+ -------------------- -------------------- ----------
+ Library              Offsite Vault                 3
+ Offsite Vault        Library                       3
+ -------------------- -------------------- ----------
+</code>
+----
+Create a move list of all US01 LTO Scratch Volumes, with a custom report heading.
+Drop Movement Directions report (Report ID 103).
+=== Command line syntax ===
+<code>
+set TMSS10REPORTS102=New York Data Center - LTO - Scratch Movement Report
+set TMSSDROPREPORT103=true
+TMSS10MoveList -S user:-password@server -V US01.LTO.*@*+Z
+</code>
+=== Output ===
+<code>
+             System: TapeTrack
+          Report ID: 102
+ Report Description: New York Data Center - LTO - Scratch Movement Report
+       Report Notes: Customer(New York Data Center) Media Type(LTO Cartridge)
+    Production Time: Thursday, July 18, 2019 - 09:30:39 (AUS Eastern Standard Time)
+       Report Width: 190 bytes
+ Seq.   Barcode              Current Location               Target Location                Move Time        Time            Container            Attribute
+ ------ -------------------- ------------------------------ ------------------------------ ---------------- --------------- -------------------- --------------------------------------------
+US01.LTO.300300L5    Offsite Vault                  Library                        2019-07-18 09:04          M25:56
+US01.LTO.500500L5    Offsite Vault                  Library                        2019-07-16 11:23     D1:22:07:38
+US01.LTO.600600L5    Offsite Vault                  Library                        2019-07-16 11:23     D1:22:07:38
+ ------ -------------------- ------------------------------ ------------------------------ ---------------- --------------- -------------------- --------------------------------------------
+</code>
+--> Changelog
+[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10MoveList]
+<--
+<- ^ cli:introduction|Command Line Utilities^ ->
-The options which apply to the TMSS10MoveList command are:
--S The logonstring argument sets the Server logon information in the format
-user:password@server:port.
-In the event that this argument is not passed the default will be batch:batch@localhost:5000.
-By default the password value will be treated as the path to a file which contains a single record
-representing the password, rather than the password itself.
-If you wish the password value to be the literal password (rather than a file) the password should be
-prepended with a dash (fred:-fredspassword@server).
-You can also have the program read the password as the first record of stdin by prepending the
-password with a plus symbol (fred:+@server).
-In the event that the password is all upper case and 32 characters in length, the password will be
-considered an MD5 hash of the password and passed to the server without subsequent MD5 hashing.
--V The volumefilter argument sets the Volume Filter which can be used to filter the traversal of
-Customer, Media and Volume values.
-The format of this filter is c.m.v@r, where c is Customer-ID filter, m is Media-ID filter, v is
-Volume-ID filter and r is Repository-ID filter.
-To process only volumes not in Repository ACME, "*.*.*@!(ACME).
--C Current Repository Filter.
--T Target Repository Filter.
--v Print Virtual Locations.
--c The configfile 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.
-The following example will set the default Customer-ID and Media-ID for all scanned barcodes:
-TMSS10MoveList
-barcodes =
-{
-defaults={ customer-id="ACME"; media-id="LTO"; };
-};
-Exit Status
-zero Program has ended successfully.
-non-zero Program has not ended successfully.
-Environment
-TMSSAPILOGDIR If defined the program will write out a trace file to this directory.
-TMSSBEEP If defined the program will beep whenever an error occurs.
-TMSSNOMD5 If defined the program will not MD5 hash passwords before sending them to the
-TapeTrack Server. This is required when relying on Windows Active Directory
-authentication. It should be noted that although the password is not being hashed,
-it is still being encrypted during transmission.
-TMSSPWPATH When no password value is passed in the logon string 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.
-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.
-Examples
-Example 1. TMSS10MoveList: .....
-.....
-Files
-stdout Output Reports.
-stderr Diagnostic messages.
-stdin Program input.
-See Also
-TMSS10Ping(1)
-TMSS10MoveList
-Bugs
-On the Linux platform all TapeTrack command line programs are compiled with static C runtimes. This
-means that on some older Linux versions DNS name resolution does not work and you must use dotted
-IP addresses.
-Reporting Bugs
-Please report any bug by emailing <support@gazillabyte.com> or by visiting http://
-support.gazillabyte.com.
-Copyright
-Copyright GazillaByte 1999-2015.
-Changes
-A list of changes to this module can be viewed in RSS format at http://www.tapetrack.com/cgi/
-changelog.cgi?Module=TMSS10MoveList.
--08-26 Fix Fixed bug where Target and Current Repositories were transposed in report.
--08-24 Fix Changed hascontents to contentcount and change contentcount to a filter rather than
-bool.
--08-24 Enhancement Added iscontainer and hascontents to the config file filter logic.
--05-16 Enhancement Added environmental varialbe TMSSCANFILEUNQUALIFIED which
-will load and check volumes without Customer-ID and Media-ID qualifiers.
--05-16 Enhancement Added environmental varialbe TMSSSCANFILENOPARSE which will
-presume scanfile items are only Volumes and not parse them, saving time.
--05-16 Enhancement When loading scanfile from import definition, added CUSTOMER and
-MEDIA keywords to set defaults.
--05-16 Enhancement When loading scanfile from import definition, changed keyword from
-VOLUME to BARCODE.
--05-16 Enhancement Added TMSSUNQUALIFIEDVOLUME environmental variable which
-forces all barcodes to be printed without Customer-ID and Media-ID.
--05-04 Enhancement Added support for AD passwords to all command line programs (check
-for environmental variable TMSSNOMD5).
--04-21 Enhancement Changed headings Move From/To to From Repository/To Repository.
--02-17 Enhancement Changed moving minutes to D:H:M:S format.
--11-20 Fix Fixed bug where from and to locations were transposed in output.
--11-20 Fix Changed Physical (Non-Virtual) report option to print Repository description rather
-than No-Alloc when slot is zero.
--11-19 Fix Changed server argument parser to allow colon in password to support z/OS DD
-name files.
-TMSS10MoveList
--10-26 Enhancement Upgraded development environment from Visual Studio 2012 to Visual
-Studio 2013.
--08-13 Enhancement Added report that lists totals for Volumes moving in each direction.