Skip to main content
Question

Commvault Cassandra Setup

  • June 29, 2026
  • 1 reply
  • 14 views

Forum|alt.badge.img

Commvault Cassandra Setup SOP (Detailed Guide)

Prerequisites

Before starting, ensure:

  • Root or sudo access to the Cassandra server.
  • Commvault installation package (Unix.tar).
  • CommServe hostname/IP.
  • Authorization (AuthCode) if required.
  • Cassandra service is healthy.
  • Java is installed.
  • Network connectivity between Cassandra server and CommServe.

Step 1: Switch to Root User

Login to the Cassandra server.

 
sudo su -

Verify:

 
whoami

Output should be

 
root

Step 2: Configure Hosts File

Edit hosts file.

 
vi /etc/hosts

Example:

171.12.12.12   test.co.in   test

Purpose

  • Name resolution
  • CommServe communication
  • Gateway communication

Save

 
:wq!

Step 3: Extract Installation Package

Move to installation directory.

 
cd /home/ubuntu

Extract package.

 
tar -xvf Unix.tar

Grant execute permissions.

 
chmod 777 Unix

Go inside package.

 
cd Unix

Verify contents.

 
ll

Step 4: Start Commvault Installation

Run installer.

 
./cvpkgadd

The text installer opens.

Step 5: Installation Wizard

Select

 
Install Packages on this machine

Click

 
Next

Then

 
Advanced Selection

Next.

Step 6: Select Packages

Choose

✔ File System Core

✔ File System

✔ Cassandra

Click Next.

These packages install

  • Base Commvault software
  • File System Agent
  • Cassandra iDataAgent

Step 7: Evaluation Mode

Installer asks

 
Install for evaluation?

Select

 
No

Continue.

Step 8: Installation Directory

Default

 
/opt/commvault

Usually no change required.

Click Next.

Step 9: Log Directory

Default

 
/var/log/commvault/Log_Files

Recommended to keep default.

Step 10: Network Backup Option

Installer asks

 
Configure network for backups?

Select

 
No

Step 11: Unix Group

Default group

 
commvault

Choose

 
No

unless customer requires a different group.

Step 12: Client Name

Provide hostname.

Example

 
cassandraee1.company.com

Click Next.

Display name can also be customized.

Step 13: Review Installation Summary

Review

  • Packages
  • Installation path
  • Log path

Click Next.

Step 14: CommServe Information

Enter

 
CommServe Hostname

Example

 
NDCPBKPPRX01

Click Next.

Step 15: Authorization Code

If prompted

Enter

 
Authorization Code

provided by the Commvault administrator.

Step 16: Finish Installation

Click

 
Finish

Step 17: Verify Installation

Run

 
commvault status

Verify

  • Version
  • Instance
  • CommServe
  • Installed packages
  • Client name

Step 18: Verify Cassandra Service

Check

 
systemctl status dse-native.service

Ensure

 
Active (running)

Step 19: Configure Priam

Move to

 
cd /etc/Priam

List files

 
ll

Open

 
vi cvPriam.properties

Configure properties.

Example

 
priam.cass.startscript=service dse-native start #edit service ex service cassandra start

priam.cass.stopscript=service dse-native stop #edit service ex service cassandra stop

priam.cass.process=dse

priam.commitlog.location=/var/lib/cassandra/commitlog

priam.data.location=/var/lib/cassandra/data

priam.cql.port=7200 #editport

priam.jmx.port=7199 #editport

priam.storage.port=7000 #editport

priam.ssl.storage.port=7002 #editport

priam.thrift.port=9160 #editport

Save.

 
:wq!

Step 20: Locate Cassandra Configuration

Find configuration.

 
find / -name cassandra.yaml 2>/dev/null

Example

 
/etc/dse/cassandra/cassandra.yaml

Navigate

 
cd /etc/dse/cassandra

Step 21: Enable Incremental Backups

Open

 
vi cassandra.yaml

Find

 
incremental_backups:

Default

 
false

Change

 
incremental_backups: true

Save

 
:wq!

