Skip to main content

Developer Tools, Integration and Automation

Discuss REST APIs, Workflows, PowerShell, scripting, customization, and more!

  • 476 Topics
  • 2,062 Replies
476 Topics
V
VincentWong
asked in Developer Tools, Integration and Automation
Anyone know how to use the API download function?

I created a subclient in my file server and backed up a file (C:\test\test.txt). I then attempted to use API to download the backed up file but the server always returned 404. Anyone knows how to use the API?The request i made is like this:https://api.metallic.io/stream/action/download?appid=<subclientid>&path=C%3a%5ctest%5ctest.txt Thank you in advance.

0
V
9 hours ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Subclient not updating the vmFilters via API

I am using below api endpoint and updating the filters of the subclient:https://api.commvault.com/docs/SP32/api/cv/SubclientOperations/update-subclient-properties/       "vmFilter": {        "children": [          {            "allOrAnyChildren": true,            "description": "",            "displayName": "Ans_Jen_serv1",            "equalsOrNotEquals": true,            "name": "553b108a-dbc8-b7cv-e69n-e35622f6gh70",            "path": "Ans_Jen_Saurabh",            "type": 9          },          {            "allOrAnyChildren": true,            "description": "",            "displayName": "Ans_Jen_serv2",            "equalsOrNotEquals": true,            "name": "503df9ca-c7ca-e09b-333d-fc0787a5c9d0",            "path": "Ans_Jenkins_Vishak",            "type": 9          }        ]      }, I have updated the payload with the vmFilter children in which I have updated the content and remove Ans_Jen_Serv1. It did get updated successfully. Below is the updated payload when I printed:"{\"c

2
R
Byte
17 days ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Need an API endpoint to remove backupsets, clients and vmdk from filters

I need an API endpoint to remove backupsets, clients and vmdk from filters of the subclient.Commvault version 11.32.43 

1
A
Vaulter
19 days ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
retention datetime fetched via API and on GUI is different

I have pulled the retention details of the VM client via api. It is in unix epoch time so I had to convert it to human readable format. The datetime on commvault GUI and API is different.Below information is fetched via API:Unix epoch time: 1728697951Retained until: 2024-10-12 01:52:31Below is from the GUI  

1
B
Vaulter
22 days ago
J
Bit
JaeDubbyaBit
posted in Developer Tools, Integration and Automation
When using Sensitive Data Governance, is it possible to write the data classification into the file details?

We have a requirement from our data governance team to add the data classification into the actual details of the file once we have setup Classification Plans within Sensitive Data Governance, ideally the tag attribute within the file details. Does anyone know if this is possible and how you would do it?

0
J
Bit
24 days ago
E
Byte
evgenichByte
asked in Developer Tools, Integration and Automation
Prevent Synthetic Full Backups

Hi,Need for 1 day prevent synthetic full backups to startChanging it in all schedules seems a little bit not best practiceAny way to disable it globally and turn it back again?

3
Aplynx
Vaulter
24 days ago
J
Byte
Jass GillByte
asked in Developer Tools, Integration and Automation
What operations of Commvault leverage what all S3 APIs

Hi,We would like to hit max APIs on our S3 compatible object storage and we are wondering what all operations via Commvault we can perform to do so.For eg: Backup , restore does hit the s3 PUT and GETs respectively along with HEADs.We would like to perform some regression tests via Commvault.Any recommendations on how to approach this? If via some tool or some other actions? 

3
A
Vaulter
28 days ago
S
shubham2211
posted in Developer Tools, Integration and Automation
End user Laptop Package deployment on version 11.34

Hi,I want to deploy the end user laptop package to all the computers in the network without end user interaction. The documentation suggests method of using CommCell Console but I am on version 11.34 and commcell console doesnot work for this version. Is there a way to deploy it using command center

0
S
28 days ago
A
Byte
Alexey TesovByte
asked in Developer Tools, Integration and Automation
Removing client from subclient (not working) and commands execution log

Hello,I am trying to remove a client from subclient (PowerShell), and it works in most of cases, however I came across with a strange case when automation just does not work, for no reason (the target client stays in the subclient)I tried to use both methods I know:Remove-CVVirtualMachine and qoperation executeboth with “error code: 0” on exit 😐Also, I would deeply appreciate if anyone share the info under witch module in “process manager > logging” commands execution log can be found

2
A
Byte
29 days ago
Onno van den Berg
Commvault Certified Expert
Onno van den BergCommvault Certified Expert
asked in Developer Tools, Integration and Automation
REST API leaking too much information related to authentication

I was busy writing some code last week and while I was coding the authentication part I noticed the following. When you perform an authentication attempt against the API you will get output information back which contains information that can be used to perform a brute-force attack.Return information after an invalid authentication attempt:Now in case you use a valid username than you will see the Loginattempts incrementing:This means you found a valid account, so let's push forward until it the account is locked!So the API is also giving back the time you have to wait until you can try it again. Exposing this kind of information makes it easier for people with bad intentions to perform brute-force attacks. Sure companies nowadays should embrace/use MFA, but when you want to automate certain actions, for example through a CI/CD pipeline, than the MFA becomes a blocker so you'll have to diverge back. I think it's time to come-up with something better that can be used for automation task

