Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 538 Topics
  • 2,228 Replies
539 Topics
D
Bit
docsuperbBit
asked in Developer Tools, Integration and Automation
Object Storage Deletion Authorisation Workflow

CV has kincly provided a pre-built client deletion authorisation approval workflow for virtual machine clients. There isn’t a pre-built workflow for objectstore clients (e.g. Azure FIles objects) - I’m wondering if that’s because it’s not possible or it’s just not a popular request(!) - has anyone done anything with this/can comment on whether it’s possible? Thanks.

652
D
Bit
B
Byte
BillyHByte
asked in Developer Tools, Integration and Automation
qlist job returning no jobs to display when filtering for a specific subclient

I am trying to use the qlist job command to return the running jobs for a specific subclient. Using a command structured like the one below it always returns “No jobs to display” even though a simple “qlist job” command returns results. What am I missing? qlist job -c 'clientName' -a 'Q_VIRTUAL_SERVER' -i 'VMware' -b 'defaultBackupSet' -s 'subclientName' -cs 'commserveName' -jt 'admin'

1102
B
Byte
M
Bit
Marcel KrommenhoekBit
asked in Developer Tools, Integration and Automation
SharePoint o365 Agent site selection automation

Hi All, I have a bit of a challenge on my hands. I’m migrating a customer to the new SharePoint agent, but I cannot seem to find a way to effectively select the needed content. The situation is as follows the customer has 51K sites, but most of them are created by students, and should not be part of the backup. So we only want 1300 in the backup. In the previous agent I could do some magic with regex to make this happen. But I do not see a good solution in the new agent. Both the Mail and OneDrive agent give me the opportunity to work with groups, but the SharePoint agent only has all sites, all group sites and project sites. Or i have to click 1300 sites which is not feasible, I also looked of a json to do this, but ne new agent does not take the json format of the old agent so that does not seem to be a solution as well. Anyone have any idea how I can do this, and possibly automate it so we can update the site content occasionally?

1083
M
Bit
M
Byte
MauroByte
asked in Developer Tools, Integration and Automation
Dashboard missing information

Hi all I have a customer who’s dashboard doesn’t report on a number of fields. Running the reports for each component also brings up empty results, as expected. I had a look at the possibility of Branch Cache running as per another post here on a similar issue, but it isn’t installed.I staged the Commserve in my lab and reporting is correct.The customer is on FR11.21 and the lab version is FR11.28.xxI don’t think this would be a fix as I believe the issue has been around for some time. Below is the client view: Below is the view in my lab:

1459
M
Byte
D
Byte
DanCByte
asked in Developer Tools, Integration and Automation
API for mssql db clone

Hello Community Issue: I’m trying to schedule mssql db clone via Command center, and there is no such option. Looking to clone db via CV API or Sending QCommands as a API Json request Tried: While manually creating mssql db clone via command/admin center, noticed there is a Json Post Request Payload for instance clone. Search in CV BOL, and nothing but how to View DB Clone via .py script https://documentation.commvault.com/11.24/essential/45532_samples_for_developer_sdk_for_python.html#viewing-instant-clones Questions: the db clone has a payload request, from where I can find the related Post Request Syntax (example: 'http://<webserver>:port/SearchSvc/CVWebService.svc/databases/Action_XXX/clones_XXX') for mssql DB clone, thanks Or Sending QCommands as a API Json request CV Syntax example is for XML and I want to make it work for Json. Can I use ‘inputRequestJson’ to get Json Request Payload that shows in above screenshot? https://documentation.commvault.com/2022e/essential/48618_rest_a

942
D
Byte
C
Commvault Engineer
asked in Developer Tools, Integration and Automation
Define runtime for a Workflow

Hi, This question is for the workflow guys. We created a workflow which monitors certain running jobs, which is scheduled to start every day, in the workflow there is a condition which ends the workflow when there are no running jobs and a loop which executes every 5 minutes to check the status of the running jobs. In some cases, our jobs running jobs takes too long to complete, and we want to force our workflow to complete when reaching certain hours (For example 01:00 AM) even if there are still some running jobs. My question is, is there any way to make the workflow run for a defined interval of time ? Here are what I’m thinking of so far : Inside the workflow, before each iteration of the loop, check the time and if a certain time is reached, the workflow completes. For this one, I don’t know if the workflow editor offers the tools to implement this, or should we make it execute a script that we have to create manually from scratch. We have also the option to make it run for certai