This is mandatory for incremental backups because Cassandra stores SSTables incrementally only when this option is enabled.

Step 22: Create Cassandra Client in Commvault

Open

 
CommCell Console

Home

New Client

Big Data Apps

Cassandra

Provide

Field Example
Client Name cassandraee1
Instance Name CassandraEE
Gateway Node cassandraee1
Cassandra Config Path /etc/dse/cassandra
CQL Host cassandraee1.company.com
CQL Port 9042 (or customer-specific)

Step 23: Configure Authentication

Under Authentication Settings configure:

CQL Authentication

Provide

  • Credential Name
  • Username
  • Password

JMX Authentication

Provide

  • Credential Name
  • Username
  • Password

Keystore

Provide

  • Credential Name
  • Keystore path
  • Password

Used when SSL is enabled.

Truststore

Provide

  • Credential Name
  • Truststore path
  • Password

Step 24: Commit Log Backup (Optional)

Enable

 
Enable Commit Log Backup

Provide

Archive Log Path

Example

 
/var/lib/cassandra/commitlog

Archive Command

Example

 
cp %s /cv_archive/Cassandra/commitlog/

Commit log backup allows point-in-time recovery.

Step 25: Configure Storage Policy

Navigate

 
Big Data Apps

Cassandra

Default

Properties

Storage Device

Select

Storage Policy.

Click

OK

subclint path discovery

select cluster

Step 26: Perform Backup

Right-click

 
Default

Backup

Choose

 
Full Backup

or

 
Incremental Backup

Monitor the Job Controller until the job completes successfully.

Step 27: Restore Data

Navigate

 
Default

Browse and Restore

Select the required backup.

Choose

  • In-place restore
  • Out-of-place restore

Submit the restore job.

Step 28: Post-Restore Validation

After restore, verify:

 
nodetool status
 
systemctl status dse-native
 
cqlsh

Run

 
DESCRIBE KEYSPACES;

Check that:

  • Cassandra service is running.
  • All nodes are in the UN (Up/Normal) state.
  • Keyspaces and tables are accessible.
  • Read/write operations succeed.
  • Commvault restore job completed without errors.

1 reply

Forum|alt.badge.img

Commvault Cassandra Setup SOP (Detailed Guide)

Prerequisites

Before starting, ensure:

  • Root or sudo access to the Cassandra server.
  • Commvault installation package (Unix.tar).
  • CommServe hostname/IP.
  • Authorization (AuthCode) if required.
  • Cassandra service is healthy.
  • Java is installed.
  • Network connectivity between Cassandra server and CommServe.

Step 1: Switch to Root User

Login to the Cassandra server.

 
sudo su -

Verify:

 
whoami

Output should be

 
root

Step 2: Configure Hosts File

Edit hosts file.

 
vi /etc/hosts

Example:

171.12.12.12   test.co.in   test

Purpose

  • Name resolution
  • CommServe communication
  • Gateway communication

Save

 
:wq!

Step 3: Extract Installation Package

Move to installation directory.

 
cd /home/ubuntu

Extract package.

 
tar -xvf Unix.tar

Grant execute permissions.

 
chmod 777 Unix

Go inside package.

 
cd Unix

Verify contents.

 
ll

Step 4: Start Commvault Installation

Run installer.

 
./cvpkgadd

The text installer opens.

Step 5: Installation Wizard

Select

 
Install Packages on this machine

Click

 
Next

Then

 
Advanced Selection

Next.

Step 6: Select Packages

Choose

✔ File System Core

✔ File System

✔ Cassandra

Click Next.

These packages install

  • Base Commvault software
  • File System Agent
  • Cassandra iDataAgent

Step 7: Evaluation Mode

Installer asks

 
Install for evaluation?

Select

 
No

Continue.

Step 8: Installation Directory

Default

 
/opt/commvault

Usually no change required.

Click Next.

Step 9: Log Directory

Default

 
/var/log/commvault/Log_Files

Recommended to keep default.

Step 10: Network Backup Option

Installer asks

 
Configure network for backups?

Select

 
No

Step 11: Unix Group

Default group

 
commvault

