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
J
Byte
JohnADPByte
asked in Developer Tools, Integration and Automation
Alert Notification: Run Command for Powershell script ?

Hello, I would like to run a script for each time that a backup fails to create a support ticket. The alert has been configured and the Powershell script has been tested and validated and works using the following command on the Powershell window: powershell.exe create_ticket.ps1 -s “Title” -d “Description” I would like Commvault to launch the script with its own tokens such as <CLIENT NAME>. Using the documentation ressource “Setting Up Command Line Alert Notifications” (source link: https://documentation.commvault.com/commvault/v11/article?p=5401.htm ), I configured the Run Command fields as following: Command executable location: C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe Arguments: /C powershell.exe C:\tmp\create_ticket.ps1 -s "Backup job failed for <CLIENT NAME>" -d "`nAlert Title: <ALERT NAME>`r`nTrigger Time: <TIME>” Unfortunately this doesn’t work. Do you have any advises? Thank you for your answers. Best regards, John

12404
Damian Andre
Vaulter
J
Byte
JohnADPByte
asked in Developer Tools, Integration and Automation
How to search files without path with qCommands ?

Hello, I tried to perform a find files through Command Line for NDMP client to retrieve all version of a file only with his name (just like the Find feature with the Commcell Console). Using the following documentation link “https://documentation.commvault.com/commvault/v11/article?p=45143.htm”, I made those XML files: ------------------------------------------------------------------------------------------------------------------------------------- <databrowse_BrowseRequest opType="Find"> <entity _type_="0" appName="NDMP" backupsetName="defaultBackupSet" clientName="NAS" subclientName="default"/> <paging pageSize="4294967295" skipNode="0"/> <mode mode="2"/> <paths path="\**\*\file.txt" /> <queries type="DATA"/></databrowse_BrowseRequest> ------------------------------------------------------------------------------------------------------------------------------------- <databrowse_BrowseRequest opType="Versions"> <entity _type_="0" appName="NDMP" backupsetName="defaultBackupSet" clie

4024
J
Byte
Juergen
Byte
JuergenByte
asked in Developer Tools, Integration and Automation
Automatic Client Install with default.xml - Password hash (enyryption)

Hello, I want automate my installations, for this I want to set the password hash set into the default.xml during the installation face. I found all things to write for each system the individual default.xml, the only what I am missing is the password hash. <userAccountToLogin domainName="" encPassword="" password="" userName="" /> I use ansible for deploying Unix machines, with a python script to configure in the second step Storagepolicy and the right schedule policy, via Rest API regards Juergen

6786
Mike Struening
Vaulter
Juergen
Byte
JuergenByte
asked in Developer Tools, Integration and Automation
Trigger external script on failing Jobs

Hello, I am looking for a solution which can trigger a script outside from Commvault when ever a backup job is failing. The script needs only give over the failing JOBID. Plan is to automate a quick analyze of the failure and trigger the right team to fix the issue without manual invention. thanks in advance for your suggestions. regards Jürgen

3264
B
Vaulter
M
Byte
Mike London UKByte
asked in Developer Tools, Integration and Automation
How can I get O365 Licensed user list via PowerShell?

Does anyone have a PowerShell command that will retrieve the users that license summary report would report on? I’ve used Get-SPO -Limit All before to get a list of users but this seems to get more users than CV reports on. I want to extract what CV would report on before implementing backups (I have an account to be able to do this) to ensure the correct number of licenses are purchased. I have seen reference to getting the list in the logs (when watching/investigating issues) but haven’t seen the command used.

4304
M
Byte
B
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?

2931
MFasulo
Vaulter
ApK
Byte
ApKByte
asked in Developer Tools, Integration and Automation
Install Windows Updates Workflow

Hi all. Any one who can explain how the Install Windows Updates Workflow works? I have a MediaAgent which does not have internet access or access to any other windows update service, can I use the workflow to update this MediaAgent with windows updates, or does it need to have access to the internet to get this workflow to work? Thanks -Anders

4494
ApK
Byte
Juergen
Byte
JuergenByte
asked in Developer Tools, Integration and Automation
Issues with rest API Command: POST Install Client

I have following problem when I try a more complex password with chars like ‘#~’ I got error: Request body is empty or format is invalid. If I try a simply password like the sample :”cXE=” it work well. I use V11SP20.40 thanks. Regards Jürgen

6166
S
Vaulter
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("<<password>>", pwd) response = requests.post(auth['url'] + 'Login', data = self.cs_login_api) if re

5059
Mike Struening
Vaulter
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.

64319
Juergen
Byte
Graham Swift
Vaulter
Graham SwiftVaulter
posted in Developer Tools, Integration and Automation
Anyone using Automation using the API?

Hello all, First off a disclaimer - I work as a TAM for Commvault… Over the last year or so I have started to get more questions from my customers about using APIs to help automate common tasks or far more complex integrations. I am just wondering if you are doing the same yourself and curious to see how you are finding it and if you have any questions or feedback that could be useful for others in the community to learn from.

6309
Onno van den Berg
Commvault Certified Expert
K
Bit
kengBit
asked in Developer Tools, Integration and Automation
HTTP-Client Custom activity

I am attempting to create a workflow to disable snmp monitoring on a particular alert. I have successfully used the http-client custom activity to toggle the alert enable/disable. My issue is that I am attempting to email the http response from the activity, but I cannot figure out how to pass the response from the activity to the next downstream activity. the docs say… “7. Click the Outputs to retrieve the output from the XML operation activity...” Anybody have any insight or example that utilize the http-client activity in a multistep workflow? Thanks, Ken

934
Mike Struening
Vaulter
L
Bit
LLLBit
asked in Developer Tools, Integration and Automation
Script to Modify Subclient

Hello Is it possible to modify subclient using command line/powershell? The backup content name changes every day and i would like a way to update the subclient content automatically without me having to upgrade the file to backup. We are running commvault v11.22.13

6103
Damian Andre
Vaulter
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\performSearch C:\Program Files\Commvault\ContentStore\WebServerCore\performSearch\web.config C:\Program Files\Commvault\ContentStore\CVSearchService\CVWebService.svc\performSearch C:\Program Files\Commvault\ContentStore\CVSearchService\CVWebService.svc\performSearch\web.config Anyone else have the same problem

2675
Anthony.Hodges
Commvault Certified Expert
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

3916
S
Vaulter
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’s Q_MSEX2K_DB Q_MSEX2003_DB At the CommServe with qlist datagent -c Clientname we receive:Q_MSEXCH_DB When I use Q_MSEXCH_DB at the workflow I receive the following error:No enum constant workflow.types.cmd.DataAgent.Q_MSEXCH_DB When 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

904
S
Vaulter
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

1606
neuwiesener
Byte
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

7528
Mike Struening
Vaulter
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.

852
Anthony.Hodges
Commvault Certified Expert
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.

4143
Edd Rimmer
Vaulter
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!

3243
E
Commvault Certified Expert
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.

1132
J
Byte
A
Byte
Abdul WajidByte
asked in Developer Tools, Integration and Automation
Commvault PowerShell Module Dead Slow

Hi Everyone I have been trying to get my head around Commvault’s PowerShell module and it runs so slow, not sure why. Has anyone else has faced the same issue? Below script returned 3676 objects and it took more than two hours: Get-Date$clients = Get-CVClient$subClientObjs = @()foreach ($client in $clients){ $subClients = Get-CVSubclient -ClientName $client.clientName -AllProperties foreach ($subClient in $subClients){ $subClientObj = [PSCustomObject]@{ 'clientName' = $subClient.subClientProperties.subClientEntity.clientName 'subClientName'= $subClient.subClientProperties.subClientEntity.subclientName 'backupSetName' = $subClient.subClientProperties.subClientEntity.backupsetName 'clientType' = $subClient.subClientProperties.subClientEntity.appName 'clientInstanceName' = $subClient.subClientProperties.subClientEntity.instanceName 'vmContents' = $subClient.subClientProperties.vmContent.children.displayName -join "`n" 'vmFilters' = $subClient.subClientProperties.vmFilter.children.displayN

40812
Y
Vaulter
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?

2225
Y
Vaulter
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?

38084
C
Bit
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