Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 547 Topics
  • 2,257 Replies
548 Topics
B
Byte
BloopaByte
asked in Developer Tools, Integration and Automation
uninstall agents on windows machines (ansible)

Dear all,I am trying to find a way to uninstall the commvault file system agent on some Windowss Virtual machines. We want to keep only Vmware Snapshot backup and sql agent inside the VM.Do you have any clue on where to find the rights commandsWe use ansible, and actually it works only for linuw machines. Thanks ! 

2466
Graham Swift
Vaulter
J
Bit
JayBRBit
asked in Developer Tools, Integration and Automation
Problem with API access through API Explorer

Hello community,We’ve been trying to retrieve a QSDK token in Swagger API Explorer to develop some custom tools and we always get the below error even when we try to log in with csadmin (and yes the password is converted to Base64).Are there any Advanced\Additional Settings that need to be added to the Web Server object in order to access the web service? Thanks for your help!"errLogMessage": "Username or password is incorrect", "errorCode": 1117

5324
Mike Struening
Vaulter
V
Bit
VladimirPBit
asked in Developer Tools, Integration and Automation
REST API call for PowerShell command Get-CVVirtualMachine

What can replace the "Get-CVVirtualMachine" PowerShell command in the Commvault REST API?I use the "Get-CVVirtualMachine -Protected" command to get a list of virtual machines that are being backed up so that I can start a restore.Looked at the API page on my Commvault server (https://CommvaultSRV/webconsole/sandbox/apiexplorer/#/Virtualization%20Operations) and I couldn't identify any GET command that would give me the same result as the PowerShell command. Does anyone have any idea how to get a list of all protected VMs from Commvault REST API?

1573
Onno van den Berg
Commvault Certified Expert
C
Bit
chen belayshBit
asked in Developer Tools, Integration and Automation
Authorization Workflows two approvers

hi, Is there a way to have two approvers or more in the authorization workflows(delete job, delete client, delete storage policy) thanks,

5771
Mike Struening
Vaulter
chrisknows
Byte
chrisknowsByte
asked in Developer Tools, Integration and Automation
Can someone explain to me what is happening with this Javascript snippet in the workflow?

What I am doing here is using the javascript subscript method to get a character to use in a switch statement.I noticed the switch statement is always going to default so I stuck a logger.info snippet into the workflow and apparently substring is returning a number instead of a character.    Clearly I am doing something wrong. Halp.

626
chrisknows
Byte
H
Bit
HNICsolanBit
asked in Developer Tools, Integration and Automation
Is there a way to define Plans in a workflow?

I’m looking for anyway to have new clients installed to be directed to use X plan. Whether that be in a workflow, client group, or other. 

1388
Mike Struening
Vaulter
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
workflow query

Can anyone have workflow for below steps ? we would need to run the workflow as the first step and then the workflow would have a box that pops up asking for the name of the Client we want to decommission where we input the client name.Then we want the workflow to remove the client from all the groups it is part of (with the exception of automated client groups).Next we want the workflow to turn off backup activity of the client.Next we want the workflow to add the client to the decommissioned group.

12014
Mike Struening
Vaulter
A
Byte
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> 

3465
Mike Struening
Vaulter
D
Byte
DannyByte
asked in Developer Tools, Integration and Automation
Authorizing Requests on CommCell Entities Using Workflows

Hi, I need your help. Maybe I do not see it all anymore, or we have a flaw in the automatic authorizing workflows or better said, we miss one.This is the caseIf we delete a client a workflow starts which sends a mail to authorize. Works fine. One note though if a job is running for that client, it will not notify you, message is send but after authorizing the client will not be deleted.If we delete a backupset the same, works fine, email is being sent.But now it comesThere is also an agent we can delete and I do not see a workflow for this.When I hit delete, it will say if there is a job running or not, but if not, I just have to fill in the known words and the agent along with all data is deleted.I have no other environment to test quickly to check if it is for this particularly environment but does anyone else encountered this maybe??Looking forward to any answer. Thanks,Danny

773
Mike Struening
Vaulter
Onno van den Berg
Commvault Certified Expert
Onno van den BergCommvault Certified Expert
asked in Developer Tools, Integration and Automation
Rest API: Explanation vmStatusInfo-> Vendor property / identify underlying HV type

I'm trying to automate certain tasks by querying the APIs. I first tried the newly released Powershell SDK which turned out to be broken right now. The development team is aware and they stated they will fix it somewhere next week so I decided to continue without SDK and write the modules myself.I'm trying to achieve the following:In case the client is discovered via VSA I would like to know the hypervisor vendor. In case a client is not part of VSA I would like to know if it runs as a virtual instance and preferably I would like to know what kind of virtualization platform. I know Commvault pulls this information from a client using the agent to make the distinction between OI and VOI and also that they can identify the platform but would like to leverage this myself as well and I would expect this information to be available as a client property that can by pulled over via the API. 1)So I already discovered that in case a client is discovered through the VSA client that the client pr

