Skip to main content

Developer Tools, Integration and Automation

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

  • 481 Topics
  • 2,075 Replies
481 Topics
Anthony.Hodges
Commvault Certified Expert
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

5
Anthony.Hodges
Commvault Certified Expert
3 years ago
J
Byte
JNIZByte
asked in Developer Tools, Integration and Automation
Azure Immutable Blob Library - WORM applied without warning through workflow

Hi,I have another trouble with the Azure immutable blob library. I started a recommended workflow “ Enable WORM on Cloud Storage”. Because we have not the “IAM VM Role Assignment” authentication method(we have Access key), the workflow was not completed. But it set “WORM” option on the cloud copy without a warning. Now there are some “Index server backups” which will not expire. They cannot be deleted (WORM copy) and block a whole baseline in the cloud. Maybe I have to open a support ticket for it ? Because I had already similar problems with these Index server backups, maybe it would be better to save these backups in another “no WORM” storage policy ? (I guess restore of data could be possible without these index backups too - with some performance penalties necessary for rebuild of indexes (?))This is only a test storage policy with one client VM, but the customer plans to place  about 150TB to cloud. So “locked” data in the cloud could be costly.FYI see content of all relevant SP c

8
Mike Struening
Vaulter
3 years ago
B
Byte
BenjisByte
asked in Developer Tools, Integration and Automation
QCommand API response issues

Hi, I have a strange issue, I use same call for two different commcells. One commcell returns data as requested with no issues, second commcell simply returns very ‘informative’ error:Response code: <Response [200]>{'CVGui_GenericResp': {'@errorMessage': 'Operation failed', '@errorCode': '2'}}I am sending the following URL:http://mycommcell.NET:81/SearchSvc/CVWebService.svc/ExecuteQCommandcommand=qoperation execscript -sn QS_DataProtectionJobSummary -si '2020-1-1' -si '2021-3-16' Code snippet:  def commcell_authentication(self): """This method is used to get token for comcells""" for auth in self.cs_api: pwd = self.cs_creds['password'] pwd = bytes(pwd, encoding='utf8') pwd = str(base64.b64encode(pwd), encoding='utf-8') username = 'dbadmin\\' + self.cs_creds['username'] self.cs_login_api = self.cs_login_api.replace("<<username>>", username) self.cs_login_api = self.cs_login_api.replace("

9
Mike Struening
Vaulter
3 years ago
A
ArunKT
asked in Developer Tools, Integration and Automation
Need an API or CLI commands to update the path of the index cache in media agent.

Hello everyone, I am looking for an API call or CLI commands to update the path of the index cache in media agent. I am trying to write an Ansible playbook to update the index cache on commvault.  Any help is much appreciated. Thanks in advance. Arun KT

6
neuwiesener
Byte
3 years ago
Anthony.Hodges
Commvault Certified Expert
Anthony.HodgesCommvault Certified Expert
asked in Developer Tools, Integration and Automation
Looking for a faster API way to get clients configured with a specific Agent

Currently with the API at the moment if I want to find the registered clients with ‘SQL Server’, I need to iterate through the GET /Clients/ collection one by one for each clientproperties → client → idaList → idaEntity → appName.Is there a more efficient way? The GET /Agents/ command suite is not suitable in this instance because it requires passing the clientId.

2
Anthony.Hodges
Commvault Certified Expert
3 years ago
R
Byte
RolandByte
asked in Developer Tools, Integration and Automation
Dataagent Q_MSEXCH_DB and Q_MSEX2003_DB

Hello,I want to backup some exchange database 2016 from a workflow.I use at the workflow QCommands - Operation - Backup and see there are two kinds of dataagent’sQ_MSEX2K_DBQ_MSEX2003_DBAt the CommServe with qlist datagent -c Clientname we receive:Q_MSEXCH_DBWhen I use Q_MSEXCH_DB at the workflow I receive the following error:No enum constant workflow.types.cmd.DataAgent.Q_MSEXCH_DBWhen I use Q_MSEX2003_DB at the workflow the backup works.Can anyone tell me what is the difference between Q_MSEXCH_DB and Q_MSEX2003_DB and why I cannot use Q_MSEXCH_DB at the workflow?We use CV 11.21.20.regards Roland   

