# commvault/cvpysdk architecture

> Architecture diagram of the GitHub repository commvault/cvpysdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/commvault/cvpysdk
- Repository: https://github.com/commvault/cvpysdk

## Overview

CVPySDK is a Python client library for administering Commvault through REST APIs. Its principal workflow starts with a CommCell connection, traverses clients, agents, instances, backupsets and subclients, then browses/searches backup content or starts backup and restore jobs; jobs expose lifecycle operations and status. Other visible product areas include plans and storage configuration, Activate, cloud discovery, monitoring, security, and disaster recovery. Edges follow README workflow statements and SOURCE INDEX references; several capability modules were not sampled, so their internal links are omitted.

Main entry points: [`cvpysdk/commcell.py`](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/commcell.py) (CommCell), [`cvpysdk/agent.py`](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/agent.py) (Agents), [`cvpysdk/client.py`](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/client.py) (Clients), [`cvpysdk/backupset.py`](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/backupset.py) (Backupsets)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_connection["Connection and API"]
  node_commcell["CommCell<br/>[commcell.py]"]
  node_rest["Commvault REST API"]
end

subgraph group_protection["Backup and Recovery"]
  node_client["Clients<br/>[client.py]"]
  node_agent["Agents<br/>[agent.py]"]
  node_instance["Instances<br/>[instance.py]"]
  node_backupset["Backupsets<br/>[backupset.py]"]
  node_subclient["Subclients<br/>[subclient.py]"]
  node_job["Jobs<br/>[job.py]"]
end

subgraph group_configuration["Protection Configuration"]
  node_storage_policy["Storage Policies"]
  node_storage_pool["Storage Pools<br/>[storage_pool.py]"]
  node_storage["Storage<br/>[storage.py]"]
  node_schedules["Schedules<br/>[schedules.py]"]
  node_plans["Plans<br/>[plan.py]"]
end

subgraph group_capabilities["CommCell Capabilities"]
  node_activate["Activate"]
  node_cloud_discovery["Cloud Discovery<br/>[cloud_discovery.py]"]
  node_monitoring["Threat Monitoring"]
  node_dr["DR Orchestration"]
  node_security["Security"]
end

node_operator(("SDK User"))

node_operator -->|"connects to"| node_commcell
node_commcell -->|"uses REST"| node_rest
node_operator -->|"lists or gets"| node_client
node_client -->|"gets agent"| node_agent
node_agent -->|"gets instance"| node_instance
node_agent -->|"gets backupset"| node_backupset
node_instance -->|"gets backupset"| node_backupset
node_backupset -->|"gets subclient"| node_subclient
node_subclient -->|"starts backup or restore"| node_job
node_operator -->|"manages lifecycle"| node_job
node_commcell -->|"exposes clients"| node_client
node_commcell -->|"exposes storage"| node_storage
node_commcell -->|"exposes discovery"| node_cloud_discovery
node_commcell -->|"exposes monitoring"| node_monitoring
node_commcell -->|"exposes Activate"| node_activate
node_storage_policy -->|"uses pool"| node_storage_pool
node_storage_pool -->|"uses storage"| node_storage
node_commcell -.->|"supports orchestration"| node_dr
node_commcell -.->|"supports security"| node_security
node_commcell -.->|"supports plans"| node_plans
node_commcell -.->|"supports schedules"| node_schedules

