Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 546 Topics
  • 2,250 Replies
547 Topics
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

69364
Onno van den Berg
Commvault Certified Expert
U
Byte
uchenna kanuByte
asked in Developer Tools, Integration and Automation
GETTING STARTED WITH ANSIBLE AUTOMATION ON COMMVAULT

Hello Community, How do I get started with automation on commvault?What are the pre-requisites and basics steps to installation?For those using Ansible to autmoate on commvault is this preferable than performing operation directly from the commcell console?

41674
Onno van den Berg
Commvault Certified Expert
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?

38444
C
Bit
Mohit Chordia
Byte
Mohit ChordiaByte
asked in Developer Tools, Integration and Automation
Automate Commvault agent installation and Configuration

We are looking to automate Commvault IDA agents Installation and client settings configuration such as encryption, dedupe , storage policy , filters , schedules , database subclient settings such as oracle home, path etc. .Does anyone has custom workflows deployed for agent installation and client configuration ? if yes please share .Also , what is recommended way of achieving this ?Is it possible to achieve 100% configuration for client through RestAPI ? 

303412
Onno van den Berg
Commvault Certified Expert
B
Byte
BenjisByte
posted in Developer Tools, Integration and Automation
Workflow to resubmit failed job with particular failure reason

Hi CVcommunity, I do have a question and maybe some of you could point to what first steps should be taken to perform the following: We have backup jobs tha are failing with error codes such as ‘Waiting for services to come online’, ‘Error encountered when closing virtual device. Please see SQL server vdi.log for more details’ and etc. - Most of those jobs usually are fixed by simply resubmitting the job or resubmitting it after restarting client services….Is there an option that Commcell could run a workflow itself when job fails with such failure reason?Workflow should restart client services and resubmit the job.  

26358
A
Vaulter
J
Bit
Juan-Pierre PanainoBit
asked in Developer Tools, Integration and Automation
Problem When opening Admin Console

Good Day, I have noticed that when Connecting to the Admin Console it throws me a bunch of errors and it displays this “Unable to load the data from server.” Also when trying to access he Console it gives me this web page “HTTP Error 404. The requested resource is not found.” All services are started and i have rebooted the server aswell.    

26144
Mike Struening
Vaulter
K
Bit
kengBit
asked in Developer Tools, Integration and Automation
Commvault Ansible

Anyone using CVPySDK and Ansible?  I am unable to get it to function.  I have pip installed and can run the commcell functions from within the python interpreter.When I attempt to use it in a playbook, I get an error… ERROR! couldn’t resolve module/action ‘commvault’ Ansible 2.10.7python 3.6.8. Ken

260822
K
Vaulter
C
Byte
christopheByte
asked in Developer Tools, Integration and Automation
use RESTAPI in a powershell script

Hi All,i need help to create a powershell script using REST API command.i don’t found a lot of documentation for the specific use of REST API in powershell.in the community in have found a sample for POST LOGIN $headers = @{}$headers.add("Accept", "application/json")$headers.add("Content-Type","application/json")$username = "user"$password = "passwordtoencode"$encodePassword = [convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes($password))$body = @{username=$username;password=$encodePassword;}$response = Invoke-RestMethod 'http://hostname/webconsole/api/Login' -Method POST -Headers $headers -Body $($body | ConvertTo-Json )$responseBut somenone have sample for all kind of REST API sample ?Thank in advanceChristophe

25202
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?

25122
Onno van den Berg
Commvault Certified Expert
D
Byte
DimitriByte
asked in Developer Tools, Integration and Automation
REST API: Authentication

