TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools

Trace:
cli:tmss10batchloader

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
cli:tmss10batchloader [2019/06/03 02:23] – Scott Cunliffecli:tmss10batchloader [2025/07/04 04:42] (current) – [Example] Scott Cunliffe
Line 1: Line 1:
 ====== TMSS10BatchLoader ====== ====== TMSS10BatchLoader ======
 +
 +TMSS10BatchLoader creates [[object:customer|Customer]], [[object:media|Media]] and [[object:repository|Repositories]] by loading a Configuration file into the TapeTrack Database.
  
 ===== Synopsis ===== ===== Synopsis =====
  
 ''TMSS10BatchLoader [-c configuration file] [-S logonstring]'' ''TMSS10BatchLoader [-c configuration file] [-S logonstring]''
- 
-===== Description ===== 
- 
-''TMSS10BatchLoader'' creates Customer, Media and Repositories by loading a configuration file into the TapeTrack Database. 
  
 ===== Options ===== ===== Options =====
Line 14: Line 12:
   * ''-S'' Logon string argument sets the [[cli:server_argument|Server logon information]].   * ''-S'' Logon string argument sets the [[cli:server_argument|Server logon information]].
  
 +
 +{{page>cli:fi}}
 ===== Editable Fields ===== ===== Editable Fields =====
  
Line 32: Line 32:
     * {{:master:tapemaster_repository_ordered.png}} Ordered (value = 7)      * {{:master:tapemaster_repository_ordered.png}} Ordered (value = 7) 
     * {{:master:tapemaster_repository_scratch.png}} Scratch (value = 8)     * {{:master:tapemaster_repository_scratch.png}} Scratch (value = 8)