4
S
Vaulter
3 years ago
J
Byte
jmiamaralByte
asked in Developer Tools, Integration and Automation
File System agent install via answer file not assuming client hostname in Commvault

Hello, I am trying to install a file system agent in a Linux machine via answer file but after the installation is successfull, the client hostname on Commvault is the default of the machine and not the one i put on the xml. <clientEntity clientName='vm1"' hostName='vm1.bck.mngt.local"' /> I want it to appear with the domain .bck.mngt.local but instead appears with the machine default domain. Can anyone help?Thank you.

3
Edd Rimmer
Vaulter
3 years ago
E
Commvault Certified Expert
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
E
Commvault Certified Expert
3 years ago
J
Byte
JohnADPByte
asked in Developer Tools, Integration and Automation
Hidden API calls | GET Backupset Browse

Hello,I am currently working on a dedicated workflow to split the content of multiple subclients to have subclients with the same size.  To do that, I would like to perform a “Browse & Restore” on the backup set using API call to retrieve all the volume size and perform my distribution.I’ve tried to find something like GET /Subclient/{{id}}/Browse?path=%5C call for backup sets but I found nothing.I tried to perform a GET /Subclient/{{id}}/Browse?path=%5C but the returned status code is 400. Maybe you will be able to give me a workaround or inform me about hidden API calls? Thank you in advance for your answers.

2
J
Byte
3 years ago
Anthony.Hodges
Commvault Certified Expert
Anthony.HodgesCommvault Certified Expert
asked in Developer Tools, Integration and Automation
Get successful/skipped/failed Mailboxes count for a JobID via API?

Hello, is it possible possible to programmatically get the number successful/skipped/failed (V2) User Mailboxes count for a JobID?  Get-CVJob returns the successful/skipped/failed messages, but not mailboxes.

1
Anthony.Hodges
Commvault Certified Expert
3 years ago
A
Byte
AnujByte
asked in Developer Tools, Integration and Automation
As Built Guide

Do anyone know if this As Built Guide only accessible to CV SAM? I was trying to have one, but I do not see it in webconsole even after adding Additional setting under commcell property (as said in below link).https://documentation.commvault.com/commvault/v11/article?p=37985.htm Thanks, Anuj

6
A
Byte
3 years ago
P
Commvault Certified Expert
PatrikCommvault Certified Expert
asked in Developer Tools, Integration and Automation
Teradata Workflow update from arcmain to DSA

Hi, We are currently implementing Commvault, transferring from TSM, and Teradata is part of this. The plan was to use the Commvault Workflow integrating with the arcmain utility.arcmain is going end of life and customer will update to the new dsa integration for exporting (backing up) data. Is there any plans from Commvault to provide an updated workflow for this any time soon./Patrik

6
S
Vaulter
3 years ago
Y
Bit
yirmioBit
asked in Developer Tools, Integration and Automation
Auto delete/deactivate clients

Hi all,is there any way to auto delete or deactivate clients?i can group them in smart groups based on specific criteria like owner AD group membership but don't no how to run automatic auctions on them. Thanks!

1
S
Vaulter
3 years ago
DaysAndCycles
Byte
DaysAndCycles
asked in Developer Tools, Integration and Automation
Schedule Policy Randomization?

Commvault 11.20.   We’ve been on Commvault for a few years, but our legacy backup product was Tivoli Storage Manager/Spectrum Protect.     In TSM, there was a concept called scheduling randomization which enabled you to assign many clients to one schedule, and you could specify a period in which the various clients would begin their backup operation pseudo-randomly. (Ex. Schedule runs at 22:00. The period is set to 1 hour.  There are 10 clients in the schedule.  The 10 clients start their backup operation at various times in the period between 22:00 and 23:00)  This enabled you to manage fewer schedules, while spreading backup and client infrastructure resource utilization across a window.  I can’t find any similar concept with Commvault, but I’d figure I’d ask the community.  Thanks!mikeymac

7
H
Vaulter
3 years ago
M
Bit
mhamelBit
asked in Developer Tools, Integration and Automation
Unable To restore filesystems - cvpysdk - Python

Hello,I have some trouble to restore filesystems to a Storage array using the cvpysdk python library, the restore from the Commcell works perfectly.The commands that i’m using to do a restore is bellow:commcell = Commcell('My_commcell', commcell_login ,commcell_password)client = commcell.clients.get('My_storage_array')agent = client.agents.get('My_Agent')backupset = agent.backupsets.get('My_Backupset')backupset.subclients.add("backup_tmp", storage_policy="My_storage_policy")subclient = backupset.subclients.get("backup_tmp")subclient.network_share_auto_mount = Truesubclient.content = ["My_storage_array:/My_Filesystem"]subclient.enable_backup()job_backup = subclient_fs.backup(backup_level='Full')job_finished =job_backup.wait_for_completion()paths_retore = "/My_storage_array/My_Filesystem"job_restore = subclient_fs.restore_out_of_place(client="My_Client", paths=[paths_retore],destination_path="/My_storage_array")the job is always pending and it detectes the number of files and folders to

8
A
Vaulter
3 years ago
B
Byte
BenjisByte
asked in Developer Tools, Integration and Automation
Did FR20 had API changes??

We have a situation and/or I rather have a question in relations to FR20. After upgrading one of our commcells to FR20 with SP 32..half of our automation which is based on API calls started to fail and stopped working, meaning that some queries are passing through and API call works, but most of them do not work. I’ve tried to look through release notes of FR20 but did not find anything about such scenario and did not find anything in known issues of it. Anyone aware of any similar cases where after upgrade, the API calls stopped working and have there been any changes to API itself, possibly it’s structure or how it is called?. I do have a suspicion that it might possibly be due to different versions of commcells? Because that upgraded comcell is impacting some queries to non-upgraded commcell as well.Example: Variable job_request is ‘http://comcell:81/SearchSvc/CVWebService.svc/ExecuteQCommand’so it sends command in variable data "command=qoperation execscript -sn QS_DataProtectionJo

8
S
Vaulter
3 years ago
S
Byte
Stefan VollrathByte
asked in Developer Tools, Integration and Automation
Workflow Script API

Documentation for Workflows mentions some Functions for Java to interact with or access other Resources during execution https://documentation.commvault.com/commvault/v11_sp20/article?p=49729.htm.But alone from browsing through the other Pages it gets clear there are way more options like activity.exitCode or workflow.setFailed().Dissecting built in Workflows reveals other treasures like csdb.execute(“sqlquery”).Is there a complete list of all available Functions and how/when to use them? Trial-and-Error and Reverse-Engineering by Customers seems error-prone and inefficient.

19
christopherlecky
Byte
2 years ago
S
Byte
Stefan VollrathByte
asked in Developer Tools, Integration and Automation
Workflow Error Handling

Hi AllI’m trying to come up with a kind a universal Error Handling for Workflows, in particular for ExecuteCommand Activities. Often enough they throw an exitCode > 0 and some commandOutput that may help the User.BUT then there are the times where exitCode is 0 but the outputXml states an error-condition. Tried to check and handle that via OnComplete Scripts.This is where I am stuck. Sometimes the response is generic and has an errorCode and errorString Element to parse, sometimes the errorString is missing, sometimes errorCode is 0 but an warningCode Element is added, but that isn’t returned all the time. Sometimes it’s a longer App_***Response Reply with the issues tucked in somewhere.Anybody know of a generic way to parse through all possible scenarios (mentioned or unmentioned) to catch issues right away, terminate execution and return useful consistent error Messages to User?Thanks,Stefan

4
C
Vaulter
3 years ago
M
Byte
Marcel GeisenByte
asked in Developer Tools, Integration and Automation
Automatic Installation AD iData Agent with install.xml - Password hash (enyryption)

We do automatic rollouts of Active Directory in Azure for our Customers with Ansible.We want to install the AD iData Agent with the Unattend Package and Custom “install.xml” File.These we are already doing successful for MA, Proxy and Restore Agent.If you do Unattend AD Installation in the XML is PW for AD Agent needed. But it is expected a hash, but i cannot find what hash (for the PW) the Installer expect. Normal PW is not working and sha-256 hash of PW is not working, too.This is the line in XML:<activeDirectory>               <userAccount password="3820c5c6992b6774aced93ecd88e04e35b4398d99e3f0a7d8"          domainName="q1xyz.local" userName="svc-adbackup" /></activeDirectory>So it would be important to know with what the setup when you create the package the PW encryptes, because during automatic rollout we get it from our central key Vault during installation. 