Hi guys! I’m completely new to REST API.I just downloaded the Postman CommVault Rest API Workspace and now I’m trying to start with the basic: authentication. But let’s get one step back to the Swagger UI. Just to exclude any wrong configuration inside Postman. I created a new test user inside the CommCell. This user is member of “master” group, so permissions should not be a problem. If I visit the Swagger UI (https://<webserver>/webconsole/sandbox/apiexplorer) and try the POST Login with this test user I get the message: errLogMessage": "Username/Password are incorrect"Well I’m pretty sure the username and the password is correct. I also tried to encode the password with Base64, but get the same error message. Other users also didn’t work. Also I can see a “Authorize” button on the top right corner. When I click on this button I can provide a Authtoken. But where I get this from? Obviously I’m doing something wrong here. Please tell me what. 

24608
R
Bit
D
Byte
drPhilByte
asked in Developer Tools, Integration and Automation
Commvault and Powershell scripts executed remotely

Hi there,My colleague is facing the following issue. He wants to monitor Commvault using scripts. With my help he has installed powershell modul into Commvault. Then, we have executed the script from the Windows server (locally) and everything works well. However, we are not able to execute powershell script remotely - from the diferrent machine than Commvault is running. Once he executes scripts from Zabbix server (remotely) the following errors appear:ValidateResponse :Status:Message: The response content cannot be parsed because the Internet Explorer engine is not available, or InternetExplorer's first-launch configuration is not complete. Specify the UseBasicParsing parameter and try again.ErrorMessage:RecommendedAction:At C:\Program Files\WindowsPowerShell\Modules\Commvault.RESTSess ion\2.0.21\Commvault.RESTSession.psm1:560 char:13+ ValidateResponse $response $output $ValidateProperty+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~+ CategoryInfo : NotSpecified: (​ [Write-Er

22223
D
Byte
H
Vaulter
HarshaVaulter
asked in Developer Tools, Integration and Automation
File Activity Anomaly - Threshold values

Hi Team,For trigerring of the File Anomaly alerts is there a specific threshold value for that. Or do we have any additional setting or setting that  we can mention a threshold value to trigger the alerts.Ex: Only when files modified or created or any activity are more then 10000, then only I should receive File Anomaly alert. Please let me know if we have any setting that we can limit this.

21413
Mike Struening
Vaulter
M
Vaulter
MNRunner
published in Developer Tools, Integration and Automation
“sqladmin_cv and sqlexec_cv” accounts password change workflow

Does your organization have a mandatory password change policy and Commvault SQL accounts (sqladmin_cv and sqlexec_cv) are not in an exception? No worries. We have you covered. We now have “Refresh Commserve Database Access Key” workflow  available in your Commserve and it can be scheduled to change passwords of these accounts.  Happy meeting your security/audit requirements.  Have fun. 

19033
Erase4ndReuseMedia
Byte
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.

189519
christopherlecky
Byte
MichaelCapon
Vaulter
MichaelCaponVaulter
asked in Developer Tools, Integration and Automation
SIMCallWrapper issues with parameter -ConnectionInfo

Hi All, I’m working on a decoupled image template (FR20) that we want to register using SIMCallWrapper after deployment using a script.In this scenario, The comms to the CS must go via a Network Gateway Proxy.Whenever we use the “-ConnectionInfo” parameter with SIMCallWrapper, We get error output: “Invalid arguments received”.Using the same format as documentation: [-ConnectionInfo GatewayHostname:Port].Ref: Registering the Client Using the Command Line (commvault.com)See below example:SIMCallWrapper.exe -OpType 1000 -CSHost CSHOSTNAME -CSNAME CSNAME -clientName CLIENTNAME -ClientHostName CLIENTHOSTNAME -authcode AUTHCODE -overwriteClientInfo -output C:\install\install.xml -ConnectionInfo PROXYHOSTNAME:8403I have managed to work around this issue by manually adding a rule to communicate to the CS via Proxy to the FwConfigLocal file, then removing “-ConnectionInfo” parameter from the SIMCallWrapper command to register the Client successfully. Wondering if anyone has also seen this with

18757
MichaelCapon
Vaulter
V
Vladimir_G
asked in Developer Tools, Integration and Automation
commvault solution design tool

Hello. While learning commvault, I learned about the commvault solution design tool. Now I want to try it out, but I can't find a link to this tool. please tell me how to find it?

17234
dude
Byte
S
Vaulter
StarkVaulter
asked in Developer Tools, Integration and Automation
Authorization Workflows

Hi Team, Is there a way to have two approvers in the authorization workflows(delete job, delete client, delete storage policy workflows etc.)? Until both did not authorize the approval email, deletion should not happen.

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

163610
M
Bit
J
Byte
Justin GlassByte
posted in Developer Tools, Integration and Automation
REST APi Authentication with Powershell Basic Starter Script

For those that don’t want to spend a lot of time trying to figure it out, I just figured I would post the basics and then you can have fun exploring for yourself.  It’s not pretty, but should get those not familiar with using the REST API with PowerShell a good base to start. You’ll want to secure the credential section, this is just basic of the basic. It’s not pretty, but should get you started with REST API.  You will need to fix the following in the script below: YOURWEBURL:PORT - Needs updated to your URL and port (if applicable)    ###USING COMMVAULT REST API COMMANDS#####################################################################################################################https://YOURWEBURL:PORT/webconsole/sandbox/apiexplorer###https://documentation.commvault.com/2023/essential/rest_api_overview.html###SETTING UP THE VARIABLES FOR TOKEN REQUEST############################################################################################################$contentType = 'appl

15990
J
Byte
C
Byte
Cbcurry1Byte
asked in Developer Tools, Integration and Automation
is there a way to get a backup job report that has the backup size using powershell commands ?

Is there a way to create a roport using powershell that includes the backup size. I've tried pulling information but all I see is application size, size on disk etc.  I need to do this for physical and virtual machines. 

15838
Mike Struening
Vaulter
B
Byte
bpinByte
asked in Developer Tools, Integration and Automation
deleteClientAuthorization email approval configuration

We recently moved from on Prem email to cloud, and with the move the deleteClientAuthorization workflow stopped working. I know we have to reconfigure the Email Approval settings (image below) but not really sure what server to define there. Tried outlook.office365.com and made sure the account we are using has IMAP enabled but still doesn’t work.  Anyone here has this configuration on their environment? Any other tweak we need to change on the user account/user mailbox for it to be able to login using IMAP?Appreciate any idea that anyone thinks be helpful in this scenario. Thanks in advance.

15657
B
Byte
B
Byte
benjaminasByte
asked in Developer Tools, Integration and Automation
API 403 forbidden issue

Hello, Would anybody know how to troubleshoot 403 forbidden API error? I am trying to acquire QSDK token, well basically to login, to continue my queries, but it straight away gives out 403 error. I don’t even see the attempt in webserver.log of commcell to which I query for QSDK token..Ports 80,443 are open and working correctly, all firewalls are allowed.. I am not even sure where to check.    auth[‘url] variable is: http://ipaddressofcommcell/webconsole/api/self.cs_login_url variable is: '<DM2ContentIndexing_CheckCredentialReq mode="Webconsole" username="<<username>>" password="<<password>>" />' Does not matter what credentials I use, I’ve tried admin account of commcell, I’ve tried my own domain account, with all of them I can login to JAVA GUI with no issues. Any ideas where to start looking?

15256
Mike Struening
Vaulter
G
Byte
GavaskarByte
asked in Developer Tools, Integration and Automation
GetAndProcessAuthentication workflow

This is the configuration. The administrators are also not members of the Master group but of the CV Admins group that does have rights to delete a client. When we make the administrators a member of the Master group, then they will receive an email.  Is this normal behavior ? 

143410
G
Byte
K
Byte
Kamil
asked in Developer Tools, Integration and Automation
Storage Pool configuration (advanced?)

Hello Commvault Community,  At the beginning, I will explain the situations that we need to meet with the client. We have a production environment with several TapeLibraries and a few DiskLibraries. The client decided that he would like to use the newly created, dedicated Scratch Pools, but he wants them to be automated. This is to work in such a way that for certain Storage Policy copies LTO-7 tape is to be taken or in the second case LTO-8. This configuration is intended to apply to multiple Storage Policy Copies. We'd rather avoid creating all Storage Policies from scratch. However, we know that the Storage Pool settings define the "Default Scratch Pool" settings, where you cannot select individual ones for each copy and additionally, you cannot change it if the copy is already running and has data saved, but we probably found a workaround for this. When we create a new copy to tapes, for an existing Storage Policy, we can choose a Storage Pool/ or create new one, there other than t

13346
Mike Struening
Vaulter
D
Byte
drPhilByte
asked in Developer Tools, Integration and Automation
API call to show failed backup jobs

Hi all, I need to display failed backup jobs from yesterday using a script. In REST Webservice API Sandbox I am able to create API call - see below.Is it possible to run this API call as part of the script from Linux shell (as a curl command) or from Powershell? Or are API calls executable only as part of /from C#, Python, Ruby or Postman? Your help will be much appreciated! GET SearchSvc/CVWebService.svc/Job HTTP/1.1Host: win-cv-new.listopad.local:81Accept: application/xmlCookie2: QSDK 3c6ff3754c98e6b114bac8d6f751e1338d6ed01fb5a0dcf1abae25a51ddbf94bc8663b0b17632c829925b4447467b33075c9b41b52f765a7a1361f1ecffbd228e55980d2dcb805798d652cd364c0e64cc9ed6c0ce6af6e6c8b43c63b1a5791f04cdcde6a7f61db3827e9ae400eea2d6d971493994686d96c2f17b8bd959b8fe864f330e2a2503ee3e96b67b8f568462ac4ca2f9d20112401c80fe055bcee5c35b06f2744a83f76443fa25aa7f9c965625a33ab72a7f4ab3fdcfbf85df3d292ce67f3f7843e5f817a04163838fb982db422306577c98ffae3c254db77b7f8d28a083f3bcab1af341a55c1e67e3eb952dfbe89c52663d922f1a79a14db1513

12666
D
Byte
description of image

Badge winners

Show all badges
Terms & ConditionsCookie settings