Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 536 Topics
  • 2,223 Replies
537 Topics
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

312
A
Byte
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

24911
Onno van den Berg
Commvault Certified Expert
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>>>

1214
C
Bit
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!

512
roc_tor
Byte
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,

252
A
Bit
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 ?

371
christopherlecky
Byte
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?

643
R
Byte
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

17219
D
Byte
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

993
J
Vaulter
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? 

682
christopherlecky
Byte
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.

162
R
Byte
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

373
A
Byte
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

501
S
Vaulter
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+ ~~~~~~~~~~~~~~~~~~~~~~~~~~

51911
E
Bit
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

181
A
Vaulter
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

242
A
Byte
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
How do get my workflows to just start and return a jobid?

All my workflows will start but stay on the submission page until the workflow completes.What am I doing wrong?I want to enter the options for the workflow and then have it return the jobid. Thanks.

666
christopherlecky
Byte
M
Vaulter
MNRunner
published in Developer Tools, Integration and Automation
“sqladmin_cv and sqlexec_cv” accounts password change workflow

Does your organization have a mandatory password change policy and Commvault SQL accounts (sqladmin_cv and sqlexec_cv) are not in an exception? No worries. We have you covered. We now have “Refresh Commserve Database Access Key” workflow  available in your Commserve and it can be scheduled to change passwords of these accounts.  Happy meeting your security/audit requirements.  Have fun. 

18373
Erase4ndReuseMedia
Byte
Y
yogesh.tech
asked in Developer Tools, Integration and Automation
No "cc" field when sending Reports via command center

Hi ,I am trying to send an Daily Job summary report to Helpdesk team and keep my Manager in CC from COmmvault.But there is no option for “cc” field, it;s there in Alert section but not in reports.Can somebody help me if there is any option to customize the report and add CC form?

283
J
Vaulter
B
Bit
bpandaBit
asked in Developer Tools, Integration and Automation
Flag in API to enable WORM

So far we’ve utilized non-worm server plans for VM group and SQL instance backups via Equivalent API.Is there any approach in API to enable Worm flag.Any suggestions would be greatly appreciated.

312
B
Bit
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
How to invoke/run a custom report from workflow, if we have the Equivalent API for it

I have customized report (from Backup Job Summary report)which has the information of certain jobs with for ex:the report has a table which contains the following columnsJobid, subclient, job status, start time, end time  I have added a schedule to this report to generate csv format file at a specific time.If have to run this report from workflow, which API shall i use? 

351
H
Vaulter
L
Bit
Lukasz JaroszBit
asked in Developer Tools, Integration and Automation
FIPS

Hi,its possible enable FIPS mode on the Commvault server via API. If is possible please share me API endpoint for this. How I can check via API status for FIPS ? 

952
L
Bit
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
VM backup API returning internal server error

I need to backup VMs and I am using the below API:(tried both of them)https://api.commvault.com/docs/SP34/api/cv/OpenAPI3/virtual-machine-backuphttps://api.commvault.com/docs/SP34/api/cv/VirtualizationOperations/perform-vm-backupBut they are not working and throwing internal server. Can someone help me with this.P.S. I am testing it on a test commvault with similar environment to production.Below are the logs for one of my API calls:14536 175   05/31 11:44:36 175 admin  - WEBAPI-STARTED processing [POST]:[/v4/VirtualMachines/52c0fb3f-9cf0-ea0c-6518-ff20a5d37a6f/backup] request. : /v4/VirtualMachines/52c0fb3f-9cf0-ea0c-6518-ff20a5d37a6f/backup : Parameters : [backupLevel=FULL] : AdditionalInfo[ ConsoleType[API]]14536 175   05/31 11:44:36 175 admin GetTemplateInfoForAPI - Pipeline Stages selected : default14536 175   05/31 11:44:36 175 admin ProcessStep - Pipeline stage 'default' will be executed14536 175   05/31 11:44:36 175 admin ProcessStep - Request from the pipeline after rendering:

1162
R
Byte
V
Bit
VladimirPBit
asked in Developer Tools, Integration and Automation
Cannot restore VM to different VMware vCenter

I restored a VM from a backup to another VMWare vCenter manually from the Commvault console. Then I tried the same from a PowerShell script using the REST API. Thanks to @Jos Meijer  help I was able to execute the code, the job was created and started. After a while, Commvault reported that the job failed with the error message "Unable to modify the VMX file to restore the virtual machine."Does anyone know why it works fine from the Commvault console and not when the same VM is restored using the REST API? What can I check regarding the error message? I researched this error message on Internet but didn't find any helpful articles.​​

84512
Onno van den Berg
Commvault Certified Expert
L
Bit
Lukasz JaroszBit
asked in Developer Tools, Integration and Automation
OID SNMP MIB Simpana.mib

Hello. I have a questions about MIB.1. Where I find a link in the documentation to the latest MIB file with the latest OIDs? Is there a place on the Commvault 11.32 server where I can find this file?2. How often is the MIB updated?

2831
L
Vaulter
description of image

Badge winners

Show all badges
Terms & ConditionsCookie settings