| |
| cli:introduction [2018/03/09 00:33] – [TMSS10Sync Utilities] Scott Cunliffe | cli:introduction [2025/01/21 22:07] (current) – external edit 127.0.0.1 |
|---|
| |
| <note tip>While most utilities are available for Linux and Windows, other platforms only support a subset of the full command suite.</note> | <note tip>While most utilities are available for Linux and Windows, other platforms only support a subset of the full command suite.</note> |
| |
| |
| |
| ===== Automation Utilities ===== | ===== Automation Utilities ===== |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ |
| | [[cli:TMSS10AssignContainer |TMSS10AssignContainer ]] | Assigns volumes to container/s. | | | [[cli:TMSS10AssignContainer |TMSS10AssignContainer ]] | Assigns [[object:volume|Volumes]] to Container/s. | |
| | | [[cli:TMSS10BatchLoader|TMSS10BatchLoader]] | Creates [[object:customer|Customer]], [[object:media|Media]] and [[object:repository|Repositories]] from a configuration file | |
| | | [[cli:TMSS10BatchSlotAllocation|TMSS10BatchSlotAllocation]] | Export and Import Slot Allocation information | |
| | [[cli:TMSS10BillingMergeElements|TMSS10BillingMergeElements]] | Merges TapeTrack billing file elements.| | | [[cli:TMSS10BillingMergeElements|TMSS10BillingMergeElements]] | Merges TapeTrack billing file elements.| |
| | [[cli:TMSS10Catalog_NBU|TMSS10Catalog_NBU]] | Creates Catalog entries from NetBackup output.| | | [[cli:TMSS10Catalog_NBU|TMSS10Catalog_NBU]] | Creates Catalog entries from NetBackup output.| |
| | [[cli:TMSS10Catalog_Networker|TMSS10Catalog_Networker]] | Creates Catalog entries from Networker output.| | | [[cli:TMSS10Catalog_Networker|TMSS10Catalog_Networker]] | Creates Catalog entries from Networker output.| |
| | [[cli:TMSS10Confirm |TMSS10Confirm ]] | Confirms selected tapes that are in a move status. | | | [[cli:TMSS10Confirm |TMSS10Confirm ]] | Confirms selected tapes that are in a move status. | |
| | [[cli:TMSS10Custom_BillByAge|TMSS10Custom_BillByAge]] | Produces TapeTrack Billing XML records based on the length of time a Volume has been in a Repository.| | | [[cli:TMSS10Custom_BillByAge|TMSS10Custom_BillByAge]] | Produces TapeTrack Billing XML records based on the length of time a [[object:volume|Volume]] has been in a [[object:repository|Repository]].| |
| | [[cli:TMSS10ExpireByDate |TMSS10ExpireByDate ]] | Adds a 'Move Pending flag' to Volumes within the specified 'Next Move Date' range . | | | [[cli:TMSS10ExpireByDate |TMSS10ExpireByDate ]] | Adds a 'Move Pending' [[common:volume_flags|Flag]] to [[object:volume|Volumes]] within the specified 'Next Move Date' range . | |
| | [[cli:TMSS10ExpireDRStrategies |TMSS10ExpireDRStrategies ]] | Deletes all expired Disaster Recovery Strategies. | | | [[cli:TMSS10ExpireDRStrategies |TMSS10ExpireDRStrategies ]] | Deletes all expired Disaster Recovery Strategies. | |
| | [[cli:TMSS10ExpireFiles |TMSS10ExpireFiles ]] | Deletes all expired files that have been uploaded to the TapeTrack Server. | | | [[cli:TMSS10ExpireFiles |TMSS10ExpireFiles ]] | Deletes all expired files that have been uploaded to the TapeTrack Server. | |
| | [[cli:tmss10librarymanager |TMSS10LibraryManager ]] | Synchronizes one TapeTrack Server with another. | | | [[cli:tmss10librarymanager |TMSS10LibraryManager ]] | Synchronizes one TapeTrack Server with another. | |
| | [[cli:tmss10mergexml |TMSS10MergeXML ]] | Merges XML files at specified nodes. | | | [[cli:tmss10mergexml |TMSS10MergeXML ]] | Merges XML files at specified nodes. | |
| | [[cli:tmss10mirror |TMSS10Mirror ]] | Replicates location information from one TapeTrack server to another. | | | [[cli:tmss10mirror |TMSS10Mirror ]] | Replicates location information from one TapeTrack Server to another. | |
| | [[cli:tmss10modifyflags |TMSS10ModifyFlags]] | Sets or unsets volume flags. | | | [[cli:tmss10modifyflags |TMSS10ModifyFlags]] | Sets or un-sets [[object:volume|Volumes]] [[common:volume_flags|Flag]]s. | |
| | [[cli:tmss10movelocation |TMSS10MoveLocation ]] | Moves volumes from one repository to another. | | | [[cli:tmss10movelocation |TMSS10MoveLocation ]] | Moves [[object:volume|Volumes]] from one [[object:repository|Repository]] to another. | |
| | [[cli:tmss10movepending |TMSS10MovePending ]] | Add a P flag to volumes with an expired next move date. | | | [[cli:tmss10movepending |TMSS10MovePending ]] | Move [[object:volume|Volumes]] with a P [[common:volume_flags|Flag]]. | |
| | [[cli:tmss10reconcile |TMSS10Reconcile]] | Performs a batch Reconciliation on a Repository.| | | [[cli:tmss10reconcile |TMSS10Reconcile]] | Performs a batch Reconciliation on a [[object:repository|Repository]].| |
| | [[cli:tmss10resolve |TMSS10Resolve]] | Resolves environmental variables in an input file.| | | [[cli:tmss10resolve |TMSS10Resolve]] | Resolves environmental variables in an input file.| |
| | [[cli:tmss10scsi2scanfile |TMSS10SCSI2ScanFile]] | Creates a Scan-File from the current inventory of SCSI attached Media Changer. | | | [[cli:tmss10scsi2scanfile |TMSS10SCSI2ScanFile]] | Creates a Scan-File from the current inventory of SCSI attached Media Changer. | |
| | [[cli:tmss10slotallocation |TMSS10SlotAllocation]] | Allocate slots to volumes that are un-slotted. | | | [[cli:tmss10slotallocation |TMSS10SlotAllocation]] | Allocate slots to [[object:volume|Volumes]] that are un-slotted. | |
| | [[cli:tmss10uploadfile |TMSS10UploadFile]] | Upload a file to the TapeTrack Server. | | | [[cli:tmss10uploadfile |TMSS10UploadFile]] | Upload a file to the TapeTrack Server. | |
| | [[cli:tmss10validatebarcode |TMSS10ValidateBarCode]] | Validate barcode formats. | | | [[cli:tmss10validatebarcode |TMSS10ValidateBarCode]] | Validate Barcode formats. | |
| | [[cli:tmss10volumerename |TMSS10VolumeRename]] | Rename a volume or list of volumes. | | | [[cli:tmss10volumedelete |TMSS10VolumeDelete]] | Rename a [[object:volume|Volume]] or list of [[object:volume|Volumes]]. | |
| | | [[cli:tmss10volumerename |TMSS10VolumeRename]] | Rename a [[object:volume|Volume]] or list of [[object:volume|Volumes]]. | |
| |
| |
| |
| ===== Reporting Utilities ===== | ===== Reporting Utilities ===== |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ Report-ID ^ |
| | [[cli:TMSS10Inventory|TMSS10Inventory ]] | Produces a report listing all of the selected volumes. | | | [[cli:TMSS10Inventory|TMSS10Inventory ]] | Produces a report listing all of the selected Volumes. | 100 101 | |
| | [[cli:TMSS10LibraryHealth|TMSS10LibraryHealth ]] | Produces a report listing current health of selected customers. | | | [[cli:TMSS10LibraryHealth|TMSS10LibraryHealth ]] | Produces a report listing current health of selected customers. | | |
| | [[cli:TMSS10ListCatalog|TMSS10ListCatalog]] | Produces a list Catalog entries. | | | [[cli:TMSS10ListCatalog|TMSS10ListCatalog]] | Produces a report listing Catalog Entries | | |
| | [[cli:TMSS10ListClients|TMSS10ListClients]] | Produces a list of all TapeTrack Software that has connected to the TapeTrack Server. | | | [[cli:TMSS10ListClients|TMSS10ListClients]] | Produces a list of all TapeTrack Software that has connected to the TapeTrack Server. | | |
| | [[cli:TMSS10ListConsignments|TMSS10ListConsignments]] | Produces a list of TapeTrack Consignments. | | | [[cli:TMSS10ListContainer|TMSS10ListContainer]] | Produces a list of Containers and contents. | 123 | |
| | [[cli:TMSS10ListDRStrategies|TMSS10ListDRStrategies]] | Produces a list of DR Strategies. | | | [[cli:TMSS10ListCustomers|TMSS10ListCustomers]] | Produces a list of TapeTrack [[object:customer|Customer]] records. | | |
| | [[cli:TMSS10ListHistory|TMSS10ListHistory]] | Produces a list of volume history records. | | | [[cli:TMSS10ListConsignments|TMSS10ListConsignments]] | Produces a list of TapeTrack Consignments. | | |
| | [[cli:TMSS10ListMoveHistory|TMSS10ListMoveHistory]] | Produces a list of the movement history of each volume. | | | [[cli:TMSS10ListDRStrategies|TMSS10ListDRStrategies]] | Produces a list of DR Strategies. | | |
| | [[cli:TMSS10ListOutages|TMSS10ListOutages]] | Produces a list of TapeTrack Server downtime. | | | [[cli:TMSS10ListHistory|TMSS10ListHistory]] | Produces a list of [[object:volume|Volume]] history records. | 104 105 | |
| | [[cli:TMSS10ListRepositories|TMSS10ListRepositories]] | Produces a list of the current status of each repository. | | | [[cli:TMSS10ListMoveHistory|TMSS10ListMoveHistory]] | Produces a list of the movement history of each [[object:volume|Volume]]. | | |
| | [[cli:TMSS10ListStorageHistory|TMSS10ListStorageHistory]] | Produces a list of storage history between specified date range. | | | [[cli:TMSS10ListOutages|TMSS10ListOutages]] | Produces a list of TapeTrack Server downtime. | | |
| | [[cli:TMSS10ListUsage|TMSS10ListUsage]] | Produces a report on volume health.| | | [[cli:TMSS10ListRepositories|TMSS10ListRepositories]] | Produces a list of the current status of each [[object:repository|Repository]]. | | |
| | [[cli:tmss10logstatsprocess |TMSS10LogStatsProcess ]] | Processes TapeTrack statistics file applying calculations and report in XML format. | | | [[cli:TMSS10ListStorageHistory|TMSS10ListStorageHistory]] | Produces a list of storage history between specified date range. | | |
| | [[cli:tmss10movedatelist |TMSS10MoveDateList ]] | Produce a list of volumes set to move on each given date. | | | [[cli:TMSS10ListUsage|TMSS10ListUsage]] | Produces a report on [[object:volume|Volume]] health. | | |
| | [[cli:TMSS10MoveList|TMSS10MoveList ]] | Produce a report listing all of the volumes that are in a move status. | | | [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess ]] | Processes TapeTrack statistics file applying calculations and report in XML format. | | |
| | [[cli:tmss10zonelist|TMSS10ZoneList ]] | Produce a report listing Zones and volumes assigned to those zones. | | | [[cli:tmss10movedatelist|TMSS10MoveDateList ]] | Produce a list of [[object:volume|Volume]] set to move on each given date. | 106 | |
| | | [[cli:TMSS10MoveList|TMSS10MoveList ]] | Produce a report listing all of the [[object:volume|Volumes]] that are in a move status. | 102 103 | |
| | | [[cli:tmss10zonelist|TMSS10ZoneList ]] | Produce a report listing Zones and [[object:volume|Volumes]] assigned to those Zones. | | |
| |
| | See Also for Report-ID: |
| |
| | [[variable:tmssreporttitle|TMSSREPORTTITLE]] \\ |
| | [[variable:tmssdropreport|TMSSDROPREPORT]] |
| ===== Housekeeping Utilities ===== | ===== Housekeeping Utilities ===== |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ |
| | [[cli:TMSS10PasswordResetDB |TMSS10PasswordResetDB]] | Reset a TapeTrack password by zapping the TapeTrack User Database. | | | [[cli:TMSS10PasswordResetDB |TMSS10PasswordResetDB]] | Reset a TapeTrack password by zapping the TapeTrack User Database. | |
| |
| ===== TMSS10Sync Utilities ===== | ===== Sync Utilities ===== |
| | |
| | Sync utilities are installed with TapeTrack Sync |
| |
| ^ Command ^ Description | ^ Command ^ Description |
| | [[cli:tmss10csv2fixed|TMSS10CSV2Fixed]] | Converts a csv file to fixed width text file | | | [[cli:tmss10csv2fixed|TMSS10CSV2Fixed]] | Converts a csv file to fixed width text file | |
| | [[cli:tmss10downloadfile|TMSS10DownloadFile]] | Downloads a file from the TapeTrack Server | | | [[cli:tmss10downloadfile|TMSS10DownloadFile]] | Downloads a file from the TapeTrack Server | |
| | [[cli:tmss10drp_brms|TMSS10DRP_BRMS]] | Extracts critical Volume information from a BRMS Disaster Recovery Plan File | | | [[cli:tmss10drp_brms|TMSS10DRP_BRMS]] | Extracts critical [[object:volume|Volume]] information from a BRMS Disaster Recovery Plan File | |
| | [[cli:tmss10drp_tsm|TMSS10DRP_TSM]] | Extracts critical Volume information from a TSM Disaster Recovery Plan File | | | [[cli:tmss10drp_tms|TMSS10DRP_TSM]] | Extracts critical [[object:volume|Volume]] information from a TSM Disaster Recovery Plan File | |
| | [[cli:tmss10drstrategy|TMSS10DRStrategy]] | Creates a TapeTrack Disaster Recovery Strategy | | | [[cli:tmss10drstrategy|TMSS10DRStrategy]] | Creates a TapeTrack Disaster Recovery Strategy | |
| | [[cli:tmss10movescratch|TMSS10MoveScratch]] | Resets the scratch flag of each Volume and move scratch Volumes to another Repository | | | [[cli:tmss10movescratch|TMSS10MoveScratch]] | Resets the scratch [[common:volume_flags|Flag]] of each [[object:volume|Volume]] and move Scratch [[object:volume|Volumes]] to another [[object:repository|Repository]] | |
| | [[cli:tmss10page2csv|TMSS10Page2CSV]] | Converts a report in Page Format to a CSV File | | | [[cli:tmss10page2csv|TMSS10Page2CSV]] | Converts a report in Page Format to a CSV File | |
| | [[cli:tmss10batch:TMSSBatch]] | Construct and execute a batch file with specified input | | | [[cli:tmssbatch|TMSSBatch]] | Construct and execute a batch file with specified input | |
| | [[cli:tmss10singlespace|TMSS10SingleSpace]] | Convert a file of words into a file delimited by a single delimiter. | | | [[cli:tmss10singlespace|TMSS10SingleSpace]] | Convert a file of words into a file delimited by a single delimiter. | |
| | | [[cli:tmss10sync|TMSS10Sync]] | Synchronize data from a file or ODBC source to a TapeTrack Server. | |
| |
| | ===== SecureSync Utilities ===== |
| |
| | | [[cli:tmss10irm_export | TMSS10IRM_Export]] | Reads in an Iron Mountain inventory file and creates a TapeTrack import file| |
| | | [[cli:tmss10irm_ftp | TMSS10IRM_FTP]] | FTP's an Iron Mountain transmission file| |
| | | [[cli:tmss10sftp | TMSS10SFTP]] | SFTP's an Iron Mountain transmission file| |
| | | [[cli:tmss10irm_reconcile | TMSS10IRM_Reconcile]] | Processes an Iron Mountain inventory file and produces a TapeTrack Scan-File for reconciliation| |
| | | [[cli:tmss10irm_send | TMSS10IRM_Send]] | Produces an Iron Mountain format picking and distribution file| |
| | | [[cli:tmss10irm_sync | TMSS10IRM_Sync]] | Keeps the TapeTrack Server synchronized with an Iron Mountain inventory file| |
| | | [[cli:tmss10reconcile |TMSS10Reconcile]] | Performs a batch Reconciliation on a [[object:repository|Repository]].| |
| |
| | ===== Server Utilities ===== |
| | |
| | | [[cli:tmss10logstatsprintdb | TMSS10LogStatsPrintDB ]] | Prints the contents of the Journal database | |
| | | [[cli:tmss10importfiledb | TMSS10ImportFileDB ]] | Program will load TapeTrack data produced by TMSS10ExportFile| |
| | | [[cli:tmss10logstatsextractdb | TMSS10LogStatsExtractDB]] | Program will create an Extract file for each Customer from the Journal database | |
| | | [[cli:tmss10passwordresetdb | TMSS10PasswordResetDB]] | Program will reset the password of a User | |
| | | [[cli:tmss10processmaildb | TMSS10ProcessMailDB]] | Program will send emails to all TapeTrack Users with queued messages | |
| | |
| | |
| | |
| | |
| | ===== Desktop Software Utilities ===== |
| |
| ===== Miscellaneous Utilities ===== | |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ |
| | [[TMSS10Ping |TMSS10Ping ]] | Test the connection to a TapeTrack Framework Server. | | | [[TMSS10Ping |TMSS10Ping ]] | Test the connection to a TapeTrack Framework Server. | |
| |
| | See also [[master:run_command_ping|Run TMSS10Ping From TapeMaster]] |
| |
| ===== Command Line Utility Use Examples ===== | ===== Framework Server Utilities ===== |
| |
| [[command_line_examples|Command line examples]] | ^ Command ^ Description |
| | | [[db_hotbackup|]] | Backup database while operational | |
| |
| | ===== TMSS20 Utilities ===== |
| | |
| | ^ Command ^ Description |
| | | [[tmss20ddsnbuextract|TMSS20DDSNBUExtract]] | DataFort DDS File Export NetBackup Extract | |
| | |
| | ===== Command Line Utility Use Examples ===== |
| |
| | [[command_line_examples|Command line examples]] \\ |
| | [[command_line_filters|Command Line Filters]] |
| |
