Differences

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

--- cli:tmss10inventory [2017/08/11 16:31] – created dcumming
+++ cli:tmss10inventory [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-Synopsis
+====== TMSS10Inventory ======
-TMSS10Inventory  [-V volume filter] [-N relative resolve] [-S logonstring]  [-c config file]  [-R Scan list file output]
+TMSS10Inventory produces an Inventory Report of all selected [[object:volume|Volumes]].
-Description
-TMSS10Inventory produces an Inventory Report of all selected Volumes
+By default, this program accepts pairs of Integers as arguments, with each successive pair representing the next column within a CSV file.
+The first Integer is the zero-based offset within the output file, and the second is the length of the field that is output.
-Options
+Alternatively, if the first argument of the first pair contains a colon, the Integer on the left-hand side of the colon will set the relative column, and any future pair will be offset from that column. In the event that other pairs also start with a colon, this too will set the column and future columns from that column index.
--V
+In the event that the program is run with no arguments, the program will display a suggested calling syntax taking into account the maximum values calculated by processing the supplied data.
-The volume filter 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).
+===== Synopsis =====
--N
+''TMSS10Inventory [-A attribute index] [-M mode] [-N no relative resolve] [-R output a scan list file] [-S logon string] [-V volume filter] [-c configuration file]''
-No Relative Resolve.
+===== Options =====
--S
+  * ''-A'' Attribute Index (default = 0)
+  * ''-M'' Sets the output mode.
+  * ''-N'' No relative resolve.
+  * ''-R'' Outputs results to a scan list file.
+  * ''-S'' The Logon string argument sets the [[cli:server_argument|Server Logon Lnformation]].
+  * ''-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'' 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.
-The logon string 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.
+{{page>cli:fi}}
--c
+{{page>cli:attribute}}
-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. The following example will set the default Customer-ID and Media-ID for all scanned barcodes:
+===== Notes =====
-barcodes =
+Running TMSS10Inventory in mode 1 (default) will produce a report with the values:
-{
+Sequence, [[concepts:qualified_barcode|Barcode]], Location, [[object:repository|Repository]], Next Move, Days, Last Move, GDup (Global Duplicate), CDup (Customer Duplicate) and Container.
-	defaults={ customer-id="ACME"; media-id="LTO"; };
-};
--R Output a Scan List File.
-Notes
+Running TMSS10Inventory in mode 2 will produce a report with the values:
+Sequence, [[object:customer|Customer]], [[object:media|Media]], Total and Moving total.
-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.
+TMSS10Inventory output can include up to twenty attributes in the one report. To include more than one attribute, include attribute indexes seperated by commas using -A in the program call. For example to add attributes 0, 1 and 3 in the report use -A “0,1,3.
-Exit Statuses
+If the report is output to text, CSV, PDF attribute values over 30 characters long will be truncated to 28 characters and two full stops to indicate a truncated value (eg ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890 will show as ABCDEFGHIJKLMNOPQRSTUVWXYZ12..). Reports output to Excel will show full attribute values irrespective of character length.
-zero:
+Mode 1 \\
+Report-ID: 100
-Program has ended successfully.
+Mode 2 \\
+Report-ID: 101
+===== Technical Support =====
-non-zero:
+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.
-Program has not ended successfully.
+===== Exit Statuses =====
-Environment
+  - **zero** Program has ended successfully.
+  - **non-zero** Program has not ended successfully.
-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.
+===== Environment =====
-TMSSAPILOGDIR If defined the program will write out a trace file to this directory.
+===== Files =====
-TMSSPWPATH When no password value is passed in the logon string the program will look for the password in file C:/tapetrack/pw/batch, 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.
+**stdout:** Output Reports. \\
+**stderr:** Diagnostic messages. \\
+**stdin:** Program input.
-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.
-Example
+===== Example =====
-C:\WINDOWS\system32>tmss10inventory -S user:-password@server -V "US01.LTO.00000?L6"
+==== Customer US03 LTO inventory - Report Format 1 ====
-ZBT001N-12:31:26 TMSS10Inventory (c) GazillaByte 1998-2017
-ZBT002N-12:31:26 Compiled Feb 24 2017 at 15:53:56
+=== Command line syntax ===
-ZBT010I-12:31:26 this program produces an Inventory Report of all selected Volumes
-ZBT006N-12:31:26 Running Under Windows 10 (build 14393 10.00) on platform x64
+<code plain;>
-ZBT000N-12:31:26 Host is Little Endian
+TMSS10Inventory -S user:-password@server -V "US01.*.*" -M 1
-ZBT000N-12:31:26 Host is ASCII
+</code>
-ZBT000N-12:31:26 Binary is 64 bit
-ZBT000N-12:31:26 Current Working Directory is C:\WINDOWS\system32
+=== Output ===
-ZBT004N-12:31:26 Today is Tuesday, March 07, 2017
-ZBT005N-12:31:26 Running on Local
+<code plain;>
-ZBT006N-12:31:26 Process ID 19676
-ZBT000N-12:31:26 Parsing and validating command arguments
-ZBT001N-12:31:26 Server Interpreted as: Server(*************) Port(5000) User(******) Password(******)
-ZBT002N-12:31:26 Program Options:
-ZBT002N-12:31:26        (N) No Relative Resolve=false
-ZBT002N-12:31:26        (R) Output a Scan List File=false
-ZBT002N-12:31:26        (S) Server=<VALUE HIDDEN>
-ZBT002N-12:31:26        (V) Volume Filter=US01.LTO.00000?L6
-ZBT002N-12:31:26        (c) Configuration File=
-ZBT000N-12:31:26 Arguments parsed and validated with 0 errors
-ZBT000N-12:31:26 Checking for environment variable TMSSSERVERPROXY
-ZBT000N-12:31:31 Connection to server (192.241.211.124) successful
-ZBT000N-12:31:31 Logging on to TapeTrack Server
-ZBT000N-12:31:31 Registering Client at MACID(00:8c:fa:8e:02:f5:00:00) Result(Request OK)
-ZBT000N-12:31:36 Last Logon was at Tuesday, March 07, 2017 - 12:29:30 from 173.95.189.31 (cpe-173-95-189-31.nc.res.rr.com)
-ZBT000N-12:31:36 Welcome to Server: TapeTrack
-ZBT001N-12:31:36 Volume filter interpreted as: Customer(US01) Media(LTO) Volume(00000?L6) Repository(*) Flags()
-ZBT000N-12:31:36 Listing Customers
-ZBT000N-12:31:36 Customer List successful: Customers(6) Excluded(0)
-ZBT000N-12:31:36 Processing Customer: US01-New York Data Center (2278/20)
-ZBT000N-12:31:36 Listing Media
-ZBT000N-12:31:36 Media List successful: Media(2) Excluded(0)
              System: TapeTrack
  Report Description: Inventory List
