Tools and Utilities

Topics | How To


Several tools and utilities are provided with the software. The tools and utilities listed in this page are included in the Resource Pack available in the Maintenance Advantage Web site. Download the latest version before use.

The following table provides a list of tools and utilities available, their brief description, and support information. For more details on how to use the tool/utility, read the appropriate readme provided with the tool/utility. For disclaimer information regarding the tool/utility, see Disclaimer of Warranties.

Utility/Tool Name

Description

Supported in:

    Windows
32-bit
Windows
Intel Itanium
Windows
x64
Unix NetWare

Automatic Updates

FTPDownloadTest This utility tests the FTP download for use by the Automatic Update feature. X   X    

CDR, QR, and Snaps

CDRPredictor*
(cdrp for Unix)
This utility can be used to track the size of the data that has been added or modified on a specified volume. X X X X  
ShadowExplorer This tool helps with the management and testing of VSS writers, hardware providers, and volumes created by VSS and VDS shadow copy. X        
VSBackupUtil The utility can be used to backup virtual machines on Microsoft Virtual Server and Microsoft Hyper-V. X X X    

Client Management

DataIfPairs This utility can be used to perform the following operations:
  • Add pipeline interface pairs in bulk using client and interface names defined in an input file.
  • Remove all dangling pairs from deleted clients.
X   X    
EnableDisableComputers This utility can be used to disable or enable the following:
  • Data Protection and Recovery operation for the given clients.
  • Disable or enable the given MediaAgents in a CommCell.
X   X    

CommServe

CreateConsoleAlias This tool creates a web alias for CommServe. It is useful if a web alias  was not created during installation.

An alias can also be created by reinstalling CommCell Console or running a Report.

X X X    
PrePostCmdExample This is a sample batch file to show/list different backup level values that gets passed to the batch file and to show how to parse the command line parameters in a batch file.

Use this prototype to create the actual pre-post command batch file.

X X X    
QProfile This tool can be used to show the drive utilization or attempts failures per the given interval. X   X    

Database

CommcellClone This utility can be used to split a CommServe into multiple CommServes.

(See Splitting CommCells for more information.)

X   X    
CreateCSSQLAccount This tool creates a SQL account for connection to the CommServ  or CommNet database. It can be used to change the password for the SQL account or to create a new account used by the CommServe or CommNet to access the database.

(See install the CommServe and Database Engine on Separate Computers for more information.)

X   X    
DBUpgrade This utility can be used to upgrade the database engine to the current release. The utility automatically applies the release upgrade license.

This utility allows you to check the CommServe database to identify any known data inconsistencies that might affect the upgrade process. This utility (for release 6.1.0 or 7.0.0, depending on the CommServe version currently installed) is run on CommServe machine prior to the 8.0 upgrade. The utility generates a report file located at <software installation path>/Log Files/PreUpgradeCheckFor8_0_0.txt.

For more information, see Upgrade the CommServe.

X   X    

Exchange

CreateOFL This tool creates the Organizational Forms Library (OFL) used for publishing Outlook forms to Exchange 2007 Server for Exchange Mailbox/Public Folder Archiver Agents. See OFL Configuration for information on using this tool. X        
DMEPublishForm Used to publish Outlook forms to Exchange server for Exchange Mailbox/Public Folder Archiver Agents. See OFL Configuration for information on using this tool. X        
ExMBDMPredictor* This utility can be used to predict the amount of data that will be archived from an Exchange Server based on the specified archiving rules. X        
ExTool This tool queries information from the Exchange Server and is useful in diagnosing Exchange environment to isolate issues.

The settings in Exchange Server are not changed and all actions performed by the tool are logged in c:\extool.log.

X        
FindMailboxes This utility outputs Exchange Server, Backupset, subclient and the browse time to use for the cycle based on the input mailbox. X   X    
MoveMailboxes This utility moves the content from one subclient to another based on Key (SMTP address or name) from the input file. X X X    
OWAClientTool This utility copies stub icon information to the appropriate location on a Microsoft Exchange 2007 Client Access Role Server with OWA Proxy Enabler installed, in order to display stub icons and archived message details in OWA. This tool must be used each time the Exchange 2007 Server is upgraded.     X    
PSTDiscovery This tool allows you to scan a local hard drive for PST files and then copy them to a network share. PSTDiscovery is used in conjunction with the PSTDiscoveryGUI Tool for the purpose of archiving PST files. For more information, see Guidelines for Archiving PST Files. X   X    
PSTDiscoveryGui This tool provides an interface which allows you to manage PST files for archiving on the local Exchange Server. It resides in the PSTDiscovery directory and is run on the computer where the PST files were copied. It is used in conjunction with the PSTDiscovery Tool for the purpose of archiving PST files. For more information, see Guidelines for Archiving PST Files. X   X    
RegisterWSSForm This tool is used for registering forms on an Exchange 2003 Server in order to perform stub recalls using Outlook Web Access (OWA). X        