11
Onno van den Berg
Commvault Certified Expert
1 month ago
B
Bassam2014
asked in Developer Tools, Integration and Automation
Clone the workflow "RestoreRequestAuthorization"

I deployed the workflow "RestoreRequestAuthorization" and configured it for some client groups and a user group to be the approvers. All worked good.Now I want to configure another workflow to be able to configure another user group to approve requests for another client group(s) as my customer has different teams for different backup agents.When I deployed the cloned workflow I received an error message saying “message already configured for business logic workflow”. I found the conflicting message and gave it another name and was able to deploy the cloned workflow successfully.When I configured the cloned workflow with other client groups it didn’t work and the restore jobs didn’t trigger any requests for approvals!Wondering if anyone went through similar issue before?Thanks in advance!

1
R
Vaulter
1 month ago
C
Bit
Commvaulter2024Bit
asked in Developer Tools, Integration and Automation
anyone using cvpysdk ? I am unable to connect to commserve, although I can ping commserve just fine

  >>> from cvpysdk.commcell import Commcell>>> commcell = Commcell('commserve', 'admin')Traceback (most recent call last):  File "<stdin>", line 1, in <module>  File "/System/Volumes/Data/apps/cv/lib/python3.12/site-packages/cvpysdk/commcell.py", line 570, in __init__    raise SDKException('Commcell', '101')cvpysdk.exception.SDKException: Commcell is not reachable. Please check the commcell name and services again>>>

4
C
Bit
1 month ago
roc_tor
Byte
roc_torByte
asked in Developer Tools, Integration and Automation
Comprehensive Subclient Report?

So.. we have times when one of our customers would like to see a comprehensive display of what is being done and when on their servers, without the “lingo” thrown in.  Specifically, we’d love to see something like:ClientHostname Subclient What is backed up (in some form.. VM, FileSystem - what folders ) Where it’s backed up (from storage policy information) The schedule for when it’s backed up (from schedule policies) All backup jobs, including in the storage policy copies #1.1.1 will likely be a repeated column header with 1.1.2,3,4 repeated for each subclient.  Is there such a thing existing?  I’ve searched near and far but found nothing.  Also.. is there a data dictionary that can help with finding information with the datasets?  Or even reporting straight from SQL Server?  Finding the information in Management Studio seems tough.  I’ve actually copied it to SQL Server Express just to play with it w/o blowing up my whole installation. Thank you for any help!

2
roc_tor
Byte
1 month ago
A
Bit
adam.tomzaBit
asked in Developer Tools, Integration and Automation
switching backup policies through API and running full backup

My colleague is using Commvault API in python to automate restores We would like to know how can we use the API to switch off one backup policy and to enable new or another one? And how to run a full backup after switching over backup policy?Alternatively how in a given policy delete and add a new instance for backups?Unfortunately, the following documentation is not detailed enough to achieve that? https://api.commvault.com/docs/SP32/api/cv/ScheduleandSchedulePolicyOperations/add-agent-to-schedule-policy/Thank you,

2
A
Bit
1 month ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
API to extend the job retention by given number of days

I need to extend job retention by the given number of days which will be user input. Is there a particular API to handle this ?

1
christopherlecky
Byte
1 month ago
R
Byte
rasByte
asked in Developer Tools, Integration and Automation
cvpysdk - lists all backup jobs history from specific client

Can someone knows on how to lists all the subclient backup jobs history using cvpysdk?  Any sample syntax that we can follow?

3
R
Byte
1 month ago
D
Byte
DUO-CSRByte
asked in Developer Tools, Integration and Automation
Retire VM via Rest-API

Friends,I want to use a script to retire/delete VMs from Commvault when the last backup is at a certain age. As we are a tenant customer, we don’t have options like Workflows.So I build a Powershell script to collect data, do different checks and fire Rest calls to Commvault.I can delete via the following command and this works fine:Invoke-RestMethod -Method 'Delete' -Headers $headers -Uri $($url + "/v4/virtualmachines/$UUID") But I can’t find the option to Retire the VM !And important in this case that I only retire the VM backup, not the client, as FS and SQL backups might be still in use. Anyone who knows how to Retire a VM using Rest-API ? Thanks in advance, Maurice

19
D
Byte
1 month ago
E
Eugen
asked in Developer Tools, Integration and Automation
To display a Commvault diagram of own infrastructure

Hello dear community,Can you perhaps help me. I heard that Commvault has a way to automatically display the Commvault infrastructure in 2D or 3D as a picture. Do you know how to do this or is this information incorrect? I would be very grateful if you gave me more information about this.That would help our employees to understand a little more of the commvault construction in our company. Best regards,Eugen

3
J
Vaulter
1 month ago
E
eimiy
asked in Developer Tools, Integration and Automation
Add content in VMgroup using REST API

