Predefined Workflows

Updated

The Commvault software includes some predefined workflows. More workflows are available in the Commvault Store. The workflows in the Commvault Store include a readme that explains the workflow.

Predefined workflow

Description

Active Directory Forest Workflow

Automates the restore of Domain Controllers and other system state data in-place to your client computer.

Add MediaAgent to an Existing Global Deduplication Storage Policy

Adds a UNIX MediaAgent library to an existing global deduplication storage policy setup

Check Readiness

Checks the connectivity of all the client computers within a client group. Verifies whether all the clients in a client group are online and ready to perform a CommCell operation.

This workflow uses the qoperation checkready command to perform the connectivity check, and then sends a summary of the client connectivity results to the administrator in an email.

Client Certificate Administration

Manages client certificates and licenses for client computers in your CommCell environment.

You can use this workflow to perform the following operations:

  • Create placeholders for new clients (this operation is also called as creating dummy clients or preconfiguring client computers).

  • Create, revoke, or renew certificates for specific client computers.

  • Delete deconfigured client computers (which are unlicensed clients that are retired from your CommCell environment).

  • Release the license from specific client computers (also called deconfiguring clients that you plan to retire from your CommCell environment).

Client Group Policy

Changes the storage policy of all default file system subclients that belong to a specific client computer group. You can manually execute this workflow.

For example, you have a client group with file system and database subclients using a non-deduplication storage policy. Deduplication-based storage policies are recommended for file system subclients. Therefore, you can use this workflow to change the storage policy of all file system subclients to use a deduplication policy.

Collaborative Shares

Allows end users to create a collaborative share.

CommCell Client Migration by Storage Policy

Automates the migration of clients based on the storage policies they are associated with

CommCell Migration from v9-v10

Migrates a CommCell environment from Commvault v9 or v10 to Commvault v11.

CommServe Database Long-Term Archiving:

Frees up space in the database by moving the metadata of old backup jobs in selected clients to a different CommCell based on specified criteria. The workflow exports the metadata from the source CommCell environment, and then imports the metadata to the destination CommCell environment. For more information, see Archiving the Older Jobs in a CommCell Environment.

CommServe Port Forwarding Gateway Configuration:

Inserts or deletes port forwarding gateways on the production CommServe server, in order to ensure proper configurations.

Configure Third-Party Connections:

Routes third-party traffic (between two clients) through a specific set of network ports.

Content Index All Subclients

Content indexes the subclient data on all Edge Drive and <ObjectStore> clients.

Administrators can execute this workflow.

Create Mount Path Label Files:

If a label file does not exist, this workflow creates the label file in specific mount paths of a library or in all mount paths associated with a MediaAgent.

Create VM

Executes a command or a process, such as installing software after a user creates a virtual machine on the Web Console. For example, you can configure the workflow to automatically add a new virtual machine to an external domain after the virtual machine is created.

DBMaintenance

Performs CommServe database maintenance using the DBMaintenance utility.

DDB Seeding

Transfers the initial baseline backup between two sites using a removable disk drive.

Disable the Expired Users

Disables user accounts that have an expired password.

Enable Edge Drive and Shares of Deleted AD User

Accesses the Edge Drive and Shares of a deleted Active Directory (AD) user.

Execute Process On Group

Executes a command or a process on each client computer that belongs to a specific client group.

You can use the ExecuteProcessOnGroup workflow for multiple purposes. For example, if you have a client group that consists of SQL Server clients that need an important update or configuration, you can use this workflow to push a command to all these clients instead of performing the operation individually on each client.

File System Backup Restore

Performs backup and restore operations on a client.

To continuously protect your data, you can automate the workflow to do the following:

  • Schedule the workflow to run at specific times

  • Call out the workflow (as an XML file) in your automation scripts

Hardware Refresh

Moves an existing CommServe database to new hardware.

Install Automatically Discovered Applications

Installs the packages and registers the clients that automatically detected applications.

Install Windows Updates

Downloads and installs Microsoft updates on client computers that run Windows operating systems (including the CommServe client). You can also use the workflow to download and install Microsoft SQL Server updates.

Invite for Commvault Edge

Sends email invitations when you share data to an email address that is available in the CommServe database.

Laptop Registration:

Customizes what actions to perform after a client is installed. For example, in addition to verifying the new client, you can add an activity to assign a specific storage policy.

Load Balance Index Servers:

Redistributes loads across all Indexing Version 2 index servers in a CommCell environment in order to achieve optimal distribution of indexes across available disk space.

Name Change ODBC

Updates the CommServe host name in ODBC settings. You must execute this workflow after creating a floating host name in a Disaster Recovery Setup.

New Machine Request

Demonstrates the usage of interactive sessions.

The end user (requester) enters the machine name and configuration details from the Web Console and initiates the workflow. The workflow checks the machine name for special characters. If special characters are found, the end user is prompted to correct the machine name before proceeding. Once the request is submitted, the workflow job waits for the approver to verify and approve or decline the request before completing the job.

Modify Client Encryption Settings

Modifies the encryption settings of one or more clients.

Modify Encryption Settings for All Clients

Modifies the encryption settings of all clients

Modify Storage Policy Copy Encryption Settings

Modifies the encryption settings of a storage policy copy.

Modify Storage Pool Encryption Settings

Modifies the encryption settings of a storage pool.

Move Clients to New DDB

When you enable the horizontal scaling of deduplication databases (DDB), you can use this workflow to move the subclients of a client from the previous full DDB to the new DDB created for their data type.

Network Performance Test Tool:

Uses the CvNetworkTestTool GUI workflow to check the bandwidth between client CommCell entities to troubleshoot performance issues

Prefetch Tapes for Restore

Prefetches the exported virtual tapes that are associated with the jobs that have to be restored.

Pre-Install Business Logic

Appends the organization name, client owner, and/or a custom string to the client name, host name, and display name of client when a client is registered. This workflow is automatically executed after a user installs the Commvault software on a new client.

Proactive Support

Allows you to fix common configuration issues.

RDS Migration:

Migrates an Oracle database, schemas, or tablespaces to an Amazon RDS database

Refresh CommServe Database Access Key

Generates the password for the Microsoft SQL Server Commvault instance for the CommServe server. This workflow updates the new password in an encrypted format in the CommServe registry and in the Workflow Engine and Web Server registries when they are installed remotely.

Restore Files Based on File Size and File Count

Allows you to restore a few random files based on file size and file count.

SAP MaxDB

Performs a backup for SAP MaxDB

Server Retirement:

Retires clients from your CommCell environment and sends email notifications to users.

ServiceNow Create Incident:

Automatically executes to send the summary of the restore operation failure to the CommCell administrator.

Set Global Property:

Allows you to execute a SQL script that will modify a specific property on all the CommCell environments that are registered with the CommCell environment where the workflow is executed. This operation performs a modification to the CommServe database of the respective CommCell.

Set Global Filters on CommCells

Applies the Windows and Unix global filters that are set on the master CommCell environment to all registered CommCell environments.

Upgrade to Indexing V2

Upgrades clients to the most recent version of indexing.

Uninstall Third-Party Software:

Uninstalls third-party software from all Windows clients in your CommCell environment.