FileSystem DataArchiver

FileSystemDMPredictor* This tool can be used to predict how many files would be archived including their combined total size based on a specified archiving parameters for a specified volume or folder. X X X X  
FSDMRestubbing This tool is a hook into the restubbing feature of File Archiver for Windows. During a migration job, File Archiver for Windows will always try to restub -- moving stub files back from the stub cache -- instead of migrating a file again. However, if you do not want to run a migration but would still like files to be replaced with stubs in order to save space, this tool can be used to scan all volumes, look into the stub cache for each volume, and see if those files are candidates for restubbing. If so it will replace the file with the stub. X X X    
StubCopy This utility is used to copy or move a stub without forcing a recall for the File Archiver Agent. You can copy the local stubs to a remote NAS file server and then recall them when needed. X X X    

Lotus Notes

LNDMPredictor* This utility can be used to predict the amount of data that will be archived from an Domino Server based on the specified archiving rules. X        
LNDMStubIcon

 

This icon is used when configuring the Lotus Notes Mailbox master template to display a stub icon for each message archived by the Domino Mailbox Archiver Agent.

See Configure Stub Icons for Lotus Notes Mailboxes for more information.

X        

Media Management

CVDiskPerf8.0 This utility checks the disk performance for the given path. Copy the zip file to the MediaAgent where the test is to be performed and extract the contents to any folder other than the Galaxy\Base folder. X   X    
drivedumptool This utility is designed to be called directly from ##__DOC_PRODUCT_NAME__## services when a tape drive dump is to be created. Although designed to be called from ##__DOC_PRODUCT_NAME__##, this tool may be invoked directly to obtain a drive dump on user discretion.       X  
DRListMedia This utility generates a report with media required for restore for the cycle located at that date/time for all the storage policy copies in the input file. X   X    
MarkActiveMediaFull The tool will mark all active media full for the given Storage Policy and all streams of the Storage Policy copy. X   X    
MediaExplorer
(MediaEx for Netware, ME for Unix)
This tool can be used to restore data when the CommServe is unavailable.

See Disaster Recovery for more information.

X      X X
SetAllDrives This utility can be used to disable or enable all the drives for the MediaAgent. X X X    
SetCopyFlags This utility provides the ability to set copy flags [copy to same library] at storage policy copy level. X   X    
SetFlushBlockSize This utility provides an interface to the user to set the Tape block size for the given recording format. X   X    
SetLibraryAttributes This utility provides an interface to the user to set or unset library attributes without any communication with the CommServe subsystem. X   X    
SetMediaLocation This utility provides the ability to set the location and container for a given media. X   X    
SetRetentionTime Provides a command line method to adjust the basic retention rules for one or more or all storage policy copies. X X X    
SetSpareMediaErasable The tool will set all spare media erasable for the given scratch pool of the given library. X   X    
ShowMediaErrors This tool displays all media with number of software and hardware errors on them. Useful to identify bad tapes. X X X    
ShowMountSince This tool displays the mount history since a given day for all or specified drive/media/library/MediaAgent. X   X    
SIDB Simulator This tool is used to estimate the performance of the disk where you plan to create the Deduplication Store. X   X    

Miscellaneous

CommNetCommvault Provides the commnetadd utility to install the CommNet Browser on a  Macintosh or Unix platform.       X  
CVGACUtil This utility is used to register the DM2FastWebquery.dll when you uninstall one of the CommServes from any of the nodes in a cluster. Make sure that you register the DM2FastWebquery.dll only on the node where the CommServe was uninstalled.

For more information, see Uninstalling CommServe on Cluster Nodes.

X   X    
ScrubLogFiles This utility is intended to replace words in the log files with custom-defined words. The words to be replaced and their substitutes are defined in a simple text file called a dictionary file. The utility takes this dictionary file as input along with the input file specification and the output folder in which it is to place the modified files. For each file in the input file specification, it replaces the words defined in the dictionary file. X   X    
TestSendMail This utility is used to test the mail connection as used by the CommServe to send an alert mail. By default, the mail server and sender used are retrieved from the CommServe database. X   X    

Network and Foundation

CVIPInfo This is a diagnostic tool used to obtain information about the IP configuration in a computer. It can be used to verify the configuration of multiple network cards used by the software. X X X X X
CVNetworkTestTool This is a TCP/IP based tool to verify the network connectivity between the various CommCell components. It also enables you to troubleshoot network connectivity and data transmission between any two clients. It provides a single point interface to all basic network tests. X X X X  
DiskRead This utility can be used to validate backup speeds by measuring the following:
  • Performance of hard disk reads.
  • Measure the network read and write performance.
      X X
