cvpysdk
CVPySDK (Developer SDK - Python) is a Python Package for Commvault Software.
CVPySDK uses Commvault REST API to perform operations on a Commcell.
CVPySDK is available on GitHub (https://github.com/CommvaultEngg/cvpysdk).
CVPySDK is compatible with both Python 2 and Python 3
CVPySDK requires the following Python packages to run:
- **requests**
- **future**
- **xmltodict**
And Commvault Software v11 SP7 or later release with WebConsole installed
Expand source code Browse git
# -*- coding: utf-8 -*-
# --------------------------------------------------------------------------
# Copyright Commvault Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# --------------------------------------------------------------------------
"""
CVPySDK (Developer SDK - Python) is a Python Package for Commvault Software.
CVPySDK uses Commvault REST API to perform operations on a Commcell.
CVPySDK is available on GitHub (https://github.com/CommvaultEngg/cvpysdk).
CVPySDK is compatible with both Python 2 and Python 3
CVPySDK requires the following Python packages to run:
- **requests**
- **future**
- **xmltodict**
And Commvault Software v11 SP7 or later release with WebConsole installed
"""
__author__ = 'Commvault Systems Inc.'
__version__ = '11.34'
Sub-modules
cvpysdk.activate
-
Main file for performing operations on Activate apps …
cvpysdk.activateapps
-
Initialize Activate Apps for the SDK.
cvpysdk.activitycontrol
-
Main file for performing activity control operations …
cvpysdk.agent
-
Main file for performing agent specific operations …
cvpysdk.agents
-
Initialize the Agents for the SDK.
cvpysdk.alert
-
Main file for performing alert operations …
cvpysdk.array_management
-
File for performing IntelliSnap and Array Management operations on Commcell via REST API …
cvpysdk.backup_network_pairs
-
Class to perform all the Backup Network Pairs operations on commcell …
cvpysdk.backupset
-
Main file for performing backup set operations …
cvpysdk.backupsets
-
Initialize Backupsets for the SDK.
cvpysdk.certificates
cvpysdk.client
-
File for performing client related operations on the Commcell …
cvpysdk.clientgroup
-
Main file for performing client group operations …
cvpysdk.clients
-
Initialize Clients for the SDK.
cvpysdk.commcell
-
Main file for performing operations on Commcell via REST API …
cvpysdk.commcell_migration
-
Class to perform all the CommCell Migration operations on commcell …
cvpysdk.constants
-
Helper file to maintain all the constants used in the SDK …
cvpysdk.content_analyzer
-
Main file for performing operations on content analyzers, and a single content analyzer client in the commcell …
cvpysdk.credential_manager
-
Main file for managing credentials records on this commcell …
cvpysdk.cvpysdk
-
Helper file for session operations …
cvpysdk.datacube
-
Initialize Datacube APIs, and Classes for the SDK.
cvpysdk.deduplication_engines
-
Main file for performing deduplication engine related operations on the commcell …
cvpysdk.deployment
-
Initialize Deployment for the SDK.
cvpysdk.dev_test_group
-
Main file for performing virtual lab restore operations on the Commcell …
cvpysdk.disasterrecovery
-
main file for performing disaster recovery operations on commcell …
cvpysdk.domains
-
File for performing domain related operations …
cvpysdk.download_center
-
File for doing operations on Download Center …
cvpysdk.drorchestration
-
Initialize Replication APIs, and Classes for the SDK.
cvpysdk.eventviewer
-
Main file for performing Event Viewer Operations …
cvpysdk.exception
-
File for handling all the exceptions for the CVPySDK python package …
cvpysdk.globalfilter
-
Main file for managing global filters for this commcell …
cvpysdk.hac_clusters
-
File for performing hac cluster related operations on the commcell …
cvpysdk.identity_management
-
Main file for performing identity management operations …
cvpysdk.index_pools
-
File for performing index pool related operations on the commcell …
cvpysdk.index_server
-
File for performing index server related operations on the commcell …
cvpysdk.instance
-
Main file for performing instance operations …
cvpysdk.instances
-
Initialize Instances for the SDK.
cvpysdk.internetoptions
-
File for setting internet options InternetOptions: class for setting Internet options in CommServe …
cvpysdk.job
-
Main file for performing operations on a job …
cvpysdk.key_management_server
-
Main file for performing Key Management Server operations on commcell …
cvpysdk.license
-
File for License operations …
cvpysdk.metallic
-
Main file for performing Metallic Integration steps with existing commcell …
cvpysdk.metricsreport
-
File for performing Metrics operations …
cvpysdk.monitoring
-
Main file for performing Monitoring related operations on the commcell …
cvpysdk.name_change
-
Main file for doing Name Change operations …
cvpysdk.network
-
Main file for performing network related operations on a client/client group …
cvpysdk.network_throttle
-
Main file for performing network throttle related operations on a client/client group …
cvpysdk.network_topology
-
Main file for performing network topology operations …
cvpysdk.operation_window
-
File for performing Operation Window related operations on given Commcell entity …
cvpysdk.organization
-
File for doing operations on an organization …
cvpysdk.plan
-
Main file for performing plan operations …
cvpysdk.policies
-
Initialize Policies APIs, and Classes for the SDK.
cvpysdk.policy
-
File for operating on all types of Policies associated with the Commcell …
cvpysdk.recovery_targets
-
Main file for performing Recovery Target specific operations …
cvpysdk.regions
-
File for associating Workload and Backup destination regions for various entites class: Regions. Region …
cvpysdk.reports
-
Initialize Reports for the SDK.
cvpysdk.schedules
-
Main file for performing schedule related operations for client/agent/backupset/subclient …
cvpysdk.security
-
Initialize Security Objects for the SDK.
cvpysdk.services
-
Service URLs for REST API operations …
cvpysdk.storage
-
Main file for performing storage related operations on the commcell …
cvpysdk.storage_pool
-
File for doing operations on an Storage Pools …
cvpysdk.subclient
-
Main file for performing subclient operations …
cvpysdk.subclients
-
Initialize Subclients for the SDK.
cvpysdk.system
-
Main file for performing system related operations on Commcell …
cvpysdk.virtualmachinepolicies
-
Main file for performing virtual machine policy related operations on the Commcell …
cvpysdk.workflow
-
File for performing Workflow related operations on Commcell …