632
C
T
Vaulter
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:

3480
T
Vaulter
T
Vaulter
Takanori KikumotoVaulter
published in Developer Tools, Integration and Automation
VSA subclient information #2

Continued topic from Community Topic #10 VSA subclient information #1 As we can copy VSA subclients from one VSA client to another using tricky and slightly dangerous approacy utilizing Clone CLI, unfortunately there's another issue that we cannot clone individual schedules (not schedule policy settings, this would be cloned). To achieve this, we need to modify CSDB again.Basically schedule information is stored in TM_Task and TM_SubTask tables, but other tables started from TM_ also be involved.And another thing is, the format to generate schedule is quite complicated so cannot easily mimic the behavior, so I took an approach to copy all records to new schedule at SQL level. Digging a lot, we can achieve like this: List up all schedules per subclient. Create dummy schedules on this subclient (this can be done by creating simple schedule on CommCell Console and retrieve parameter XML file from "Save As Script"). Replace the schedule "contents" with SQL queries. Workflow images like thi

460
T
Vaulter
T
Vaulter
Takanori KikumotoVaulter
published in Developer Tools, Integration and Automation
VSA subclient information handling #1

Background story: IHAC who upgrade VMware environment (from 6.0 to 6.5), copy VMs from old environment (vCenter/ESX) to new, so need to change Commvault side to change access path to vCenter at client level. Problem here, one VSA client has multiple subclients which contain some VMs as contents, these VMs are not migrated at the same time, so we cannot change vCenter access path until we migrate all VMs to new environment, because of that there's a request to copy subclient information "one-by-one" to new VSA client (how to retain job sequences would be another topic, slightly complicated per Index versions). We can achieve this by creating new subclients on new client one-by-one by specifying all attribures (contents, configurations, etc.), but some of clients have over 100 of subclients each, so requested automated approach, which could be Commvault Workflow. Major problems on Commvault automation to create subclients, We're not officially provide exact parameter to generate a new VS

2272
T
Vaulter
M
Byte
Mostafa AminByte
asked in Developer Tools, Integration and Automation
Using workflow activity VMutility to cloneVM

Hi, using the “cloneVM” activity in a workflow fails. The workflow Inputs of HttpClient Inputs of CreateNetwork “On start script” on the first delay The inputs for the clone activity The clone job The logs: The error is same if I: Used the vmGUID only (without the vmName) Used the vmName only (without the vmGUID) Tried the vmName or the vmGUID constants not variables

345
M
Byte
S
Byte
SHASHAByte
posted in Developer Tools, Integration and Automation
Camunda for Commvault

Hi Team, Has anybody used Camunda for workflow/process/task automation and orchestration? As Commvault offers APIs, has anyone tested/implemented Camunda for Commvault? Regards, Shasha

283
Mike Struening
Vaulter
D
Byte
DanCByte
asked in Developer Tools, Integration and Automation
Rest API | unable to disable a schedule via Python

Hello Community , CV references : https://documentation.commvault.com/2022e/essential/45562_rest_api_getting_started_using_python.html https://documentation.commvault.com/2022e/essential/48793_rest_api_post_schedules_disable.html the above screenshot is CV sample POST request to disable schedule job and I want to be able run this specific POST Request via Python so I can do more personalization on it/more control on it (e.g. run multiple taskid at one shot, output pre/post result, etc...): 1- Issue Description: I'm using this script to make a POST request to the Commvault disable schedule API. in this case, I want to pass the plain text (taskId = 125918) as a variable so I can use it in the script, and can't make the POST request with this plain text that highlighted in the above sample screenshot(taskId= 451). taskId = 0task = {(taskId, 'text/plain') : 125918}r2 = requests.post(DisableSchedule, data = task, headers=headers) 2- what have been tried: #1 " tried below script and gave an

1281
D
Byte
A
Anjali
asked in Developer Tools, Integration and Automation
media agent installation using cvpysdk

Hi All, I am trying to automate the commvault setup, configuration and backup/restore procedure in our environment. We have chosen python sdk (cvpysdk) to do automation. I am not able to find any module for media agent installation in cvpysdk. Can anyone please please help me with the workaround? Even a CLI would help for automation. I am doing all the setip on windows client, hence need the cli/module for windows setup/configuration. Thanks in advance.

1602
christopherlecky
Byte
C
Commvault Engineer
asked in Developer Tools, Integration and Automation
MediaAgent running jobs

Hi Guys, Hope everyone is doing good. Is there in windows command to be used on the MA to check if there are any running jobs on that MA ? Kind regards.

60822
Mike Struening
Vaulter
L
Bit
LizYBit
asked in Developer Tools, Integration and Automation
how to use the REST API to bulk update client entity tags

We want to add custom tags on each backup object via Python automation. Can you please provide guideline on how to use the REST API to bulk update client entity tags

2145
Mike Struening
Vaulter
S
Bit
Sasidhar_CVBit
asked in Developer Tools, Integration and Automation
Supported Plugin for vRealize Automation 8.X

Please confirm whether we have supported CV plugin for vRA/vRO 8.X, I see the information in the URL - https://documentation.commvault.com/11.25/expert/32458_vrealize_automation_support_for_vmware.html refers to vRA 7.X.

4715
S
Bit
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
Business Logic Workflow : GetAndProcessAuthorization "javax.mail.internet.AddressException: Missing final ‘@domain’ in string “Test”"

I had enabled the enable reply via email and had updated the Email Approval details in the Workflow as mentioned in https://documentation.commvault.com/2022e/expert/60276_enabling_reply_via_email_for_userinput_activity.html Now the workflow is not sending the approval mail I’m getting the following error : javax.mail.internet.AddressException: Missing final ‘@domain’ in string “Test” As its a predefined workflow , I’m unable to find this Please help me where do we need to make the update Where do i set the Reply to mail id?

31910
Mike Struening
Vaulter
E
Byte
Erik SoosaluByte
asked in Developer Tools, Integration and Automation
Get Job api settings to get all active jobs