I’m trying to add VM in existing VMgroup using REST API.In the VMgroup there are already many VMs are existing.Following the rule of sample from “Modify VM Group Details”  didn’t work.‘’’ curl -w -L -k -w "%{http_code}" -o response.txt -X PUT 'https://mycommvault/commandcenter/api/V4/VmGroup/12' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authtoken: $Token' \--data-raw '{  "content": {    "overwrite": false,    "virtualMachines": [      {          "name": "vm",          "GUID": "xxxx-xxx-xxx-xxxx",          "type": "VM"       }    ],  },}'  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                 Dload  Upload   Total   Spent    Left  Speed100   319    0     0  100   319      0   6645 --:--:-- --:--:-- --:--:--  6645500‘’’it worked when “overwrite” is true. but  the rest of VMs were deleted from this VMgroup.Am I missing something?How can I add VM on top of existing VM and not change anything else? 

2
christopherlecky
Byte
1 month ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Need an API endpoint to get the body for one of the APIs

I was thinking about below API end-point: https://api.commvault.com/docs/SP32/api/cv/VirtualizationOperations/vsa-subclient-previewPlease help me with the API endpoint that output below body:{ "appId": { "subclientId": 31, "clientId": 12, "instanceId": 4, "backupsetId": 0, "apptypeId": 106 } }I will use the above body in the API : https://api.commvault.com/docs/SP32/api/cv/VirtualizationOperations/vsa-subclient-previewMy idea is to fetch the subclient id and from the subclient id I can retreive the subclient name and work without manually entering any details.

2
R
Byte
1 month ago
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
qcommand/API/cs db query to find the VM Job ID in V2 Virtualization for instances in Amazon Web Services

Qcommand, API or CS sql query to retreive the information listed under Instance Status tab for a Snap job under V2 virtualization (Amazon Web Services)In V2 virtualization, we have VSAParentJobID which is 123654 in the above screenshot and each VM added in that subclient will have a VM Job ID associated to it for a Snap backup.Whereas in V1 virtualization , it was just one job id for all VM’s so there wasn’t any confusion, we use this JobID to cleanup any snapshots/ami that were left by FAILED/Partially Successful jobs.I’m finding it difficult with V2, since the snapshots are named as per the VM Job ID which is only seen within the Instance status tab in Job Details.The API for Get Job Details on a the VSAParentJobID is not giving me the associated VM Job IDIt only gives the following info:jobSummarysizeOfApplicationopTypesizeOfMediaOnDiskstatuslocalizedOperationNamebackupLevelclientGroups informationsubclient information like clientName, instanceName, backupsetId, clientID, subclientI

3
A
Byte
1 month ago
J
Bit
JanVdWBit
asked in Developer Tools, Integration and Automation
Can't kill workflow job

Hi,I have a workflow running with a loop/wait in it, so this keeps running.Another workflow needs to kill it when a specific condition happens, but this workflow can’t kill the job.I also tried to kill it manually with the “qoperation jobcontrol” command but that doesn’t work either.The only way to kill it, is right-click in the Commcell console. There’s no issue to kill other jobs with the “qoperation jobcoltrol” command.Does anyone have any idea why this is not possible and how I can get this working?Thanks and kind regards,Jan

1
S
Vaulter
2 months ago
D
Bit
dgzagm4q4cvBit
asked in Developer Tools, Integration and Automation
How to use Powershell to Disable Subclient?

Hello All.  I’m attempting to write a script to disable a subclient.  We have hundreds that we don’t require the backup of the File System, so I’d like to disable them.I can find information about the subclient...Get-CVSubclient -ClientName qct0bjsql01 | Where-Object { $_.appName -eq "File System" }clientName    : qct0bjsql01instanceName  : DefaultInstanceNamedisplayName   : qct0bjsql01backupsetId   : 2068_type_        : 7commCellName  : cvt0comsrv01instanceId    : 1csGUID        : xxxxxsubclientGUID : xxxxxsubclientId   : 4777clientId      : 5087appName       : File SystembackupsetName : defaultBackupSetapplicationId : 33subclientName : defaultentityInfo    : @{companyId=0; companyName=Commcell} However when I attempt to disable the subclient with this command it fails.Disable-CVBackupSubclient -SubclientId 4777Disable-CVBackupSubclient : Invalid URI: The format of the URI could not be determined.At line:1 char:1+ Disable-CVBackupSubclient -SubclientId 4777+ ~~~~~~~~~~~~~~~~~~~~~~~~~~

11
E
Bit
2 months ago
Henk22
Vaulter
Henk22Vaulter
asked in Developer Tools, Integration and Automation
Migrating backup vendor archives - is there a plan for other than file system data?

Hi all,In the 2024E release I read something about migrating data from other backup vendors to Commvault. Unfortunately this can only be done for file ystem data (the the moment). Is there a plan to migrate other data (databases, VM's) too? That would be a complete solution when a customer wants to migrate from another vendor to CommvaultHopefully we have some information on this! Thanks in advance for the answerKind regards,Henk

1
A
Vaulter
2 months ago
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
Qcommand or way to retreive the Instance Size details per VM from the job details for a Snap Backup job

I would like retrieve the instance size information for each VM for a specific job? Is there any qcommand / API that i can use to get this info

2
A
Byte
2 months ago

Badge winners

Show all badges
Terms & ConditionsCookie settings