> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecting Commvault to Neo

> Publish a client's Commvault web server, give Neo a user, and save it in Neo

You connect Commvault once for each client, with three values for that client's CommServe: the address of its web server (the one that serves Command Center), and the user name and password Neo signs in with.

## Before you start

* Neo calls the Commvault REST API that the web server publishes at `/commandcenter/api`, which every current Commvault release serves. An older web server that serves it at `/webconsole/api` works too: save that address.
* Neo reaches the web server over the internet. It must answer on **HTTPS** at a public address, with a certificate from a public certificate authority. A web server that only answers inside the client's network cannot be connected yet.

### Publish only the REST API

Put a reverse proxy at the network edge of the site that runs the web server. Set it to:

* answer on a public name over HTTPS, with a certificate from a public certificate authority;
* forward only paths under `/commandcenter/api/` to the web server, and refuse every other path;
* accept connections only from [Neo's addresses](https://docs.neoagent.io/integrations/ip-whitelisting.md);
* pass the `Authtoken` header through unchanged.

Save the proxy's public address in Neo.

## 1. Give Neo a user on the CommServe

**1. Create a user for Neo**

In Command Center, open **Manage → Security → Users** and add a user for Neo, such as `neo-api`, with a password of its own. An Active Directory user works too: Neo signs in as `DOMAIN\user`.

**2. Give it a role**

Associate the user with the servers, server groups or plans your agents work on, and give it a role that covers what they do: a role that can view jobs and alerts for agents that only read, and one that can also control jobs, change activity, install software or restore for agents that act.

**3. Leave two-factor authentication off for it**

Neo signs in with the password alone, so two-factor authentication must be off for this user.

Neo can do only what this user may do, whatever the agent's access profile says.

> [!WARNING]
>
> If the user's password changes, or the user is removed or locked, Neo loses access to this client's CommServe until you save the new password here.

## 2. Add the connection in Neo

**1. Open Integrations**

In the Neo Dashboard, open [**Integrations** → **Commvault**](https://dashboard.neoagent.io/integrations?open=commvault), under Backup & Recovery.

**2. Save the web server and the user**

In **Customer**, choose the client this CommServe belongs to; the client must be on your **Companies** tab, and **Add customer** adds the next one. Then enter the web server's address (for example `https://commvault.example.com`, the Command Center address from your browser, or the proxy's address), the user name and the password. Click **Save settings**. Neo signs in and reads the CommServe before saving, so a wrong address or a refused password is rejected straight away.

## 3. Turn it on per agent

Open the agent, go to its **Tools & Settings** tab, click **Backup & Recovery**, and expand the **Commvault** block. Pick one of its **Presets**, or set each area yourself:

| Area | Covers |
| - | - |
| **Jobs & Events** | Jobs, their failed items, details and history, and CommServe events; suspend, resume, kill and resubmit a job, and start a backup |
| **Alerts & Monitoring** | Triggered alerts and alert definitions; mark an alert read, pin it or add a note; syslog, SNMP and SIEM connectors |
| **Clients & Agents** | Servers, server groups, agents, subclients, hypervisors, VM groups and apps; add, retire or delete a server, and turn its backup, restore and data aging activity off or on |
| **Plans & Schedules** | Plans, their backup destinations and retention, schedules, blackout windows and operation rules |
| **Restores & Recovery** | Browsing backed-up data and restoring files, databases, virtual machines and Microsoft 365 items; failover, replication and recovery groups |
| **Storage & Media Agents** | Storage pools and their capacity, libraries and tape, media agents, storage policies, deduplication databases and storage arrays |
| **Workflows & Commands** | Workflows, running a workflow, webhooks and QCommands |
| **Data Insights & Compliance** | Data insights and eDiscovery projects, compliance searches and exports, cyber resilience and threat scans |
| **Users, Roles & Security** | Users and user groups, roles, access tokens, stored credentials, key management, encryption and sign-in settings |
| **CommCell, Companies & Reports** | The CommServe's settings, CommCell-wide activity, companies, licences, DR backups and reports |

| Preset | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Reads; suspending, resuming, killing and resubmitting jobs, starting backups, and working alerts | Changes to servers and their activity, a restore and a workflow. Every other area stays read only |
| **IT Admin** | Every read and most writes | A restore, a workflow, data insights, and users and security |
| **Full Automation** | Every read and write | Only the writes that always ask |

The writes that always ask, whatever the preset, are listed under Safety Controls on the [Commvault API](https://docs.neoagent.io/agents/tools/backup/commvault-api.md#safety-controls) page.

## Use it on job and alert tickets

Commvault emails an alert when a job fails or an anomaly is found, and most MSPs open a ticket from each one, such as `[Failed] Windows File System fs01` or `Alert: Commserv Anomaly Alert Type: Operation - Admin Alert`. An agent that triggers on those tickets finds the job, reads why it failed, resubmits it when the cause is gone, closes the ticket once a read shows the new job completed, and notes the ticket on the alert. It never resubmits on an anomaly alert, which it hands to a technician.

File each ticket under the client's company, so the agent calls that client's CommServe.

See [Commvault API](https://docs.neoagent.io/agents/tools/backup/commvault-api.md) for what the agent can read and change.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.