Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 545 Topics
  • 2,244 Replies
546 Topics
B
Byte
benjaminasByte
asked in Developer Tools, Integration and Automation
API to delete client

Hi,I am looking into https://documentation.commvault.com/v11/essential/45929_rest_api_delete_client.htmlto delete clients. It is mentioned in the document that there is setting called ‘forceDelete’ - does anybody know how to use it in the actual API call? I’ve tried to add it in the URL itself, in the headers, in the payload. Does not work.

1285
B
Byte
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
Is there a CV Rest API to get the properties of details of a Scheduled REPORT

I have some customized reports, which are scheduled to run once in 90 days, i would like to update certain properties of that schedule once in a while using workflowIt would be easy to do that if I do an GET api on the report schedule using the report schedule nameand using that i would update the properties that I want to. I’m unable to find any API specific to report scheduling. https://api.commvault.com/#416fa5bf-c150-4cbd-8f05-4bdc867d2719 is it possible to Get the details of a specific scheduled REPORT orhow do i list the properties of a particular REPORT Schedule orhow do i find the taskID for a REPORT Schedule. https://api.commvault.com/#8de6b19c-2815-4d50-b89e-99654a090db0 

1279
A
Byte
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Create custom alert for long-running jobs

Per recent corporate policy to provide codes like this via software store, I removed this post.Thank you for your attention.

1300
T
Vaulter
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Detect longer jobs than usual

