CommCell Readiness Report

About Example

Table of Contents

About this Report

When to use this Report

What this Report Contains

How to Generate the Report

Scheduling the Report

Customizations That You Can Perform With This Report

Additional Options

Troubleshooting Error Codes in the Report

License Requirement

Support Information

About this Report

The CommCell Readiness Report displays information about the condition of your CommCell and can serve as a tool to warn you about potential problems that might affect your operations before the problems occur. Note that this report also includes information for SRM Servers and SRM Agents.

When to use this Report

You can use the CommCell Readiness Report to review information about the overall status of the network and resources for the CommCell. This report is useful if you need to:

What this Report Contains

This report presents the data in the following sections:

Sections Description
Summary This table provides information about entities located within the CommCell. Information displayed in the table includes:
  • The types and total number of entities
  • The number of entities that are offline per type
Disk Library Space Requirements Summary This table provides information about the disk library space. Information displayed in the table includes:
  • Library name and mount path
  • The amount of space left in the disk library in GB
  • The amount of space reserved in the disk library in MB
Tape Library Space Requirements Summary This table provides information about the tape library space. Information displayed in the table includes:
  • Library and scratch pool name
  • Number of spare tapes and low watermarks
Client This table provides information about each client in the CommCell. Note that clients with Exchange DAG Server are not supported. Information displayed in the table includes:
  • Client and associated subclient names, the name of the assigned storage policy, and the copy type
  • Data Path Information including the names of the associated MediaAgent and Library, the assigned master drive pool and drive pool paths, and the MediaAgent interface and client interface
Media Agents This table provides information about each MediaAgent in the CommCell. Information displayed in the table includes:
  • MediaAgent and location of the index cache file
  • State of readiness for each MediaAgent and the failure reason if applicable
Replication set Readiness This table provides information about the replication set that is associated with the selected client. Information displayed in the table includes:
  • Name of replication set, source client, and destination client
  • State of readiness for each replication set and the reason for failure if applicable.

How to Generate the Report

1.

On the CommCell Console toolbar, click the Reports button.

The Report Selection dialog box appears.

2. From the Reports pane, select CommCell Readiness, and then click Run.

The report appears in your default Web browser.

Scheduling the Report

1.
  • From the CommCell Browser, click the Tools menu and click Reports.
  • In the Report Selection pane, click a report and click Schedule.
 

 

2.
  • Type a name in the Schedule Name box.
  • Select Daily.
  • Type the Start Time to start the schedule.
  • Click Ok.

Customizations That You Can Perform With This Report

You can further customize the report by using the tabs that are available in the Report Selection dialog box. The following table describes the available report options for this report.

Options Description
General On this tab, you can set the report to include information about the readiness of clients and MediaAgents in the CommCell. You must select at least one option from either the Clients or MediaAgents section in order to run the report. You can include the following information in the report:
  • Results of a network check on the selected clients in the report

  • Results of a check on the resources and capacity of the selected clients in the report
  • Status of the index cache for each MediaAgent in the report

  • Information for only those entities with a data path in Not Ready status or information for all selected entities in the report
  • Information for only enabled clients or information for all enabled and disabled clients. Disabled subclients always appear in the report if they exist under enabled clients.

Client

You can set the report to display information for all computers from the CommCell or select individual clients with the Modify option. You can set the report to include all agent types in the CommCell, or select individual agent types with the Modify option.

MediaAgent

You can set the report to display information for all MediaAgents in the CommCell, or select individual MediaAgents.

Output

You can set the report output to appear in one of several  formats and save it to a variety of locations. Set any of the following options:

  • Generate the report in HTML, Text separated by commas or tabs, or PDF.

    For the Text output, reports that consist of multiple tables contain each table in a separate text file. Therefore, the text output for one report might consist of multiple text files.

  • Enter a location to save the report in one of these locations:

    • On your local computer
    • On a shared network drive
    • An FTP location to which you can upload.

      When the text output consists of multiple files, they are compressed into a CAB file and sent as an attachment. Text output that consists of a single file is sent according to your settings.

  • Choose a language from the Choose Locale list to set the report to appear in that language.

Additional Options

The following table describes additional operations that you can perform with the reports feature:

Option Description Related topics
Saving the Report Output

You can save the report output to a specified location.

  1. On the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select the report that you want to generate.
  3. From the Output Format section, select a file format.
    • HTML
    • Text
    • PDF
  4. Select Output To, and then enter the location to which you want to save the report.
    • To save the report to your local computer, select Use Local Drive On, and then in the Report Copy Location box, enter a location.
    • To save the report to a shared network drive, select Use Network Share, and then in the Report Copy Location box, enter a location.
    • To upload the report to an FTP site, select FTP Upload, and then click Settings to enter the FTP location and your credentials.
  5. From the Choose Locale list, select the language in which you want the report to appear.
  6. At the bottom of the Report Selection dialog box, click Run.

    The report opens in the file format that you specified and a copy of the report is saved to the location that you entered.

 
Saving a Report as a Template