16914
Onno van den Berg
Commvault Certified Expert
LukeBrett
Byte
LukeBrettByte
asked in Developer Tools, Integration and Automation
PowerShell Invoke-RestMethod for API Call

Hi guys,I have been using the CVPowerShellSDK_v1 and was able to create tools and scripts for our team. Now, I would like to move a step further and make my own API Calls with the Invoke-RestMethod in PowerShell but I am having a hard time to get started (disclaimer: I have a backgrouind as a sysadmin, not a web developper). I played around with Postman, API Explorer, I went through the documentation on the subject and tried different ways to interact with APIs in PowerShell but I still haven’t succeeded in retrieving data with a simple GET method. I am at the point where I need a little help from friends to move forward. So, if anyone could help me to make a simple GET request through PowerShell with an output in JSON format, I would greatly appreciate and would be able to figure out the rest by myself.Let’s say, for example, I want to retrieve the information of the EmailServer and create a simple function like Get-CVEmailServer.In curl, the request would be: curl -X GET "https://mys

70084
Onno van den Berg
Commvault Certified Expert
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
API connectivity to commvault

Hi Team, Greetings !How can we connect the API to commvault from any automation tools like ansible , jenkins etc..  Thanks in advance! 

1612
Onno van den Berg
Commvault Certified Expert
Heath
Byte
HeathByte
asked in Developer Tools, Integration and Automation
Reports for Schedule Policies

I am trying to find out if there is a report that I can run for each of my Schedule Policies.  Currently when checking backups from the night before I go into Schedule Policy, go to each of our policies and view jobs.  I can then verify if it went to tape or even look deeper to see what files were backed up.  Is there a report that I could run each night so in the morning I just have reports for each one that I can easily view pretty much the same info of all the Subclients under each policy and the stats for the previous nights backup?  I realize I may have to dig into creating my own reports, which I am still figuring out.  Thank you for any help in pointing me in the right direction.

7468
Mike Struening
Vaulter
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Workflow activity error handling

When writing some programs especially for business purpose, we need to implemente "proper" error handling to avoid unexpected errors, this is applicable when we write Commvault workflows. But sometimes it's slightly tricky to capture exception happened in some activities, without care the workflow itself simply stops with error, if the workflow is set as Job mode the job is sit pending. To avoid this situation you need to set 2 parameters in the activity you want to capture the event, which is described in the following Documentation but not so intuitive: General Properties for Workflow ActivitiesFor testing, we create a Script activity which simply raise exceptions (divide by zero) as follows:When reaching this activity, workflow would stop with the following error, quite straightforward:To capture the error we need to modify 2 properties on this activity:"Continue after max restarts" from "false" to "true" "Maximum restarts" from empty to "0"  With this setting, the next activity wou

1271
Mike Struening
Vaulter
B
Byte
BoyiByte
asked in Developer Tools, Integration and Automation
Is there a way to add keywords in client descritpion in bulk

Hi, I created a client group to include 100+ clients using auto association based on rules.I am looking for a way to add the same keywords in client description of every client in this group.As there are more than 100 clients, if it is possible I am trying to avoid going through them one by one to add this keyword. Kind regards,Boyi

25312
Onno van den Berg
Commvault Certified Expert
A
Bit
Alexandre OliveiraBit
asked in Developer Tools, Integration and Automation
Commvault API Integration With Zabbix

We are creating an integration between our monitoring tool (Zabbix) and the Commvault API, to have backup alerts centralized in a single location (Zabbix).Using the documentation, they are doing a GET to the Commvault API.And the return brings all the historical events, an immense list. We need the query to return only the events that are currently “problematic”.Is there some kind of query within the API that only returns problem events that are currently occurring? Or some other way to centrally show, in Zabbix, the events and problems of Commvault?