There’s some alert configuration to detect longer jobs than usual, also you can check the jobs the same condition in Job Controller (small icon would appear).Still there’s not so easy way to detect the delay with some sort of custom criteria, like for specific client, duration which would take double or three times longer as usual, etc. This query is intended to address some requests, listing up the difference between running jobs durations and “average” per subclient and backup level.use commservset transaction isolation level read uncommittedselect bkji.jobId ,bkji.applicationId ,apc.name as 'clientname' ,apap.subclientName ,bkji.bkpLevel ,1.0 * (dbo.GetUnixTime(GETUTCDATE()) - ji.jobStartTime) / grp.avg_duration as 'exceeded' ,grp.avg_duration ,grp.count_jobfrom jmbkpjobinfo bkjiinner join JMJobInfo ji on bkji.jobid = ji.jobidinner join APP_Application apap on apap.id = bkji.applicationIdinner join APP_Client apc on apc.id = apap.clientIdinner join ( select appId, bkpLevel, avg(du

780
T
Vaulter
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Retrieve all Job Phase failures

An MSP customer, there're a lot of alerts which send out mails whenever any of them detects phase errors, but sometimes the job itself got succeeded, also in this case it's quite difficult to look into the phase errors since the information would be scattered at detailed job results, events, alerts, etc. This query is created by a customer's requiest who want to track job **phase** errors at once, combining many information from various tables including event or error parameters.So some verbose informations there, but you can easily detect when the phase failures happened, like one of MAs is having connection issue and affecting mlutiple jobs. Here's the query, you can run it on CommServ DB, or creating customer reports on your Metrics Reporting could make your life easier.use commservSET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;declare @tmp table ( jobid int ,starttime bigint ,endtime bigint ,messageid int ,occurred nvarchar(max) ,message nvarchar(max))insert into @tmpselect f.jo

970
T
Vaulter
B
brucquat
asked in Developer Tools, Integration and Automation
Which port to open in the firewall to use Commvault API?

Hi,An external application wants to use the Commvault API.There is a firewall between the machine where the external application resides and the Commserve host.I would like to know which ports, protocol, direction to open between the Commserve & VM containing the external applications.I cannot find the information in the Commvault documentation.Many thanks 

4583
Graham Swift
Vaulter
C
Bit
Charles ChengBit
asked in Developer Tools, Integration and Automation
Commvault APIs are inconsistent when moving database across subclients

Hi there, not sure if anyone has seen the same issue before. Here is what we do:We need to suspend backup for one Sybase database because the database needs to execute its own house keeping like re-index etc. We are trying to automate this using Commvault API: We receive the request to suspend a database(db1) from instance(asset1). Our program will loop through the asset1 and see where db1 is and found it is in subclient “sub1”. We will then create a “dynamic1” subclient Delete the “db1” from “sub1” subclient. Add “db1” to “dynamic1” subclientNow the house keeping is done and we need to resume the backup of db1:We received the resume request Loop through Commvault server where db1 is through API We found db1 is in default subclient alreayNow the adhoc Full backUp is called immediately because the house keeping has change the database structure and we don’t have a base-lineAdhoc backup request is received Loop through asset1 and see where db1 is and found it is in subclient “default” Cr

966
christopherlecky
Byte
D
Bit
DarkKnightBit
asked in Developer Tools, Integration and Automation
API Token Authentication

Is there any way we access Rest API without token ? because we just run the script on the local commvault computer and we don't want user + password in the plaintext ?Thank you

63413
christopherlecky
Byte
P
Byte
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. 

3922
C
Byte
S
Byte
Scott StocktonByte
asked in Developer Tools, Integration and Automation
Scripted way to restore multiple on-prem AD Accounts

I have a list of many users to restore and would prefer not to have to go click happy to restore the users.Ideally something simple like powershell and a foreach loop for the usernames.The rest api would work to but I saw no reference in any of the tools to restore AD Objects? Please Advise.

1122
Graham Swift
Vaulter
J
Byte
Just LearningByte
asked in Developer Tools, Integration and Automation
API, JSON Code for removing Synthetic Full Schedule

Hello everyone, We are creating a Server Backup Plan in CommandCenter that creates a plan and backup destination (storage pools for primary copy and secondary copy) and schedules. We select the schedule for full and incremental and plan creation completes successfully. We can copy the API code of the above tasks and see the JSON file that creates then we programmatically create backup plans in batch via PowerShell. When we review the schedule in Java client. We see that it creates Synthetic Full schedule as well but this is not visible in commandcenter. We cannot use Synthetic Full in our environment due to storage limitation.What do we need to add or remove to the JSON file command center creates for PLAN, and remove the Synthetic Full in the creation? I am attaching a sample JSON file. We would to see a sample JSON file that creates the plan and removes Synthetic Full schedule. JSON File: $body = @"{  "planName": "$planName",  "backupDestinations": [    {      "backupDestinationName"

844
J
Byte
L
Byte
LucienByte
asked in Developer Tools, Integration and Automation
Workflow: Clientlist sorting

When creating an input for a Workflow to select a client, I use the following(Inputs-->Customize)Unfortunately the clientlist is sorted on client-id, not on client-name.Anyone an idea to change to sortfield ?

352
chrisknows
Byte
D
Byte
DoRayByte
asked in Developer Tools, Integration and Automation
Change CVClientName with Powershell API

Hello, I have tried the Powershell CLI to rename a client name as described in the documentation:https://documentation.commvault.com/2022e/essential/101881_set_cvclient.htmlThere is no error, but nothing is changing:errorCode entity                                                             --------- ------                                                                     0 @{clientId=925; clientName=OldClientname; instanceId=160; _type_=3}I have seen, that there is also an open issue at github for this:https://github.com/Commvault/CVPowershellSDK/issues/30When I try the WhatIf flag I get the same error as shown at githubINFO: Set-CVClient: set client properties request failed for group [clientname]"Is it working for someone or is someone working on that issue?Thank you

1362
D
Byte
C
Bit
ClaesBit
asked in Developer Tools, Integration and Automation
powershell api - getting data not working - etc get-cvsqlinstance data

Hello All,i’m facing a issue where commands like get-cvsqlinstance -name “xxxx\xxx” is not working. Going through documentation from CV describes that i’m doing the correct thing.although still getting internal error 500powershell error :ValidateResponse : Status: ProtocolErrorMessage: The remote server returned an error: (500) Internal Server Error.ErrorMessage: RecommendedAction: At C:\Users\nnit-ceen.BCK\Desktop\CVPowershellSDK-master\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 any clue the above?

2585
S
Vaulter
J
Byte
Just LearningByte
asked in Developer Tools, Integration and Automation
Script to add VMs to Subclient

Hello everyone,I am looking for a script to add Vmware VMs to subclient.  I have been poking around Powershell SDK/Commands but i am not successful so far with the latest Powershell v32 SDK Eventually i need to feed VM Names from csv file and loop through but for now just testing with a single VM. Add-CVVirtualMachine -ClientName myVCenter -SubclientName z_Subclient_0400PM -EntityType VM -Entity my-vmname Getting following error: “Get-CVVirtualMachine : A parameter cannot be found that matches parameter name 'Name'.At C:\Program Files\WindowsPowerShell\Modules\CommvaultPowerShell\0.2.11\custom\oldsdk\Add-CVVirtualMachine.ps1:166 char:61+ ...                         $vmProps = Get-CVVirtualMachine -Name $entity ...+                                                             ~~~~~    + CategoryInfo          : InvalidArgument: (:) [Get-CVVirtualMachine], ParameterBindingException    + FullyQualifiedErrorId : NamedParameterNotFound,Get-CVVirtualMachine “ Thanks, 

1474
J
Vaulter
V
Byte
virgilByte
asked in Developer Tools, Integration and Automation
Retrieve Content of subclient by powershell

Hi teams,i want to retrieve the content of this subclient by powershell. try with “Get-CVSubClient.Content.content” but no way ( )Help AppreciateThanks

1553
V
Byte
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Server Groups based on tag value

I created a tag set in order to be able to create groups based their tag value, is this possible? I cannot seem to see a way to do it.Clearly I am not getting the logic behind the tagging system.

2179
Onno van den Berg
Commvault Certified Expert
D
Byte
Daniel -Byte
asked in Developer Tools, Integration and Automation
Dev tools : Report Reference - for syntax and programming language

Hello, Someone knows a Manual  with the commands for create reports ? Thxs,Daniel

273
O
Vaulter
Henke
Byte
HenkeByte
asked in Developer Tools, Integration and Automation
Generate report and send with email in Workflow

Hello,I’ve tried to create a workflow that:run a saved report sends that report in a emailI have little experiance with workflows and I haven’t been successfull in my tries. I don’t even know if it is possible to do.Is there anyone that have done it or know how it can be accomplished? Attached is a view of my current tries, though not successful. Thanks for any help.

2405
A
Byte
Robert Horowski
Commvault Certified Expert
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

3667
Robert Horowski
Commvault Certified Expert
J
Byte
JanRByte
asked in Developer Tools, Integration and Automation
Backup specific subclients with workflow

Hi,I am a very beginner with workflows and I am facing my first problem:I want to run a backup for all subclients for a specific client beside a subclient “test” via workflow.So in this example at the beginning of that workflow I manually choose a client.This client has serveral subclients (e.g. “data1”, “data2” and “test”).The discover of DataAgent, BackupSet and all Subclients works fine, but with which activity in the Workflow Designer can I exclude the pattern “test” in the list of subclients?I’ve tried the “RemoveFromList” but without any success (or maybe I used it the wrong way).Do you have a clue?BR

2055
Scott Moseman
Vaulter
M
Bit
mjcBit
asked in Developer Tools, Integration and Automation
Browse all versions of a guest file for a specific VM with API DoBrowse

Hello,I’m used to use your API, but in this case, I can't get what I want 😪Use case : Before perform a single file restore operation, I need to see all versions of a guest file for a VM backuped without agent (agentless) .I use the DoBrowse API, but I have no usable results.{{ServerUrl}}/DoBrowse (POST) with body:}{ "opType": 0, "queries": [ { "type": 1, "queryId": "countQuery", "aggrParam": { "field": 0, "aggrType": 4 } }, { "type": 4, "queryId": "dataQuery", "dataParam": { "sortParam": { "ascending": true, "sortBy": [ 38, 0 ] }, "paging": { "firstNode": 0, "pageSize": 15, "skipNode": 0 } } } ], "mode": { "mode": 1 }, "paths": [ { "path": "\\50003816-5EF5-1648-8ED1-0FD0B08F024C\\var\\log\\cron" } ], "options": { "showDeletedFiles": true, "restoreIndex": true }, "entity": { "subclientI

1382
M
Bit
V
Byte
VinhByte
asked in Developer Tools, Integration and Automation
SDK Pyhton : Backup Vm(indexV2) using VMGuid

Hi,I'm trying to save a Vm in V2 indexing by the VmGuid. I can't find a samples.The only article is the one :Samples for the Developer SDK for Python (commvault.com)Can you Help me please ?Thanks 

843
V
Byte
P
Philippe Combot
asked in Developer Tools, Integration and Automation
CommVault ansible VMs

Hello everyone:I'm having some problems finalizing my scripts.Someone already made a script to create VMs on vmware?Of course I removed the login and mdp of my vars to show you.The beginning of my script works for the commserv connection.It is the creation of the VMs that does not work.Can someone help me ?

962
P
S
Byte
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

3542
S
Byte
description of image

Badge winners

Show all badges
Terms & ConditionsCookie settings