You can save the report settings as a template in the CommCell Console, and then run the report at any time.

  1. On the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select the report that you want to save.
  3. At the bottom of the Report Selection dialog box, click Save As.

    The Save As dialog box appears.

  4. Select Save a Report, and then enter a name for the report template in the box.
  5. Click OK.

    The report template appears under Reports > My Reports on the General tab.

 
Generating a Report from a Template

You can generate a report from a template at any time.

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to generate, and then select Run Immediately.

    The report opens in the format that is specified in the template.

 
Modifying a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to change, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Report Details tab, and then make changes on any of the available tabs.
  4. Click OK to save your settings.
 
Cloning a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to clone, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then select Saved Report.
  4. Select Clone this report as, and then enter a name in the box.
  5. Click OK.

    The cloned report appears in the General tab.

 
Deleting a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to delete, and then select Delete.

    A message appears that asks if you are sure that you want to delete the selected Report Template.

  3. Click Yes.

    The report is removed from the General tab.

 
Setting a Report Alert This option allows users or user groups to get an automatic notification when a report is created. If the report output consists of multiple text files, they are compressed into a CAB file and sent as an attachment. Text output that consists of a single file is sent according to your settings.

Follow the steps given below to set up the criteria to raise notifications/alerts:

  1. From the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select a report, and then click Schedule.

    The Schedule Details dialog box appears.

  3. Select the Notification tab, and then click Add Alert.
  4. From the Add Alert Wizard dialog box, select the types of notifications that you want to send, and then click Next.
  5. Add recipients to the selected list.
    • To add a recipient that is a user in the CommCell, from the Available list, select a user, and then click Add.
    • To add a recipient that is not a user in the CommCell, in the Email to Recipients box, enter an e-mail address.
  6. Click Next, and then click Finish.
  7. Click OK to save your settings.
Refer to Alerts.
Saving a Report as a Script

The Command Line Interface allows you to generate reports from the command line. The commands can be executed from the command line or can be integrated into scripts. You can generate command line scripts for specific operations in the CommCell Console by using the Save As Script option.

To create an XML script that generates a report:

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to save as a script, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then click Save As Script

    The Save As Script dialog box appears.

  4. Enter the appropriate settings to generate a script file.
    1. From the Client list, select the name of the client where you want to save the script.
    2. In the Path box, enter the file path where you want to save the script, and then enter a name for the script file at the end of the path.

      Ensure that the name of the file contains the .xml extension

    3. Click OK to create the script.

      A message appears that says that the script saved successfully

    4. Click OK.

    The Save As Script and the Saved Reports dialog boxes close.

Refer to Command Line Interface.

Troubleshooting Error Codes in the Report

The following error codes are included in the report. The following table lists the recommended actions if these error codes are received:

Error Code Action to be Taken
Ready. No action is required.
Source could not start the command. Check the network settings on the source computer.
Destination could not start the command. Check the network settings on the destination computer.
CommServe could not resolve the client name. Check the DNS settings for the client computer and make sure that you can ping the client from the CommServe.
Source could not resolve the destination. Check the connectivity between the source and destination computers in this message and make sure that you can pick these computers from one another.
Destination could not resolve the source. Check the connectivity between the source and destination computers in this message and make sure that you can pick these computers from one another.
Services on destination are down. Make sure that the necessary services are up and running on the destination client computer.
Services on source are down. Make sure that the necessary services are up and running on the source client computer.
Connect failed. Check the connectivity between the source and destination computers in this message and make sure that you can ping these computers from one another.
Connect timed out. Check the connectivity between the source and destination computers in this message and make sure that you can ping these computers from one another.
JobResult Folder has low capacity. Increase capacity or change value of nJOBRESULTS_MIN registry key.
Base Folder has low capacity. Increase capacity or change value of nGALAXY_MIN registry key.
Temp Folder has low capacity. Increase capacity or change value of nGALAXYTEMP_MIN registry key.
iDataAgent Folder has low capacity. Increase capacity or change value of nIDA_MIN registry key.
Authentication failed. Make sure that the client password in the Database matches with one another in the client registry.
Firewall connect failed. Source client <n> is not listed in the firewall config file. Make sure that the firewall config file is correct and check if this client is listed in the file.
Internal error occurred. Please retry the operation. An internal error has occurred. Please try this operation. If this continues to happen, contact your software provider.
MediaAgent <n> is offline. Make sure that the necessary services are running, the MediaAgent is enabled, and the MediaAgent is reachable from both the CommServe and the clients.
Library <n> is offline. Make sure that the library is turned on, is enabled, and the hardware is functioning properly.
Library Controller for the library <n> is offline. Make sure that the library controller MediaAgent is up and running.
Drive pool <n> is offline Make sure that the drive pool is enabled and all the drives in this drive pool are functional.
Stand alone media for the library is not ready. Make sure that the media that is loaded into the standalone library is the correct media for the data protection operation that is scheduled for the evening.
Media capacity is low or the mount path is below the watermark. Make sure that there is enough spare media in the library or the mount path has enough free space for the data protection operation that is scheduled for the evening.

License Requirement

This report requires the CommCell Readiness Check license.

Support Information

The CommCell Readiness report is not supported for clients that are installed with: