The Python SDK includes common operations for entities. For detailed documentation on the available operations, review the documentation included in the Python SDK:
-
To view documentation for a module, from the Python command line, type the following command:
>>> from cvpysdk import module_name >>> help(module_name)
where module_name is the name of the module, for example, commcell. For a list of modules, see the following table.
-
To view documentation for a class, from the Python command line, type the following command:
>>> from cvpysdk.module_name import class_name >>> help(class_name)
where:
-
module_name is the name of the module, for example, usergroup. For a list of modules, see the following table.
-
class_name is the name of the class, for example, UserGroup. For a list of classes, see the following table.
-
The following table lists common modules and classes included in the Python SDK. For a complete listing, go to the Commvault Developer SDK - Python GitHub site.
Class |
Module |
Description |
Examples |
---|---|---|---|
Agent |
agent |
Performs operations for an agent associated with a client |
|
Agents |
agent |
Performs operations on all agents associated with a client |
|
Alert |
alert |
Performs operations on an alert |
|
Alerts |
alert |
Performs operations on all alerts |
|
ApiLibrary |
services |
Service URLs for REST API operations |
|
Backupset |
backupset |
Performs operations on a backup set |
|
Backupsets |
backupset |
Performs operations on all backup sets associated with an agent |
|
Client |
client |
Performs operations on a client |
|
Clients |
client |
Performs operations on all clients |
|
ClientGroup |
clientgroup |
Performs operations on a client computer group |
|
ClientGroups |
clientgroup |
Performs operations on all client computer groups |
|
Commcell |
commcell |
Initializes a connection to the CommCell environment and is the wrapper for all CommCell operations |
|
CVPySDK |
cvpysdk |
Logs on and off of the CommCell environment and runs the HTTP request |
|
DiskLibrary |
storage |
Performs operations on a disk library |
Read-only attributes:
|
DiskLibraries |
storage |
Performs operations on all disk libraries associated with the CommCell environment |
|
Instance |
instance |
Performs operations on an instance |
Read-only attributes:
|
Instances |
instance |
Performs operations on all instances |
|
Job |
job |
Performs operations on a job and reports the job status |
|
MediaAgent |
storage |
Performs operations on a MediaAgent |
Read-only attributes:
|
MediaAgents |
storage |
Performs operations on all MediaAgents associated with the CommCell environment |
|
Schedules |
schedules |
Performs operations on all schedules associated with the CommCell environment |
|
SchedulePolicies |
storage |
Performs operations on all schedule policies associated with an entity |
boolean_value = commcell.schedule_policies.has_policy(policy_name='FS_monthly') |
SDKException |
exception |
Handles all exceptions for the CVPySDK Python package |
|
StoragePolicies |
storage |
Performs operations on all storage policies associated with the CommCell environment |
|
Subclient |
subclient |
Performs operations on one subclient and performs operations on the subclient |
|
Subclients |
subclient |
Performs operations on all subclients associated with a backup set |
|
UserGroup |
usergroup |
Performs operations on one user group |
Read-only attributes:
|
UserGroups |
usergroup |
Performs operations on all user groups associated with the CommCell environment |
|
Workflow |
workflow |
Handles all workflows and runs workflow jobs. |
|