Choose

 
No

unless customer requires a different group.

Step 12: Client Name

Provide hostname.

Example

 
cassandraee1.company.com

Click Next.

Display name can also be customized.

Step 13: Review Installation Summary

Review

  • Packages
  • Installation path
  • Log path

Click Next.

Step 14: CommServe Information

Enter

 
CommServe Hostname

Example

 
test

Click Next.

Step 15: Authorization Code

If prompted

Enter

 
Authorization Code

provided by the Commvault administrator.

Step 16: Finish Installation

Click

 
Finish

Step 17: Verify Installation

Run

 
commvault status

Verify

  • Version
  • Instance
  • CommServe
  • Installed packages
  • Client name

Step 18: Verify Cassandra Service

Check

 
systemctl status dse-native.service

Ensure

 
Active (running)

Step 19: Configure Priam

Move to

 
cd /etc/Priam

List files

 
ll

Open

 
vi cvPriam.properties

Configure properties.

Example

 
priam.cass.startscript=service dse-native start #edit service ex service cassandra start

priam.cass.stopscript=service dse-native stop #edit service ex service cassandra stop

priam.cass.process=dse

priam.commitlog.location=/var/lib/cassandra/commitlog

priam.data.location=/var/lib/cassandra/data

priam.cql.port=7200 #editport

priam.jmx.port=7199 #editport

priam.storage.port=7000 #editport

priam.ssl.storage.port=7002 #editport

priam.thrift.port=9160 #editport

Save.

 
:wq!

Step 20: Locate Cassandra Configuration

Find configuration.

 
find / -name cassandra.yaml 2>/dev/null

Example

 
/etc/dse/cassandra/cassandra.yaml

Navigate

 
cd /etc/dse/cassandra

Step 21: Enable Incremental Backups

Open

 
vi cassandra.yaml

Find

 
incremental_backups:

Default

 
false

Change

 
incremental_backups: true

Save

 
:wq!

This is mandatory for incremental backups because Cassandra stores SSTables incrementally only when this option is enabled.

Step 22: Create Cassandra Client in Commvault

Open

 
CommCell Console

Home

New Client

Big Data Apps

Cassandra

Provide

Field Example
Client Name cassandraee1
Instance Name CassandraEE
Gateway Node cassandraee1
Cassandra Config Path /etc/dse/cassandra
CQL Host cassandraee1.company.com
CQL Port 9042 (or customer-specific)

Step 23: Configure Authentication

Under Authentication Settings configure:

CQL Authentication

Provide

  • Credential Name
  • Username
  • Password

JMX Authentication

Provide

  • Credential Name
  • Username
  • Password

Keystore

Provide

  • Credential Name
  • Keystore path
  • Password

Used when SSL is enabled.

Truststore

Provide

  • Credential Name
  • Truststore path
  • Password

Step 24: Commit Log Backup (Optional)

Enable

 
Enable Commit Log Backup

Provide

Archive Log Path

Example

 
/var/lib/cassandra/commitlog

Archive Command

Example

 
cp %s /cv_archive/Cassandra/commitlog/

Commit log backup allows point-in-time recovery.

Step 25: Configure Storage Policy

Navigate

 
Big Data Apps

Cassandra

Default

Properties

Storage Device

Select

Storage Policy.

Click

OK

subclint path discovery

select cluster

Step 26: Perform Backup

Right-click

 
Default

Backup

Choose

 
Full Backup

or

 
Incremental Backup

Monitor the Job Controller until the job completes successfully.

Step 27: Restore Data

Navigate

 
Default

Browse and Restore

Select the required backup.

Choose

  • In-place restore
  • Out-of-place restore

Submit the restore job.

Step 28: Post-Restore Validation

After restore, verify:

 
nodetool status
 
systemctl status dse-native
 
cqlsh

Run

 
DESCRIBE KEYSPACES;

Check that:

  • Cassandra service is running.
  • All nodes are in the UN (Up/Normal) state.
  • Keyspaces and tables are accessible.
  • Read/write operations succeed.
  • Commvault restore job completed without errors.