Documentation
?

V10 Support Ended December 15, 2017

Loading...

CommCell Readiness Report

Table of Contents

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.

Connectivity Checks

This report allows you to check if connectivity and communication problems exist between your CommServe, MediaAgents, and clients.

The following network communication checks are performed:

  • Client to CommServe
  • CommServe to Client
  • Client to MediaAgent
  • MediaAgent to Client

The following resource checks are performed:

  • MediaAgent status, whether online or offline
  • Library, mount path status, whether online or offline
  • Library Controller status, whether online or offline
  • Drive pool, Master pool, Standalone media status
  • Mount path space check, or watermark space check
  • Backup space size check
  • NDMP filer resource check for NAS Subclients

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:

  • Check whether data interface pairs are configured.
  • Check connectivity between Continuous Data Replicator pairs. This is reported in a separate table.
  • Verify that library controllers, libraries, master drive pools, drive pools, and drives are online.
  • Verify the existence of the index cache location and to check the index cache label's contents against the selected MediaAgent's index cache.
  • Review the results of a space check that monitors consumed space and free space remaining for components that are essential to the operation of the software.
  • Check for the readiness of the data paths on all copy types, such as primary, secondary, and synchronous.

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
MediaAgents 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

You can generate the default version of any CommCell Report on demand in the CommCell Console.

  1. On the CommCell Console ribbon, select the Reports tab, and then click the button for the report that you want to run.

    Some report buttons appear under Other Reports.

  2. In the Report Selection dialog box, click Run.

    The report appears in your default Web browser.

Scheduling the Report

  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to schedule.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  3. In the Report Selection dialog box, click Schedule.
  4. On the Schedule Pattern tab, in the Schedule Name box, enter a name for the schedule.
  5. Select the interval at which you want the report to run: One Time, Daily, Weekly, Monthly, or Yearly.
  6. In the Start Time box, type the time of day when you want the report generation to begin.
  7. Under Repeat, specify the exact times and days that you want the report to run.
  8. 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.

  • 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.

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

  • Select Date and Time, and then select a format from the list to set the format in which the date and time appears in the report

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. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to save.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  3. Select the Output tab, and then from the Output Format section, select a file format.
  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. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to make into a template.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  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 template in the box.
  5. Click OK.

    The report template appears in the CommCell Browser under Reports > My Reports.

  
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. In the CommCell Browser, go to Reports | My Reports | 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. In the CommCell Browser, go to Reports | My Reports | 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. In the CommCell Browser, go to Reports | My Reports | 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. Follow the steps given below to set up the criteria to raise notifications/alerts:
  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to set alerts for.

    The Report Selection dialog box appears.

  2. Configure the report as needed
  3. At the bottom of the Report Selection dialog box, click Schedule.

    The Schedule Details dialog box appears.

  4. Configure the schedule as needed.
  5. Select the Notification tab, and then click Add Alert.
  6. From the Add Alert Wizard dialog box, select the types of notifications that you want to send, and then click Next.
  7. 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, type an e-mail address.
  8. Click Next, and then click Finish.
  9. Click OK.
 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.