-  * [[master:repository_options#next-repository|Next Repository]]+  * [[options:repository:next_repository|Next Repository]]
   * [[master:media#options_tab|Auto Container flag]]   * [[master:media#options_tab|Auto Container flag]]
  
Line 38: Line 38:
 ==== Technical Support ==== ==== 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.+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 ==== ==== Exit Statuses ====
Line 55: Line 57:
 === Configuration File === === Configuration File ===
  
-Configuration file to create two Customers with attributes:+Configuration file to create two [[object:customer|Customers]] with Attributes:
  
 Customer 0001 Customer 0001
-  * Customer-ID: US01, Customer Description: New York Data Center. +  * [[object:customer|Customer-ID]]: US01, [[object:customer|Customer Description]]: New York Data Center. 
-  * Media-ID: LTO, Media Description: LTO Cartridge. +  * [[object:media|Media-ID]]: LTO, [[object:media|Media Description]]: LTO Cartridge. 
-  * Repository-ID: LIBR, Repository Description: Library, Repository Type: 1, Next Repository: OFFS. +  * [[object:repository|Repository-ID]]: LIBR, [[object:repository|Repository Description]]: Library, [[options:repository:type|Repository Type]]: 1, [[options:repository:next_repository|Next Repository]]: OFFS. 
-  * Repository-ID: OFFS, Repository Description: Iron Mountain, Repository Type: 2. +  * [[object:repository|Repository-ID]]: OFFS, [[object:repository|Repository Description]]: Iron Mountain, [[options:repository:type|Repository Type]]: 2. 
-  * Repository-ID: DEST, Repository Description: Destroyed, Repository Type: 6.  +  * [[object:repository|Repository-ID]]: DEST, [[object:repository|Repository Description]]: Destroyed, [[options:repository:type|Repository Type]]: 6.  
-  * Repository-ID: HOLD, Repository Description: Legal Hold, Repository Type: 4 .+  * [[object:repository|Repository-ID]]: HOLD, [[object:repository|Repository Description]]: Legal Hold, [[options:repository:type|Repository Type]]: 4 .
  
 Customer 0002 Customer 0002
-  * Customer-ID: US02, Customer Description: Los Angeles Data Center.  +  * [[object:customer|Customer-ID]]: US02, [[object:customer|Customer Description]]: Los Angeles Data Center.  
-  * Media-ID: 3490, Media Description: IBM 3490 Cartridge. +  * [[object:media|Media-ID]]: 3490, [[object:media|Media Description]]: IBM 3490 Cartridge. 
-  * Repository-ID: LIBR, Repository Description: Library, Repository Type: 1, Next Repository: OFFS. +  * [[object:repository|Repository-ID]]: LIBR, [[object:repository|Repository Description]]: Library, [[options:repository:type|Repository Type]]: 1, [[options:repository:next_repository|Next Repository]]: OFFS. 
-  * Repository-ID: OFFS, Repository Description: Iron Mountain, Repository Type: 2 and Next Repository: LIBR.+  * [[object:repository|Repository-ID]]: OFFS, [[object:repository|Repository Description]]: Iron Mountain, [[options:repository:type|Repository Type]]: 2 and [[options:repository:next_repository|Next Repository]]: LIBR.
  
-{{:cli:master.txt|Download Sample Configuration file.  \\ +{{:cli:master.txt|Download Sample Configuration file.}}
-Once downloaded the file extension must be changed to .cfg}}.+
  
  
-<sxh> 
-setup= 
-{ 
-   customers= 
-   ( 
-      {  
-          id="US01"; description="New York Data Center"; 
  
-          media= +<code> 
-          ( +  setup= 
-             {  +  { 
-                 id="LTO"; description="LTO Cartridge"; +     customers= 
- +     ( 
-                 repositories= +        {  
-                 ( +            id="US01"; description="New York Data Center"; 
-                     { id="LIBR"; description="Library"; type=3; next="OFFS"; }, +   
-                     { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; }, +            media= 
-                     { id="DEST"; description="Destroyed"; type=6; }, +            ( 
-                     { id="HOLD"; description="Legal hold"; type=4; } +               {  
-                 ) +                   id="LTO"; description="LTO Cartridge"; 
-             }, +   
-             {  +                   repositories=
-                 id="3490"; description="IBM 3490 Cartridge"; +
- +
-                 repositories= +
-                 ( +
-                     { id="LIBR"; description="Library"; type=3; next="OFFS"; }, +
-                     { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } +
-                 ) +
-             }     +
-          ) +
-      }, +
-      {  +
-          id="US02"; description="Los Angeles Data Center"; +
- +
-          media= +
-          ( +
-             {  +
-                 id="LTO"; description="LTO Cartridge"; +
- +
-                 repositories= +
-                 ( +
-                     { id="LIBR"; description="Library"; type=3; }, +
-                     { id="OFFS"; description="Iron Mountain"; type=2; } +
-                 ) +
-             }, +
-             {  +
-                 id="3490"; description="IBM 3490 Cartridge"; +
- +
-                 repositories=+
                  (                  (
-                     { id="LIBR"; description="Library"; type=3; }, +                       { id="LIBR"; description="Library"; type=3; next="OFFS"; }, 
-                     { id="OFFS"; description="Iron Mountain"; type=2; } +                       { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; }, 
-                 ) +                       { id="DEST"; description="Destroyed"; type=6; }, 
-             }     +                       { id="HOLD"; description="Legal hold"; type=4; } 
-          ) +                   ) 
-      } +               }, 
-   ); +               {  
-}; +                   id="3490"; description="IBM 3490 Cartridge"; 
-</sxh>+   
 +                   repositories= 
 +                   ( 
 +                       { id="LIBR"; description="Library"; type=3; next="OFFS"; }, 
 +                       { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } 
 +                   ) 
 +               }     
 +            ) 
 +        }, 
 +        {  
 +            id="US02"; description="Los Angeles Data Center"; 
 +   
 +            media= 
 +            ( 
 +               {  
 +                   id="LTO"; description="LTO Cartridge"; 
 +   
 +                   repositories= 
 +                   ( 
 +                       { id="LIBR"; description="Library"; type=3; }, 
 +                       { id="OFFS"; description="Iron Mountain"; type=2; } 
 +                   ) 
 +               }, 
 +               {  
 +                   id="3490"; description="IBM 3490 Cartridge"; 
 +   
 +                   repositories= 
 +                   ( 
 +                       { id="LIBR"; description="Library"; type=3; }, 
 +                       { id="OFFS"; description="Iron Mountain"; type=2; } 
 +                   ) 
 +               }     
 +            ) 
 +        } 
 +     ); 
 +  }; 
 +</code>
  
  
 === Command line syntax === === Command line syntax ===
  
-<sxh>TMSS10BatchLoader -S user:-password@localhost -c master.cfg</sxh>+  TMSS10BatchLoader -S user:-password@localhost -c master.cfg 
  
 === Output Results === === Output Results ===
  
-{{cli:tmss10batchloder.output.png}}+{{tmss10batchloder_output.png}}
  
  
 ---- ----
  
-When creating multiple Customers with identical Media Types and/or Repositories it is possible to create a configuration file with these attributes and include it in the master configuration file to save duplication of code blocks.+=== Configuration Files - Minimising Duplicate Code === 
 + 
 +When creating multiple [[object:customer|Customers]] with identical [[object:media|Media Types]] and/or [[object:repository|Repositories]] it is possible to create a configuration file with these Attributes and include it in the master configuration file to save duplication of code blocks.
  
 To create two customers, US01 and US02, with: To create two customers, US01 and US02, with:
-  * Media-ID: LTO, Media Description: LTO Cartridge. +  * [[object:media|Media-ID]]: LTO, [[object:media|Media Description]]: LTO Cartridge. 
-  * Media-ID: 3490, Media Description: IBM 3490 Cartridge. +  * [[object:media|Media-ID]]: 3490, [[object:media|Media Description]]: IBM 3490 Cartridge. 
-  * Repository-ID: LIBR, Repository Description: Library, Repository Type: 1, Next Repository: OFFS. +  * [[object:repository|Repository-ID]]: LIBR, [[object:repository|Repository Description]]: Library, [[options:repository:type|Repository Type]]: 1, [[options:repository:next_repository|Next Repository]]: OFFS. 
-  * Repository-ID: OFFS, Repository Description: Iron Mountain, Repository Type: 2 and Next Repository: LIBR.+  * [[object:repository|Repository-ID]]: OFFS, [[object:repository|Repository Description]]: Iron Mountain, [[options:repository:type|Repository Type]]: 2 and [[options:repository:next_repository|Next Repository]]: LIBR.
  
 <note tip>A configuration file may “include” the contents of another file using an include directive.  <note tip>A configuration file may “include” the contents of another file using an include directive. 
  
-This directive has the effect of inlining the contents of the named file at the point of inclusion.+This directive has the effect of in-lining the contents of the named file at the point of inclusion.
  
 An include directive must appear on its own line in the input. It has the form: An include directive must appear on its own line in the input. It has the form:
Line 167: Line 171:
  
 === Configuration Files === === Configuration Files ===
 +
 +== master.cfg ==
 +
 + 
 +  setup=
 +  {
 +     customers=
 +     (
 +        { 
 +            id="US01"; description="New York Data Center";
 +            @include "include.cfg"    
 +        },
 +        { 
 +            id="US02"; description="Los Angeles Data Center";
 +            @include "include.cfg"  
 +        }
 +     );
 +  };
 +
  
 == include.cfg == == include.cfg ==
  
-<sxh> 
-          media= 
-          ( 
-             {  
-                 id="LTO"; description="LTO Cartridge"; 
  
-                 repositories= +            media= 
-                 ( +            ( 
-                     { id="LIBR"; description="Library"; type=3; next="OFFS"; }, +               {  
-                     { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } +                   id="LTO"; description="LTO Cartridge"; 
-                 ) +   
-             }, +                   repositories= 
-             {  +                   ( 
-                 id="3490"; description="IBM 3490 Cartridge";+                       { id="LIBR"; description="Library"; type=3; next="OFFS"; }, 
 +                       { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } 
 +                   ) 
 +               }, 
 +               {  
 +                   id="3490"; description="IBM 3490 Cartridge"; 
 +   
 +                   repositories= 
 +                   ( 
 +                       { id="LIBR"; description="Library"; type=3; next="OFFS"; }, 
 +                       { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } 
 +                   ) 
 +               }     
 +            )
  
-                 repositories= 
-                 ( 
-                     { id="LIBR"; description="Library"; type=3; next="OFFS"; }, 
-                     { id="OFFS"; description="Iron Mountain"; type=2; next="LIBR"; } 
-                 ) 
-             }     
-          ) 
-</sxh> 
  
-== master.cfg == 
  
-<sxh> 
-setup= 
-{ 
-   customers= 
-   ( 
-      {  
-          id="US01"; description="New York Data Center"; 
-          @include "include.cfg"     
-      }, 
-      {  
-          id="US02"; description="Los Angeles Data Center"; 
-             @include "include.cfg"   
-      } 
-   ); 
-}; 
-</sxh> 
  
 === Command line syntax === === Command line syntax ===
  
-<sxh>TMSS10BatchLoader -S user:-password@localhost -c master.cfg</sxh>+  TMSS10BatchLoader -S user:-password@localhost -c master.cfg 
  
 === Output Results === === Output Results ===
 {{cli:tmss10batchloder.output_include.png}} {{cli:tmss10batchloder.output_include.png}}
 +
 +===== See Also=====
 +
 +[[technote/command_line_diagnosis|Command Line Utility Troubleshooting and Diagnosis]]
 +
 +--> Changelog
 +[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10BatchLoader]
 +<--
  
cli/tmss10batchloader.1559528618.txt.gz · Last modified: 2025/01/21 22:07 (external edit)