GxInstallMove By moving the Calypso configuration information (e.g., registry, software install folder, services, etc.) to a selected destination, this utility provides the ability to switch between two or more CommServe computers.       X

 

 
SMSUtilities This consists of the following tools:
  • SMSPROBE is an interactive tool to check each step of the process of finding, attaching and logging in to the TSA.
  • SMSREAD can be used to test the throughput of backup data without writing the data to the media.
  • SMSSCAN can be used to test the time taken to perform the scan phase of a backup. It can also be used to create a COLLECT file to be used by SMSREAD.
        X
TestPort This utility is a server-client TCP/IP utility to perform TCP/IP connectivity tests and to measure line throughput. X X X X X
Testshmem This utility will determine how much shared memory is available on the system for the software to use. If memory is insufficient, then applications may fail.        X  

SharePoint

CleanSPDA This tool cleans up two columns (i.e., Archived and CommVault Stub) that are created in Document and Picture Libraries during archive operations using SharePoint Archiver.

When SharePoint Archiver is uninstalled, these columns are not removed automatically. Use the CleanSPDA tool to remove these columns.

X   X    
SPDMPredictor* This utility is used to predict the number (and cumulative size) of documents which can be archived by SharePoint Archiver.

After scanning through the defined node and its children, the tool generates an output (both as a pop-up window and as an XML file) which specifies the details of the space saving that can be accomplished by SharePoint Archiver.

X   X    

Windows FileSystem

CVSpf This utility can be used to display the system protected files in Windows. X X X    
CVWmi This utility can be used to restore the WMI database after performing an ASR restore. X X X    
DiskRead This utility can be used to validate backup speeds by measuring the following:
  • Performance of hard disk reads.
  • Measure the network read and write performance.
X X X    
SetScanMode This utility sets the scan mode property for the backupsets . X X X    

Windows Install

Dot Net Framework Provides the Microsoft .NET Framework Redistributable Package to install .NET Framework runtime and associated files required to run applications developed to target the .NET Framework. X X X    
DumpGalaxyRegistry This utility displays the following registry tree in the console:

HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems

X X X X  
GxSCMCmd This utility checks the running status of Windows Services. This is needed during configuration of HP Scalable NAS/PolyServe Clusters. X X X    
InstallGalaxyWeb This utility can be used to performs all actions necessary to set up the web administration to perform the following functions:
  • Access the CommCell Console as a Remote Web-Based Application.
  • Access and generate reports remotely.
  • Access Books Online remotely.

This utility can be used to configure the web administration if it was not configured during the CommServe installation.

X X X    
Instsvc This utility can be used to uninstall, start, and stop windows services on a local computer. X X X    
LNDMAddin-ADMTemplate The LNDMAddin.adm custom administrative template file can be used to push registry key settings out to client computers to configure the Lotus Notes Client Add-In installation, using Active Directory Group Policy.

This administrative template file should be deployed in conjunction with the Lotus Notes Client Add-In installation package.

X        
Microsoft Visual C++ 2008 Redistributable Provides the Microsoft Visual C++ 2008 Redistributable Package to install runtime components of Visual C++ Libraries required to run applications developed with Visual C++ on a computer that does not have Visual C++ 2008 installed.  X X X    
MoveAfterReboot This utility can be used to mark files to move/delete after the next reboot. X X X    
OutlookAddin-ADMTemplate After completing a push installation for Outlook Add-In remote clients, load the CVOutlookAddin.adm template to customize Registry settings and override the installation default settings.

(See Push Installs - MSI Packages Using Active Directory Group Policies for more information.)

X   X    
PendingRenameKey This utility displays the list of files which are marked for Deletion/Rename after reboot based on the existence of the following registry key:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\PendingFileRenameOperations

X X X    
PreImageMode The PreImageModeFile.xml file can be used for Decoupled Installs; for more information, see Decoupled Install. X X X    
ShowEnv This tool displays the environment variables for the current user. X X X    

*The following package is required with this tool:


Disclaimer of Warranties

Bull provides software tools and utilities on an "as is" basis, as a courtesy and convenience to its users, and they may be changed from time to time without notice. These tools and utilities are provided without express, implied, or statutory warranties of any kind. You assume full risk and responsibility for the selection, possession, performance and proper installation and use of the software tools and utilities, and for verifying the results obtained therefrom. Your use of Bull software tools and utilities indicates your unconditional acceptance of the above disclaimer.