So I’m trying to run a REST api call to get all current running jobs. I’m ultimately try to get to the same state that the Command Center shows for it’s active jobs. I can run the following which gets me the active backup jobs, but does not show anything else: curl -ks --location --request GET "https://commserve/webconsole/api/Job?jobCategory=Active&jobFilter=" The jobfilter options (https://documentation.commvault.com/v11/essential/105923_jobfilter_parameter_values.html) don’t seem to have an effect. Setting ALLOPS doesn’t get everything (in fact hides running backup jobs). I’ve tried using DDBOPS when there is DDB activity going on and that doesn’t give a response either. Is there something I’m missing here? My end state is just trying to determine at a point in time that there is nothing Running/Waited/Queued/Pending so that I can trip off other tasks (OS level patching), so if there is another way to do that I’m open to that as well.

5673
Mike Struening
Vaulter
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Need help to get a list of vCenter instance hostnames

I cannot use the client list because we have duplicates with the same hostname. I need a query or even a rest api call that can get this information. thanks. Chris.

16015
christopherlecky
Byte
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Workflow Configuration

This is related to this Documentation: Adding a Configuration Value for a Workflow. Workflow Configuration is very useful in the following scenarios (copied from Documentation), Values apply to the workflow the majority of the times that the workflow runs. You do not want to redeploy the workflow when the values change (the workflow version is not updated). Actual use cases, if you're having very simple workflow dedicated to single task, you don't need to use Configuration, instead you can pass all parameters to run the workflow via workflow's Inputs. If you're having workflow for common purpose, like maintain multiple clients with common configuration between them, you should prepare single wofklow with Configuration.

742
Surendra Nadh Arla
Vaulter
O
Bit
OPadbergBit
asked in Developer Tools, Integration and Automation
Job Rest-API doesn't show Auxcopys anymore

we use the Rest API to retrieve various job information. We used "Job?completedJobLookupTime=86400" to show all backup jobs and AuxCopys for the last 7 days. But since we installed the 11.28.14 update, we don't get any auxcopys informations. Also if we don't set the filter "completedJobLookupTime" we get 2500 results but the past auxcopys are not shown either. We have now also installed the 11.28.19 update, but it did not fix the problem.The permissions for the user have not changed.We can reproduce the problem via API Explorer or Postman. The API documentation refers to a "JobFilter Parameter Values" list where auxcopys are still listed. https://documentation.commvault.com/v11/essential/47608_rest_api_get_job.html Are auxcopys no longer displayed via the Job Rest API?

1675
O
Bit
N
Byte
Nick Laflamme II
asked in Developer Tools, Integration and Automation
Example needed: QOPERATION EXECUTE within POST QCOMMAND built in PowerShell?

Can someone provide an example of invoking “qoperation execute” via a POST QCOMMAND call to the REST API? I’m trying to build the XML for the “qoperation execute” as a PowerShell variable (in a loop, updating backed on what we’re looping on), but since I’ve never done anything like this, I can’t tell why I’m getting an “internal error” response, apart from, “clearly I don’t know what I’m doing.” If I can see a successful example, I can see how different my attempt looks and hopefully adjust accordingly. Thanks,Nick Since someone is likely to ask: $napTime = "<?xml version=`"1.0`" encoding=`"UTF-8`"?><App_SetMediaAgentPropertiesReq> <mediaAgentInfo><mediaAgent mediaAgentName=`"$thisma`"/> <mediaAgentProps markMAOfflineForMaintenance=`"1`" enableMAAfterDelay=`"60`"/></mediaAgentInfo></App_SetMediaAgentPropertiesReq>" $takeNap = "$origin/Qcommand/qoperation%20execute -req $naptime" $a5 = Invoke-RestMethod -Uri $takeNap -Method Post -Headers $headers

4716
christopherlecky
Byte
B
Byte
benjaminasByte
asked in Developer Tools, Integration and Automation
Workflow to assign to schedule policy

Hi, maybe someone has already made a CV workflow to assign client to a schedule policy and are willing to share such workflow? I was looking for any xml option that I could run from client side with qcommands but could not find such thing for schedule policy associations… Thanks!

1904
Commvault Marcus
Vaulter
M
Byte
Marc St.Byte
asked in Developer Tools, Integration and Automation
Problem extracting the vmGUID in a Workflow using Javascript

Hi, I want to work with VMUtilities in Workflows. Therefore, I created a simple workflow to extract the vmGUID using RestAPI. The the first step created 2 Variables, on with the name of the VM and the other for my vShpere-Client: As the first activity I use HttpClient to get the client details including the vmGUID 1. Solution: In the next step I’m using the activity «PowerOn», insert the two variable and try to extract the vmGUID from previous output: To extract the vmGUID, I used the example I found in documentation and changed it to suite my needs. https://documentation.commvault.com/v11/essential/132060_specifying_script_to_retrieve_input_value_for_workflow_activity.html I get the following errors: org.jdom2.input.JDOMParseException: Error on line 2: Element type "vm" must be followed by either attribute specifications, ">" or "/>". VMOperationsHandler : [PowerOn (PowerOn_1)] ERROR: failed to encode xml 2. Solution: Then I thought I could put these lines into the “OnStart Script” of

1864
christopherlecky
Byte
J
Byte
Joel BatesByte
asked in Developer Tools, Integration and Automation
Fully automating client installs - assign storage policy & client group

Hello all! I am trying to simplify installing agents for DBA’s and other app teams. I have created custom packages that can run silently, but by default I cannot assign things like storage policy to the specific agent. For example, an MSSQL custom package will install but no storage policy is assigned. What I’d like to do: DBA takes a custom package, runs the installer in “silent install” mode, server registers to the commserve. Storage policy is assigned to the discovered DB instances Client computer group is assigned (which has a schedule connected to it) Ideally run a first full backup after install completes (that’s a low priority) Pulls latest client updates - maybe executes a workflow on itself? (I know I’m dreaming) Is there a way to customize the install.xml file in the installer? Has someone done this post-install with a qscript or other means? I am running 11.26.41 - and it seems some custom package options have gone away. Sorry, haven’t migrated to plans yet - but if this ca

6004
J
Byte
description of image

Popular tags

Badge winners

  • Contributor 1
    Putrahas earned the badge Contributor 1
  • Topic Starter 1
    Artihas earned the badge Topic Starter 1
  • Topic Starter 1
    fabrihas earned the badge Topic Starter 1
  • Topic Starter 1
    Putrahas earned the badge Topic Starter 1
  • Topic Starter 5
    Sougato Royhas earned the badge Topic Starter 5
Show all badges
Terms & ConditionsCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings