commvault.com commvault.com

Developer tools, integration and automation (workflow/REST/Powershell etc.)

Discuss REST API, Workflows, scripting, customization, and more!

  • 288 Topics
  • 1,482 Replies

288 Topics

C
Bit
Chris MBit
posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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
2 years ago
B
Byte
BenjisByte
posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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.  

8
A
Vaulter
1 year ago
H
Vaulter
HarshaVaulter
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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.

3
Mike Struening RETIRED
Vaulter
1 year ago
K
Bit
kengBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

22
K
Vaulter
5 months ago
D
Bit
DimitriBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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. 

8
R
Bit
11 months ago
S
Byte
Stefan VollrathByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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
1 year ago
LukeBrett
Byte
LukeBrettByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

4
Onno van den Berg
Commvault Certified Expert
7 months ago
D
Byte
drPhilByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

3
D
Byte
1 year ago
U
Byte
uchenna kanuByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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?

2
V
Vaulter
9 months ago
J
Bit
Juan-Pierre PanainoBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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.    

4
Mike Struening RETIRED
Vaulter
11 months ago
C
Byte
christopheByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

2
Onno van den Berg
Commvault Certified Expert
1 year ago
MichaelCapon
Vaulter
MichaelCaponVaulter
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

7
MichaelCapon
Vaulter
1 year ago
M
Bit
mhamelBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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
2 years ago
dude
Byte
dudeByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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
2 years ago
M
Vaulter
MNRunnerVaulter
published in Developer tools, integration and automation (workflow/REST/Powershell etc.)

“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. 

7091
T
Byte
1 month ago
J
Byte
JohnADPByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

4
Damian Andre
Vaulter
1 year ago
M
Bit
Morten LarsenBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Bulk move tapes to another library

Hi, Is it possible to bulk move tapes from one library to another? I know it’s possible to right click one tape at a time and select “Options → Move to Library” and then select the new library but it would be nice to be able to do this with more than one tape a time.The reason for this is that we would like to decom an old tape library that we are not using anymore - we have bought a smaller library with just one tape drive so we can restore from all of the tapes used in the old library - but if I de-configure the old library all the tapes will be put in to “Orphaned Media” it would be nice to just have them moved to the new library before de-configuring the old.Maybe it’s just for cosmetics as I guess we can still import a tape (to the new library) that has been moved to “Orphaned Media” and restore the content from it?

3
S
Vaulter
1 year ago
S
Bit
SebaPlamBit
posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Using Ansible playbooks (and/or Powershell scripts) for Media Agent installation and configuration

Hi,We are gradually automating our infrastructure (IaC) and need to automate the installation and configuration of CommVault Media Agents. Any good resources on that subject here or elsewhere? We also want to deploy a Media Agent on a Windows device in Azure order to backup a datalake (ADLS Gen2). So, the Media Agent needs to be configured with an ADLS Gen2 for it’s library. Any automation/scripting tips on that?

1
Mike Struening RETIRED
Vaulter
1 year ago
Mohit Chordia
Byte
Mohit ChordiaByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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
2 years ago
J
Byte
JNIZByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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 RETIRED
Vaulter
1 year ago
J
Bit
JurajBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Commvault and Powershell scripts - how to obtain information about backup job attempts ?

I had have read all CommVault documentation, made a lot of test/API requests as well, but I did not found way/module/API REST how to get information about Backup Job Attempts (only via reports)... I found curl -X GET "https://server/webconsole/api/Events?jobId=14285647" -H "accept: application/json", but all items are regarding Events Details. And I am still looking for any information about full backups attemps, can you advice me which PS module's part or API request is it ? regards,Juraj

2
P
Vaulter
1 year ago
D
Byte
drPhilByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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

6
D
Byte
1 year ago
R
Byte
Rahul18081Byte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Automatic deletion of retired client as per defined days

Hi All, I s there any automation that can be done to delete retired clients after say 28 days.

10
G
Vaulter
1 year ago
G
Byte
GavaskarByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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 ? 

10
G
Byte
1 year ago
C
Byte
Cbcurry1Byte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

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. 

8
Mike Struening RETIRED
Vaulter
1 year ago

Badge winners

Show all badges
Terms & ConditionsCookie settings