-       Report Notes: Customer(New York Data Center) Media Type(LTO Cartridge)
+    Production Time: Monday, January 24, 2022 - 11:53:11 (AUS Eastern Daylight Time)
-    Production Time: Tuesday, March 07, 2017 - 12:31:37 (Eastern Standard Time)
+       Report Width: 164 bytes
-       Report Width: 161 bytes
- Seq.   Barcode              Location                       Repository                     Next Move  Days       Last Move        GDup CDup Container
+ Seq.   Barcode              Location                       Repository                     Expiry     Next Move  Last Move           GDup CDup Container
- ------ -------------------- ------------------------------ ------------------------------ ---------- ---------- ---------------- ---- ---- --------------------
+ ------ -------------------- ------------------------------ ------------------------------ ---------- ---------- ------------------- ---- ---- --------------------
-ZBT000N-12:31:37 Processing Media: LTO-LTO Cartridge
+US01.CONT.CONT001    No-Alloc [0]                   Offsite Vault                  Permanent  Permanent  2021-11-18 09:12:08    2    1 Is-Container:1
-ZBT000N-12:31:37 Listing Volumes
+US01.CONT.CONT002    No-Alloc [0]                   Offsite Vault                  Permanent  Permanent  2022-01-24 11:47:01    2    1 Is-Container:7
-ZBT000N-12:31:37 Volume List successful: Volumes(209) Excluded(0)
+US01.CONT.CONT003    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000000L6    No-Alloc [0]                   Library                                                                  2    1
+US01.CONT.CONT004    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000001L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT005    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000002L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT006    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000003L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT007    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000004L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT008    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000005L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT009    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000006L6    No-Alloc [0]                   Library                                                                  3    1
+US01.CONT.CONT010    No-Alloc [0]                   Library                        Permanent  Permanent                         2    1 Is-Container:0
-US01.LTO.000007L6    No-Alloc [0]                   Library                                                                  3    1
+US01.LTO.000000L4    Blue1 [1.1]                    Offsite Vault [1]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
-US01.LTO.000008L6    No-Alloc [0]                   Library                                                                  3    1
+US01.LTO.000001L4    Blue1 [1.2]                    Offsite Vault [2]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
-US01.LTO.000009L6    No-Alloc [0]                   Library                                                                  3    1
+US01.LTO.000002L4    Blue1 [1.3]                    Offsite Vault [3]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
- ------ -------------------- ------------------------------ ------------------------------ ---------- ---------- ---------------- ---- ---- --------------------
+US01.LTO.000003L4    Blue1 [1.4]                    Offsite Vault [4]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
-ZBT000N-12:31:37 Closing connection to TapeTrack Server
+US01.LTO.000004L4    Blue1 [1.5]                    Offsite Vault [5]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
-ZBT000N-12:31:37 Session Statistics:
+US01.LTO.000005L4    Blue1 [1.6]                    Offsite Vault [6]              Permanent  2022-04-24 2021-12-10 10:39:48    2    1
-ZBT000N-12:31:37        Seconds Connected: 6
+US01.LTO.000006L4    No-Alloc [0]                   Library                        Permanent  Permanent  2021-12-10 09:29:30    2    1
-ZBT000N-12:31:37        Queries Completed: 7
+US01.LTO.000007L4    No-Alloc [0]                   Library                        Permanent  Permanent  2021-11-18 09:11:57    2    1 US01.CONT.CONT001
-ZBT000N-12:31:37               Bytes Sent: 388
+US01.LTO.000008L4    No-Alloc [0]                   Library                        Permanent  Permanent  2021-12-10 10:41:57    2    1
-ZBT000N-12:31:37           Bytes Received: 4,468
+US01.LTO.000009L4    No-Alloc [0]                   Library                        Permanent  Permanent  2021-12-10 10:41:57    2    1
-ZBT900N-12:31:37 Program Complete
+US01.LTO.000010L4    No-Alloc [0]                   Library                        Permanent  Permanent  2021-12-10 10:41:57    2    1
-ZBT901N-12:31:37 Elapsed time 0 minutes and 11 seconds
+US01.LTO.000011L4    Blue1 [2.1]                    Offsite Vault [11]             Permanent  Permanent  2021-12-10 10:48:24    2    1
-ZBT991N-12:31:37 CRC values for this session: 0x3f6ca6d0 (0x515c4872)
+US01.LTO.000012L4    Blue1 [2.2]                    Offsite Vault [12]             Permanent  Permanent  2021-12-10 10:48:24    2    1
-ZBT992N-12:31:37 Number of records written: 43
+-----------------------------------------------------------------------------------------------------------------
-ZBT993N-12:31:37 Number of bytes written: 2,379
+</code>
-ZBT999N-12:31:37 Program ended
-Files
-stdout:
+^ Column Heading ^ Description ^
+| Seq | Record sequence number |
+|Barcode|Volume-ID.  Default is fully qualified barcode, use [[variable:tmssunqualifiedvolume|TMSSUNQUALIFIEDVOLUME]] to list unqualified Volume-ID's|
+|Location|Volume location: No-Alloc [0] = no Slot allocated, 1:2 [1.3] = Zone-ID 1:2, Shelf 1, Slot 3|
+|Repository|Repository Volume is currently located in|
+|Expiry|Expiry of retention date|
+|Next Move|Date of next move, Permanent = No next move|
+|Last Move|Last date the Volume was moved|
+|GDup|Global wide number of the Volume-ID, 1 = one instance or no duplicates|
+|CDup|Customer wide number of the Volume-ID, 1 = one instance or no duplicates|
+|Container|Container-ID if Volume is assigned to a Container, blank = not assigned to a Container.|
-Output Reports.
+----
+==== Customer US03 LTO inventory - Report Format 2 ====
+=== Command line syntax ===
+<code plain;>
+TMSS10Inventory -S user:-password@server -V "US01.*.*" -M 2
+</code>
+=== Output ===
+<code plain;>
+             System: TapeTrack
+          Report ID: 101
+ Report Description: Volume Inventory Extract
+    Production Time: Monday, January 24, 2022 - 11:56:02 (AUS Eastern Daylight Time)
+       Report Width: 92 bytes
-stderr:
+ Seq.   Customer                                 Media                Total      Moving
+ ------ ---------------------------------------- -------------------- ---------- ----------
+New York Data Center                     Container                    10          0
+New York Data Center                     LTO Cartridge               103         32
+ ------ ---------------------------------------- -------------------- ---------- ----------
+</code>
-Diagnostic messages.
+--> Changelog
-stdin:
+[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10Inventory]
+<--
-Program input.
+<- ^ cli:introduction|Command Line Utilities^ ->