How commvault/cvpysdk works
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: commcell.py CommCell · agent.py Agents · client.py Clients · backupset.py Backupsets
Components 19
Connection and API
- CommCell
cvpysdk/commcell.py - Commvault REST API
Backup and Recovery
- Clients
cvpysdk/client.py - Agents
cvpysdk/agent.py - Instances
cvpysdk/instance.py - Backupsets
cvpysdk/backupset.py - Subclients
cvpysdk/subclient.py - Jobs
cvpysdk/job.py
Protection Configuration
- Storage Policies
cvpysdk/policies/storage_policies.py - Storage Pools
cvpysdk/storage_pool.py - Storage
cvpysdk/storage.py - Schedules
cvpysdk/schedules.py - Plans
cvpysdk/plan.py
CommCell Capabilities
- Activate
cvpysdk/activateapps/ediscovery_utils.py - Cloud Discovery
cvpysdk/clouddiscovery/cloud_discovery.py - Threat Monitoring
cvpysdk/monitoringapps/threat_indicators.py - DR Orchestration
cvpysdk/drorchestration/drorchestrationoperations.py - Security
cvpysdk/security/security_association.py
Other components
- SDK User
Connections 21
- SDK User → CommCell: connects to
- CommCell → Commvault REST API: uses REST
- SDK User → Clients: lists or gets
- Clients → Agents: gets agent
cvpysdk/agent.py - Agents → Instances: gets instance
cvpysdk/agent.py - Agents → Backupsets: gets backupset
cvpysdk/agent.py - Instances → Backupsets: gets backupset
- Backupsets → Subclients: gets subclient
cvpysdk/subclient.py - Subclients → Jobs: starts backup or restore
cvpysdk/subclient.py - SDK User → Jobs: manages lifecycle
- CommCell → Clients: exposes clients
cvpysdk/commcell.py - CommCell → Storage: exposes storage
cvpysdk/commcell.py - CommCell → Cloud Discovery: exposes discovery
cvpysdk/commcell.py - CommCell → Threat Monitoring: exposes monitoring
cvpysdk/commcell.py - CommCell → Activate: exposes Activate
cvpysdk/commcell.py - Storage Policies → Storage Pools: uses pool
cvpysdk/policies/storage_policies.py - Storage Pools → Storage: uses storage
cvpysdk/storage_pool.py - CommCell → DR Orchestration: supports orchestration
- CommCell → Security: supports security
cvpysdk/security/security_association.py - CommCell → Plans: supports plans
cvpysdk/commcell.py - CommCell → Schedules: supports schedules
cvpysdk/commcell.py