Events
Platform Updates
How-To Videos
Support
Vault Club

Community
Commvault Cloud Topics
Developer Tools, Integration and Automation

Developer Tools, Integration and Automation

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

482 Topics
2,078 Replies

When you subscribe we will email you when there is a new topic in this category

482 Topics

Most views

Recently active Most replies Newest first

Takanori KikumotoVaulter

published in Developer Tools, Integration and Automation

How to retrieve Space Reclamation job results

IHAC using NetApp storage as Library mount paths, not supporting Sparse Files.Without Sparse File support, we cannot accurately calculate the usage of mount path data, but this is expected as normal cases.But this MSP customer, they’re still using BET charging to tenant users (I tried to eliminate this for couple of years but not succeeded yet), requires how much data actually occupied.It’s simply not easy and impossible to get accurate data, especially under DDB utilization since Commvault is retaining only the stats for non-aged jobs, so quite difficult to accumulate how much is written/purged as of now.Still we can retrieve rough image of usage from Commvault logs, from DDB Verification job results.After running DDB Verification, we can get reclaimable stats at a log file named DDBMntPathInfo.log on MA server(s) like (this is actual data at customer's site): 9601 2581 10/31 08:06:34 22551699 ====================================================================9601 2581 10/31 08:06:34

3100

1 year ago

JohnComBit

asked in Developer Tools, Integration and Automation

REST API for DR

I have just started getting into understanding how the Commvault REST APIs work and the types of data and control that can be done with them. I imported the collection into Postman, got logged in to the web server OK and can get output from all the basic GET commands, but have not been able to get some POST commands to work yet after trying a few. One that I am interested in working with is POST Testboot (and then also planned and unplanned failovers, so that I may orchestrate multiple failover groups). The response is: “Request body is empty or format is invalid.”Here is an example of my JSON body:{ "taskInfo": { "task": { "taskFlags": { "disabled": 0 }, "taskType": 1, "ownerId": 1, "initiatedFrom": 2, "sequenceNumber": 0, "ownerName": "admin" }, "subTasks": { "subTask": { "subTaskType": 1, "operationType": 4046 },

2 years ago

euMikeCommvault Certified Expert

asked in Developer Tools, Integration and Automation

VSA V2 job details SQL query

Hi there!I am trying to build a SQL query to get a list of ‘VM Job ID’, ‘VM Name’ and ‘Status’ based on subclient Job ID (VMware VSA V2). Any idea how to accomplish that? Which tables should be used to link subclient Job ID with VM Job IDs?Any help would be appreciated.Thanks!

3 years ago

PPCByte

asked in Developer Tools, Integration and Automation

Automation ideas for Backup failure using RESTAPI

Team,We have very huge environment where we have more number of backup failure which we are trying to fix the issue through automation using REST API. 1.Check the backup status for each client.2.Check if each client is ready(Check Readiness) for backup.3.If readiness getting failed then Recycle the services for each client.4.Resubmit the backup job for each client.5. Post if Resubmit is also getting failed then refer the log cuts Job manager.log and Evmgrs.log to find the failed/error details.Let me know if anything we can add it for other agent based backups like SQL, Oracle or SAP HANA database. Please update some additional steps if any initial troubleshooting using REST API will help us to reduce some failures in our environment.

1 year ago

DanCByte

asked in Developer Tools, Integration and Automation

CV Rest API | Syntax to get “Media In Library” summary info

Hello team,I use Commvault REST API to grab “Number of spare media” of tape libraries as per CV Bol motioned below so we can be notified if spare media is below the threshold that we set in the Python script. https://documentation.commvault.com/commvault/v11_sp20/article?p=48994_1.htm The Python script for CV rest API that I created is running fine and we are getting reports daily with all the required info that we need (e.g. library name, total/available space, SpareMedia count, etc…) Issue:I come across an issue where our Aux copies job stuck in queue due to lack of spareMedia and end up that is Commvault REST API doesn’t reports accurate SpareMedia Count with the request syntax that outlined in your BOLhttps://documentation.commvault.com/commvault/v11_sp20/article?p=48994_1.htm numOfSpareMedia Tape library total number of spare media. tapeLibSummary Findings:CV BOL Rest API only returns the result at root level (tape library summary ), but the accurate Sp

8 months ago

Takanori KikumotoVaulter

posted in Developer Tools, Integration and Automation

Automatically export log bundles for job error

This is simple but working trick to maintain Commvault.Backup jobs might fail at night and you'd like to find out the cause of errors, you need to collect log bundles in the first place.But when you realize the errors after a while (say couple of days later), job logs might be rolled over, important information which would contain the error messages gone.To avoid this situation, you can setup various alerts, collect logs immediately after you receive any.This also cumbersome so you can introduce simple workflow which can be called at the same timing of alert, also collect logs automatically.Rough process as follows: Generate an answer file for "Send Log Files". This procedure is utilizing Save as Script, which can be saved most of user operations with parameters, generates .bat file and XML file. The latter is called Answer file which contains the actual operaiton parameters in single file. To export this, you can start "Send Log Files" process from CommCell Console: Then you're getti

2 years ago

SergejByte

asked in Developer Tools, Integration and Automation

Report: "Merge Duplicate Clients"

Hello, is it correct that the report “Merge Duplicate VM Clients” shows only duplicated VMs?Some time ago I was able to see all duplicates:VM - VM VM - FileSystemNow the report doesn’t show duplicate VM - FileSystem clients, in the console I can see them.Tested on 11.28.37 / 11.24.69 with the APP from Download. What would be the way to identify duplicate VM - FileSystem clients?Merge only by CLI? ThanksSergej

1 year ago

BenjisByte

asked in Developer Tools, Integration and Automation

API on client details

Hi All, I would like to ask for some better ideas than mine..In particular I need information if client has it’s backup activity enabled/disabled on client level and if so, collect it’s commcell name as we have 2 commcells in our environment. Also, client shouldn’t be deleted (greyed out in Java GUI).Here is the snippet of code to get the general idea for what I need. def check_config_on_client_level(self, cloud_vms): """This method will check if disabled for backups in cloud2 vm has backup enabled on client level in commvault""" bad_client_level_config_vms = [] for api in self.cs_url: api['headers']['Content-Type'] = 'application/json' for vm in cloud_vms: request = api['url'] + f"Client/byName(clientName='{vm['vm_name']}')" response = requests.get(request, headers=api['headers']) if response.status_code == 200: client_details = response.json() for vm_client

2 years ago

jmiamaralByte

asked in Developer Tools, Integration and Automation

Email notification on schedule via command line

Hello, I’m trying to add an alert to my script, when a scheduler runs to send the output via email to the client.I want to configure this via command line.I searched in the documentation but didn’t seem to find any information about this.Does anyone know how to do this configuration? Kind regards,Jmiamaral

2 years ago

Allan0105Byte

asked in Developer Tools, Integration and Automation

wait for job completion command line

Hi Team,Greetings! I can able to run the workflow using below command which i saved in .bat file, which will start the workflow with job id. i want to monitor that job id using another command as wait for job completion in same .bat file and save that output to the text file whether it got completed or not. is there any option available for it ? qoperation execute -af execute_workflow.xml -associations workflow_engine -workflowName baas_workflow -tf c:\tokenFile <TMMsg_CreateTaskResp taskId="4231"> <jobIds val="18722"/></TMMsg_CreateTaskResp>

2 years ago

Robert HorowskiCommvault Certified Expert

asked in Developer Tools, Integration and Automation

Deploy VMware Access Node using API

HiI’m trying to deploy Acess Node for VMware using API but can’t seem to get this to work.I’m using this: https://api.commvault.com/#f9950083-6ef5-487d-9b32-d332b843b64cwith powershell from Commserve computer. I was able to successfully aquire QSDK Token, but when I try to deploy AN I get error:Here is TaskManager.log fragment:9456 1 01/13 16:09:11 ### ### ControlTaskMgr - Request received for [Tag_CreateTaskReq], userId [5], commcellId [2], sequenceNumber [1], fromUpgrade [False], endUser [False]9456 1 01/13 16:09:11 ### ### ControlTaskMgr - Input xml <TMMsg_CreateTaskReq> <processinginstructioninfo> <locale _type_="66" localeId="0" /> <formatFlags skipIdToNameConversion="1" /> <user userName="" userId="5" _type_="13" /> </processinginstructioninfo> <taskInfo> <subTasks> <subTask subTaskType="1" operationType="4038" /> <options> <adminOpts> <vmProvisioningOption operationType="59"> &l

1 year ago

christopherleckyByte

asked in Developer Tools, Integration and Automation

Workflow Datacenter refresh?

You can refresh data-centers from the GUI, is there an equivalent for the REST api?The api explorer has /v2/vsa/hypervisor/clientID/refresh But that seems to only refresh the actual DC list, rather than the VM list. Basically I want to be able discover a VM that is not currently a part of a subclient. Thanks.Chris.

2 years ago

dgberridBit

asked in Developer Tools, Integration and Automation

Setting Advanced Backup Options for SQL Server Default subclients through REST API

Can anyone point me towards the documentation on how to set the Advanced Backup Options for SQL Server Default subclients through REST API? I can’t seem to find where to set these in the API docs. I’ve attached an image of the props I’m looking for.

2 years ago

prudhviBit

asked in Developer Tools, Integration and Automation

Qcommand to get install directory on a client or mediaagent

3 years ago

Michal AntosBit

asked in Developer Tools, Integration and Automation

VM Backup and restore workflow

Hello,I am trying to create workflow for VM backup and restore.I have used predefined workflow Demo_FileSystemBackupRestore and tried to modify it for VM.Everything goes fine until it gets to restore phase where I get Error 0x303: Q_VIRTUAL_SERVER iDataAgent is not supported by this command.Thanks for any suggestions,Michal

1 year ago

CraigUBit

asked in Developer Tools, Integration and Automation

PowerShell Restore-CVSQLDatabase questions

We're running Commserver 11.22.9.I have a couple of quick question regarding the Restore-CVSQLDatabase PowerShell module.The command I'm testing is as follows (with parameters provided by caller)...$RestoreObject = Get-CVSQLDatabase –ClientName $SourceClient -InstanceName $SourceInstance -Name $SourceDBName | Restore-CVSQLDatabase -OutofPlace –OverwriteExisting -DestClientName $DestClient -DestInstanceName $DestInstance -DestDatabaseName $DestDBName -DataFilePath $DestDatafilePath -LogFilePath $DestLogFilePath -ForceIs documentation available that covers all available parameters? The doc site does not cover most of the parameters above. Is there a parameter providing for changing the physical datafile name and the physical logfile name? This functionality is available through the CV Command Center.Thanks for any help.

3 years ago

VjduurenByte

asked in Developer Tools, Integration and Automation

Intelligent AirGap flow

Hi,I am currently testing with Airgap technology to make aux/offline copies to an isolated environment with WORM enabled. To explain the situation bit more this is how it works -- see picture below.FYI; to Power On/Off the MA’s I use the Workflow: Airgap which commvault provided.To make it more intelligent I created an PoSH which checks all the jobs that is being initiated by the AirGap Schedule Policy and if all the jobs contains: ‘completed’, ‘completed with errors’ or ‘failed’, the machines are going down using the Workflow.Now I know there are some Administrative Jobs that has to run as well like;Data AgingDDB BackupsData verificationReclamation etc...Ofcourse I can make this part of the PoSH script before Power Off the MA’s but is it smart to do? Is there anyone who has experience with the administrative processes and this technology below?

2 years ago

Base64Byte

asked in Developer Tools, Integration and Automation

Workflow Commands that stops the schedule and the CV services

Hey Team, i need to build an Workflow, for the “Update Team”. They should simply start the workflow which then stops all jobs, makes a DR backup, disables the schedule and stops the services for CS or Mediaagent. Unfortunately, I'm a noob when it comes to this topic. I got the point about stopping all jobs and then doing a DR backup. I even saw a point where the services are restarted but that doesn't help me either. Maybe someone has an idea from you :)

2 years ago

Bjoern_SRZC

asked in Developer Tools, Integration and Automation

REST API Endpoint for Health Status

I tried to get some Information similar to the Health Status Dashboard by Rest API.I only need the overall Results and not all details.Is there any endpoint which i can use to get it?

3 years ago

DimitriByte

asked in Developer Tools, Integration and Automation

API Call for client license consumption

Hi guys,is there a easy API call where I get the license consumption for a client?I found this API call:{{ServerUrl}}/Client/{{clientId}}/License But this gives me only the used license type / name e. g.:{ "licensesInfo": [ { "platformType": 1, "license": { "licenseType": 1, "appType": 33, "licenseName": "Server File System - Windows File System" } }, { "platformType": 1, "license": { "licenseType": 3, "appType": 81, "licenseName": "Application Class 1 - SQL Server" } } ]} My goal is to get a output like: clientA is using 200gb of license “Server File System - Windows File System”and clientA is using 100gb of license “Application Class 1 - SQL Server”

3 years ago

AbdulWajidBit

asked in Developer Tools, Integration and Automation

RestAPI Get Running VMJobs

Hello Team I was trying to get the running jobs for a specific VM. I have below code but it is returning zero results. function Get-CVVMJobStatus { param ( $VMName ) $vmGuid = ($Global:CVVMData.vmStatusInfoList | Where-Object name -eq $VMName).strGUID $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" $headers.Add("Accept", "application/json") $headers.Add("Authtoken", $Global:cvToken) $URI = "http://xxxx/webconsole/api/v2/vsa/vm/$vmGuid/Jobs?completedJobLookupTime=3600&jobTypeList=backup&showAgedJobs=true&backupLevel=Full,Incremental" $response = Invoke-RestMethod $URI -Method 'GET' -Headers $headers $JobsData return $response}

2 years ago

katmanBit

asked in Developer Tools, Integration and Automation

user authentication in workflow

I want to user authentication when sending mail in Workflow. how can i set?

2 years ago

pank1988Byte

asked in Developer Tools, Integration and Automation

Workflow for Failed Backup Re-run

Hi Guys,,I am working on to create a workflow to automatically re-run the failed backup jobs. I have started creating a test workflow but seems to be a complex task. Has anyone worked on a similar workflow in Commvault ? Regards,pank1988

1 year ago

DmitiyBit

asked in Developer Tools, Integration and Automation

Get-CVSQLDatabaseBackupHistory backup history for the database [test] is not available

Can't get database backup historyPS C:\Windows\system32> Get-CVSQLDatabaseBackupHistory -Name test -ErrorAction SilentlyContinueValidateResponse : Status: ProtocolErrorMessage: The remote server returned an error: (500) Internal Server Error.ErrorMessage: RecommendedAction: At C:\Program Files\WindowsPowerShell\Modules\CVPowershellSDK-master\Modules\Commvault.RESTSession\Commvault.RESTSession.psm1:410 char:17+ ValidateResponse $response $output $ValidateProperty+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,ValidateResponse INFO: Get-CVSQLDatabaseBackupHistory: backup history for database [test] is not availableInitially, using the CVPowershellSDK-master module, the Get-CVSQLDatabaseBackupHistory function worked correctly and returned a list of backups. Can you please tell me if the co

2 years ago

Anthony.HodgesCommvault Certified Expert

asked in Developer Tools, Integration and Automation

Has anyone used the "REST API - Filters for Search or List APIs" successfully?

Hi,I am running FR11.22.12 and when I run REST queries against the ‘performSearch’ REST collection (as per Filter Based on Custom Properties (commvault.com)) I immediately get the following error{ "currCIEngineType": 3, "rawQuery": "", "errList": [ { "errLogMessage": "Search preparation failed.", "errorCode": 3008 } ], "proccessingInfo": { "totalSize": 0, "totalHits": 0 }}The Commvault Logs return HTTP code 200 and and there are no errors appearing in WebServer log at Debug 10. However, when I dug deeper, I can see that Commvault calls upon to IIS read for these non-existent files then it soon the REST POST command fails.C:\Program Files\Commvault\ContentStore\WebServerCore\performSearchC:\Program Files\Commvault\ContentStore\WebServerCore\performSearch\web.configC:\Program Files\Commvault\ContentStore\CVSearchService\CVWebService.svc\performSearchC:\Program Files\Commvault\ContentStore\CVSearchService\CVWebService.sv

3 years ago

Page 6 / 20

Badge winners

DannyJhas earned the badge Topic Starter 1
typer100has earned the badge Topic Starter 5
Hardyhas earned the badge Topic Starter 1
fariz kuswaradhanahas earned the badge Contributor 1
jxbarbhas earned the badge Contributor 10

Show all badges

Terms & Conditions Cookie settings

Sign up

Already have an account? Login

Commvault Login

Login to the community

Commvault Login

Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.

Enter your e-mail address

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.