click node_commcell "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/commcell.py"
click node_client "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/client.py"
click node_agent "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/agent.py"
click node_instance "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/instance.py"
click node_backupset "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/backupset.py"
click node_subclient "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/subclient.py"
click node_job "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/job.py"
click node_storage_policy "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/policies/storage_policies.py"
click node_storage_pool "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/storage_pool.py"
click node_storage "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/storage.py"
click node_schedules "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/schedules.py"
click node_plans "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/plan.py"
click node_activate "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/activateapps/ediscovery_utils.py"
click node_cloud_discovery "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/clouddiscovery/cloud_discovery.py"
click node_monitoring "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/monitoringapps/threat_indicators.py"
click node_dr "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/drorchestration/drorchestrationoperations.py"
click node_security "https://github.com/commvault/cvpysdk/blob/master/cvpysdk/security/security_association.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_commcell,node_rest,node_operator toneBlue
class node_client,node_agent,node_instance,node_backupset,node_subclient,node_job toneAmber
class node_storage_policy,node_storage_pool,node_storage,node_schedules,node_plans toneMint
class node_activate,node_cloud_discovery,node_monitoring,node_dr,node_security toneRose
```

## Components

### Connection and API

- [CommCell](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/commcell.py): `cvpysdk/commcell.py`
- **Commvault REST API**

### Backup and Recovery

- [Clients](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/client.py): `cvpysdk/client.py`
- [Agents](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/agent.py): `cvpysdk/agent.py`
- [Instances](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/instance.py): `cvpysdk/instance.py`
- [Backupsets](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/backupset.py): `cvpysdk/backupset.py`
- [Subclients](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/subclient.py): `cvpysdk/subclient.py`
- [Jobs](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/job.py): `cvpysdk/job.py`

### Protection Configuration

- [Storage Policies](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/policies/storage_policies.py): `cvpysdk/policies/storage_policies.py`
- [Storage Pools](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/storage_pool.py): `cvpysdk/storage_pool.py`
- [Storage](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/storage.py): `cvpysdk/storage.py`
- [Schedules](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/schedules.py): `cvpysdk/schedules.py`
- [Plans](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/plan.py): `cvpysdk/plan.py`

### CommCell Capabilities

- [Activate](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/activateapps/ediscovery_utils.py): `cvpysdk/activateapps/ediscovery_utils.py`
- [Cloud Discovery](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/clouddiscovery/cloud_discovery.py): `cvpysdk/clouddiscovery/cloud_discovery.py`
- [Threat Monitoring](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/monitoringapps/threat_indicators.py): `cvpysdk/monitoringapps/threat_indicators.py`
- [DR Orchestration](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/drorchestration/drorchestrationoperations.py): `cvpysdk/drorchestration/drorchestrationoperations.py`
- [Security](https://github.com/commvault/cvpysdk/blob/master/cvpysdk/security/security_association.py): `cvpysdk/security/security_association.py`

### Other components

- **SDK User**

## Connections

- SDK User → CommCell: connects to
- CommCell → Commvault REST API: uses REST
- SDK User → Clients: lists or gets
- Clients → Agents: gets agent (evidence: `cvpysdk/agent.py`)
- Agents → Instances: gets instance (evidence: `cvpysdk/agent.py`)
- Agents → Backupsets: gets backupset (evidence: `cvpysdk/agent.py`)
- Instances → Backupsets: gets backupset
- Backupsets → Subclients: gets subclient (evidence: `cvpysdk/subclient.py`)
- Subclients → Jobs: starts backup or restore (evidence: `cvpysdk/subclient.py`)
- SDK User → Jobs: manages lifecycle
- CommCell → Clients: exposes clients (evidence: `cvpysdk/commcell.py`)
- CommCell → Storage: exposes storage (evidence: `cvpysdk/commcell.py`)
- CommCell → Cloud Discovery: exposes discovery (evidence: `cvpysdk/commcell.py`)
- CommCell → Threat Monitoring: exposes monitoring (evidence: `cvpysdk/commcell.py`)
- CommCell → Activate: exposes Activate (evidence: `cvpysdk/commcell.py`)
- Storage Policies → Storage Pools: uses pool (evidence: `cvpysdk/policies/storage_policies.py`)
- Storage Pools → Storage: uses storage (evidence: `cvpysdk/storage_pool.py`)
- CommCell → DR Orchestration: supports orchestration
- CommCell → Security: supports security (evidence: `cvpysdk/security/security_association.py`)
- CommCell → Plans: supports plans (evidence: `cvpysdk/commcell.py`)
- CommCell → Schedules: supports schedules (evidence: `cvpysdk/commcell.py`)