25622
Onno van den Berg
Commvault Certified Expert
chrisknows
Byte
chrisknowsByte
asked in Developer Tools, Integration and Automation
Can someone tell me what is wrong with this workflow script activity?

I have a short script activity that checks the output of a powershell command, as far as I can tell it works perfectly but when I run “check syntax” it gives me a lexical error.  

733
Sunil
Vaulter
M
Byte
Mike GaleByte
asked in Developer Tools, Integration and Automation
Rest API - Create Instance POST Instance request

I’m having a problem with POST requests using the api - I’m trying to create a new AWS RDS instance but every time the response is returns:  Request body is empty or format is invalid.  if the password is base64 then > "errorMessage": "Please provide a Binary Directory."I have exported the json payload directly from the webconsole using “equivalent api”URL: https://[hostname]/webconsole/api/Instance{  "instanceProperties": {    "description": "",     "instance": {      "instanceName": "aurora/api-commvault-test[eu-west-2]",      "applicationId": 125,      "clientId": 1514,      "clientName": "comm-test1"    },    "version": "12.8",    "postGreSQLInstance": {      "MaintainenceDB": "postgres",      "port": "api-commvault-test.cluster-cs3xzph9yufx.eu-west-2.rds.amazonaws.com:5432",      "SAUser": {        "userName": "commvault_admin",        "password": "M2VrdkZnbDFjd3VTVXpUelUuRWpeS3ZwdG0waTNC"      },      "ArchiveDelete": false,      "logStoragePolicy": {        "storagePolicyId":

1984
Mike Struening
Vaulter
S
Bit
S7_VenkatBit
asked in Developer Tools, Integration and Automation
Commvault integration with Tensai automation tool

Hi All, please let me know if anyone worked on integrating COmmvualt API’s to Tensai tool for any backup job status or anything else. 

687
C
Vaulter
ZachHeise
Byte
ZachHeiseByte
asked in Developer Tools, Integration and Automation
Troubleshooting not being able to install items from Commvault Store?

I’m interested in getting this workflow from the webstore, but both on the commserve’s browser (MS Edge) or on my workstation (firefox), when I click the install button while signed in with my commvault account - so this link here: https://commserve.mycompany.edu/webconsole/softwarestore/#!/136/671/14567 from my commserve, i see the messages in the lower right corner:Installing "Enable Subclient Index"followed seconds later bySomething went wrong installing Enable Subclient IndexWhat logs can I examine to figure out why this is happening? following the prereqs here, I definitely know I’m logged in as part of the master group, and obviously the commserve has the web console installed.I also did use this successfully once, a couple years ago, to install a workflow, so I know it has worked in the past.

5837
Mike Struening
Vaulter
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
removing multiple users from Gmail and Google Drive backups

I need to remove some 1000 users from the Gmail and Google Drive backups. do we have any automated or easy method to complete it.

988
A
Vaulter
Base64
Byte
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 :)  

2974
O
Vaulter
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
REST APIs using commvault for database restore (duplication) activity

We have Jenkins and want to use REST APIs to connect to commvault for database restore (duplication) activity, is it possible ? 

1913
Mike Struening
Vaulter
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
VM Subclient Discovery

I have a script that adds a vm to backups by modifying the vm tag in vcenter.The problem is that the VM does not show up in Comvault until the subclient refreshes, which happens during the discovery phase of a backup or if a preview is done on the subclient. Is there a way to programmatically refresh subclient content for VSA based backups? A datacenter refresh is too heavy, and general of an operation, I need something more specific thanks.Chris.

5483
christopherlecky
Byte
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
Calling workflow

We have created an workflow which will do some automation task for our BigFix patching. did anyone know how to call / run the commvault workflow from BigFix , qcommand or do we have option to run the workflow using command line so that we will create a bat file on commserve and will make BigFix to call the bat file to run the workflow as we don't want to schedule the workflow from commvault and we want BigFix to call / run them. Thanks in Advance. 

1603
Mohammed Shereef P
Vaulter
description of image

Badge winners

Show all badges
Terms & ConditionsCookie settings