Documentation
?

V10 Support Ended December 15, 2017

Loading...

CommCell Configuration Report

Table of Contents

About This Report

The CommCell Configuration Report Provides a high-level view of the settings that are configured for the CommCell, including properties, alerts, users/user groups, agents, index caches, storage policies, etc.

When to Use This Report

You can use the CommCell Configuration Report to review a wide range of CommCell contents, settings, and properties. This report is useful if you need to know:

  • The number of computers installed in the CommCell, information about CommCell users and user groups, and information about each MediaAgent and library
  • Client information such as enabled and disabled operations, defined operation rules, installed clients, and subclient contents and filters
  • Subclient policy information, including the number of streams for a subclient
  • Whether backup data has been configured for block level Deduplication and scheduled data protection information for each subclient
  • The types of licenses available in the CommCell, the installation date for each license type, and the expiration date of each license
  • Alerts that are configured in the CommCell
  • Index cache properties and content including the remaining index cache space, size of existing index cache, and disk size on each MediaAgent
  • All Update information from the registry of each machine in the CommCell and additional setting information added to the CommCell Console
  • All Updates which have been applied to a machine as well as the components to which they were applied
  • Update caches configured in the CommCell, including the CommServe update cache, and the configured secondary update caches
  • Each mailbox per subclient for common mailbox agents including the Exchange Mailbox and Archiver Agents
  • Whether the use of QSnap or VSS was selected through subclient properties
  • The account used for backup operations by SQL Server iDataAgents or Exchange iDataAgents that require an Exchange Administrator account
  • The job completion rate for the last 24 hours at the CommCell, MediaAgent, and Library levels
  • The name, operations and the properties of the Automated Content Classification Policy
  • Index cache details for each MediaAgent in the CommCell including the total amount of space available in the index cache location, and the amount of space used by index cache entries

What This Report Contains

This report presents the data in the following sections:

Sections Description
CommCell Properties This table provides information about the CommCell contents and settings. Information displayed in the table includes:
  • The name of the CommCell, OS, updates, upgrade history, and version number, amongst other data
  • All licenses assigned to the CommCell, the client that uses the license, and the installation and expiration dates for each license
  • Scheduled jobs, the job type, pattern, time zone, and next schedule time
  • All alerts, category and type of alert, and the user who created the alert
MediaAgent Properties This table provides information about the MediaAgent. Information displayed in the table includes:
  • The name of the MediaAgent, OS, version number, status, and associated User Groups
  • Name and location of the index cache
  • Details about the disk and tape libraries
Index Cache Properties This table provides information about the index cache. Information displayed in the table includes:
  • The name of the index cache
  • The amount of free space on the index cache volume
  • The amount of disk usage, and cache access path information
Index Cache Content This table provides information about the content of the index cache. Information displayed in the table includes:
  • The name of the client, the associated agent, and backup set
  • Cycle details including cycle number and job ID
Client Properties This table provides information about the clients in the CommCell. Information displayed in the table includes:
  • Client and client group names, OS, and version
  • Data protection and recovery settings
  • Associated security groups
  • A list of licenses for advanced features
Individual Agent Properties Each agent appears in its own table. Information displayed in the table includes:
  • Agent name, OS, and version
  • Data protection and recovery settings
  • Associated users and user groups
  • Operation window rules
Subclient Policy Properties This table provides information about each subclient in the CommCell.
Storage Policy Properties This table provides information about each storage policy that is configured in the CommCell. Information in the table includes:
  • The name of the storage policy, associated user groups and number of streams
  • Whether the policy is hidden, content indexing is enabled, and whether there is a deduplication or snap copy
Storage Policy Copy Properties This table provides information about the storage policy copies. Information in the table includes:
  • Storage policy name, copy name and type
  • Data retention settings
  • Data path location and settings
Deduplication Properties This table provides information about deduplication settings for each storage policy. Information in the table includes:
  • The name of the storage policy, the type of deduplication, and block size
  • Whether deduplication occurs on the client
  • Details about the deduplication database access path
  • Details about the silo archive
Deduplication Database Information This table provides information about the deduplication database. Information in the table includes:
  • The name of the storage policy, storage policy copy type, and name of the deduplication database
  • Last snap, recovery, and sealed times
  • Size of the application before deduplication, and its size after deduplication
  • Data retention settings
Users/User Groups This table provides information about the users and user groups in the CommCell. Information in the table includes:
  • Name of the user group and whether it is enabled
  • List of capabilities assigned to the user group
  • A list of users assigned to the user group and whether the users are enabled

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 Use the options on this tab to select criteria that is included in the CommCell Configuration Report, including compliance director and licensing details. You can include the following information in the report:
  • The complete configuration details of the CommCell
  • Alert types, alert configuration details, and user names configured to receive alerts
  • Data Interface Pairs configured for the CommCell
  • The designated CommServe Update Cache
  • Pre and Post processes configured for clients
  • Users created under the various user groups together with their rights and authentications
  • The type of Storage Policy, the user associated with it and the rights of the users
  • The types of jobs that run, their schedule, time zones they are set in, and their destination paths
  • The operations, namely Legal Hold, ERM and Tagging, that can be performed by using this policy
  • The general License information for the CommCell and license details like their expiration dates, installation dates, etc.
  • Collapsible view of additional client properties
  • Clients with Data Loss Prevention enabled, whether they are marked as stolen, and configuration details like secured content and filters
MediaAgent

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

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

You can also include drives.
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.
Subclient You can set the report to display information about subclients including the following:
  • Contents of the subclient
  • The subclient's copy retention settings
  • Subclient schedules
Storage Policy

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

You can also include this additional information:
  • List of all subclients
  • Media associated with each storage policy
  • List of hidden storage policies
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.