19
Juergen
Byte
3 years ago
Mohit Chordia
Byte
Mohit ChordiaByte
asked in Developer Tools, Integration and Automation
Rest API call to update sub-client content of virtual sever sub-client

Can anyone share the REST API call to update subclient content of virtual sever sub-client  ?Also what does this error means - Func[addVMToSubClient] Line[629]: status=401 content=u'<Api_GenericResp errorMessage="Access denied" errorCode="5" />'INFO:api.v1.services:status=401 content=u'<Api_GenericResp errorMessage="Access denied" errorCode="5" />'

12
Jaime Ortiz
Bit
3 years ago
J
Bit
JMH_MLBit
asked in Developer Tools, Integration and Automation
Unexpected output from Get-CVJob function if the -ClientName parameter is a non-existent client name

I’m trying to use the CommVault powershell module to work with the API and integrate our backups with monitoring, so that our users will be able to  see monitori ng and backup stats at a glance. Should be easy enough to show jobs, but the powershell  Get-CVJob function is broken. I had some help previously in the forum, and the broken bit was verified and posted to the gitHub powershell for CommVault projects, but I haven’t seen any movement since. Does anybody know how to fix this issue or what kind of timeframe I am working with to get this module fixed? 

5
Y
Vaulter
3 years ago
C
Byte
christopheByte
asked in Developer Tools, Integration and Automation
REST API command plan details

Hi,i need help with the plan details command API : /Plan/{planID}when running this command i can’t find the retention criteria for a specific plan in the response.please advice for any help on this commandkind regards,  

4
C
Byte
3 years ago
M
Bit
mhamelBit
asked in Developer Tools, Integration and Automation
Unable to backup a filesystem (subclient content issue) - cvpysdk - Python

Hello,I'm trying to backup a filesystem from a storage array, I noticed that the update of the subclient content using this syntax :subclient.content = ["My_storage_array:/My_Filesystem"]This syntax is not executed correctly, we can write anything in the content even if it is not present in the storage array, no validation is done by commvault.The output of the backup job fails and returns the following error:"File system scan failed - there is nothing to back up. A possible cause is that none of the subclient contents exist.".the code that i'm using to do my backup is bellow :commcell = Commcell('My_commcell', commcell_login ,commcell_password)client = commcell.clients.get('My_storage_array')agent = client.agents.get('My_Agent')backupset = agent.backupsets.get('My_Backupset')backupset.subclients.add("backup_tmp", storage_policy="My_storage_policy")subclient = backupset.subclients.get("backup_tmp")subclient.content = ["My_storage_array:/My_Filesystem"]subclient.enable_backup()job_backu

10
M
Bit
3 years ago
C
Bit
Chris MBit
posted in Developer Tools, Integration and Automation
Automated backup/restore testing of a MSSQL Database

I currently have a workflow setup to do a weekly backup/restore of some Windows filesystems, which works great.  Is it possible to do the same thing with a Workflow and backup/restore a single Microsoft SQL database (out of place)? I cloned the workflow I have for the Windows files and was trying to modify it for MSSQL.  It looks like I can change the agent type to MSSQL and even set an instance name.  However, I’m not sure how to define a specific database.  As I’m typing, I just thought of maybe a possible solution?  Maybe I need to create a new backup set with the database(s) I want to test? Any recommendations on the best way to automate these backups/restores?

4
C
Bit
3 years ago
dude
Byte
dudeByte
asked in Developer Tools, Integration and Automation
vRealize Appliance Automation 8.0 Backup

Wanting to get a confirmation. I see that Vmware has a very specific requirement to backupvRealize Automation 8.0 described below;https://docs.vmware.com/en/vRealize-Suite/2019/vrealize-suite-2019-backup-and-restore-avamar/GUID-49FA9AB6-2A69-4F41-80E1-495447F4D6FC.htmlDoes Commvault has the ability to perform those tasks? I looked at the docs and could not find the details or info related to this.Thanks

4
R
Vaulter
3 years ago

Badge winners

Show all badges
Terms & ConditionsCookie settings