commvault.com commvault.com

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

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

  • 308 Topics
  • 1,532 Replies

308 Topics

M
Bit
mdaniouBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Restore database XML API versus qoparation : different behaviour

Hi all,A few months ago I came here to be able to restore sql server databases using the API instead of the qcommandshttps://community.commvault.com/commvault-setup-guides-and-getting-started-51/run-qoperation-exe-from-remote-server-5379So I have the xml file to restore the database and I have a STOPAT parameter.In the xml it shows like this :            <pointInTime>              <timeValue>2023-05-19 09:54:04</timeValue>            </pointInTime> My xml file works if I run sth like :qoperation.exe" execute -cs $CVLTServer -af $CVLTXMLFile -tf $CVLTToken Then it doesn’t if I run :$cvrestendpoint = "http://$CVLTServer:81/SearchSvc/CVWebService.svc" $token = (Get-CVSessionDetail 'Get-CVVersionInfo').sessionToken$restParameters = @{# Variables for holding rest parameters for the request    URI     = ""    Method  = ""    Headers = @{"Authtoken" = $token;"Accept"    = "application/json"}    body = ""}Get-Variable | Where-Object {$_.name -eq '$xml'} | Remove-Variabl

3
Emils
Vaulter
4 days ago
Graham Swift
Vaulter
Graham SwiftVaulter
posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Worklows with CommServDBQuery - SQL Injection risk

Hello all, I recently found out something that I missed, docs have been updated at some point, so wanted to share this with you all as well. (https://documentation.commvault.com/11.24/essential/131495_predefined_activities_for_workflows.html)So take the CommServDBQuery predefined Activity. You have an input defined as a client computer group and then want to get a list of clients within the group via this activity type. I have seen many people do this...SELECT c.id, c.displayNameFROM APP_ClientGroupAssoc cg WITH(NOLOCK)INNER JOIN APP_Client c WITH(NOLOCK) ON c.id = cg.clientIdWHERE cg.clientGroupId = xpath:{/workflow/inputs/vmGroup/clientGroupId}Note that the where clause contains the input as a variable.So this is a bad thing! Have a read through the doc link above, you can see that there is a risk that this could be used to inject SQL code into the workflow and do something you did not intend to happen.Instead, change it to below…SELECT c.id, c.displayNameFROM APP_ClientGroupAssoc cg

4
clecky
Vaulter
4 days ago
Pasqual Döhring
Byte
Pasqual DöhringByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Workflow Configuration

Hi all. I have a question regarding the Workflow Configurations (see this post:) In general I know how to use these and they work like a charm. Unfortunately I don’t have any possibility to see the configured values after setting them.E.G. I have a “configuration” with the name “TestConfig” of type String. I can set it to “Whatever” in the properties of the workflow and the workflow will use it. But if I have a look again in the properties it looks as if “TestConfig” is empty and not set.Am I missing something or is there no possibility to look at the configured values?

4
Pasqual Döhring
Byte
4 days ago
M
Byte
Marcin_CFByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

contents on disk Library / Mount Paths

how to from reports or (best) power shell check contents of selected Library / Mount Paths . I know that for particular MP can do that from CS console but i look for automatic way and more on Library level beside MP by MP.

6
M
Byte
6 days ago
B
Byte
BoyiByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

How to add new AD group to have certain permission to clients in buik using CLI.

Hi, I have a list of 100+ clients in commvault. I will need to add new AD groups to existing permission role for these clients in security tab at both client level and file system level. Does anyone know how to use CLI to do it instead of going through GUI one by one?Once I have this CLI command I can put together something in Excel and run them in bulk. I know I can create a client group and add permission in this way but in our environment we have to do the change on clients. Kind regards,Boyi

1
Damian Andre
Vaulter
17 days ago
A
Bit
Alex_GBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

MediaAgent Hardware Refresh - problems using Replace MediaAgent app

hi Community,  i’m trying to refresh my MediaAgent by installing a new physical RHEL 8 server.I followed the procedure described here:https://documentation.commvault.com/11.26/expert/149337_migrating_to_new_mediaagent_using_replace_mediaagent_app.htmlbut the job “Move Mount Path” failed with message “Failure Reason:[File Read error happened on source MediaAgent, this could be due to some other process is accessing the file. Please resume the job after some time.]”I’m sure to had followed the procedure step-by-step, and i checked if other job was running during the Workflow and was not. But now my doubt is about the process.The app is created to change only the MediaAgent server and the backend storage could remain the same. Right? Thanks in advancedRegards Alex

3
Emils
Vaulter
17 days ago
christopherlecky
Byte
christopherleckyByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Accessing entity properties using javascript in a workflow.

I am trying to create a JSON payload to submit to qoperation the problem I seem to be running into is that I can’t access the properties of the cliententity object.I tried to see what would happen if i did something like  logger.info(servers[0].clientName)and the output I get is null.This is what the script looks like: This is what the for loop looks like: This is the output:  Clearly I am doing something wrong.I posted this in the private area in hope it would get more traction.Thanks.

1
Y
Vaulter
18 days ago
L
Bit
Lars Berntrop-BosBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Anyone integrating Domino 12 backup with the Commvault REST API?

Hi,We need to use HCL Domino 12 for security updates.  But the Commvault Backup agent for Domino does not support HCL Domino 12.HCL Domino 12 has a new backup integration feature, we plan to leverage this and use the Commvault via REST or Powershell to integrate with Commvault backup.Has anyone experience with integrating with Commvault using the REST API?Is there a product manager I can contact?Would love to here from the community! Lars 

6
S
Bit
18 days ago
S
Bit
SGMakBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Commvault reporting query

Hi All,I have MSP like structure where do have 8-10 companies. I have created power bi dashboard using REST APIs and can segregated clients based on that. Now business wants to segregate data Application wise. Company1 will have multiple application (Network, AD, File server etc.)Is there any way to have such hierarchy and pull data into Commvault reports without using Client computer groups?

1
Damian Andre
Vaulter
20 days ago
G
Genny D
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

how do i implement a multitenant sharing the same commserve?

Hello I need to implement backups for a new customer who has different companies and wants to do it from his commserve which already backs up other customers machines that are in a different IP range.Thanks for your help!

1
SparshGupta
Vaulter
25 days ago
EricF
Vaulter
EricFVaulter
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

commvault save as script executing under MFA options

I am working with a customer that has some questions on the save as scripts from the backup subclients.They want to execute from a linux server. IN the batch under setlocal it is asking for GALAXY_BASE:=I assume you can add the linux path to base to execute the qlogin command and qoperation? The other question is  they want to make sure any account used is not visible in any of the script files if they have to use a non-mfa account.  Is there any way to use MFA and these export scripts from CV or documentation around that? 

0
EricF
Vaulter
26 days ago
N
Byte
NikkyArtByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Waiting for multiple parallel jobs on workflow

Hello, i created workflow and use foreach for run backup task (multiple clients). how i can wait job complete for multiple parallel jobs?i tried use WaitForJobCompletion in step after starting backup task. If configure "number OfParallelExecutions" value in "1" for foreach, task is executed sequentially (it's normal,  we are waiting for the task to complete to start another task).When configure "number OfParallelExecutions" value in (for example) "10"  for foreach and use WaitForJobCompletion in step after starting backup task, the tasks are executed in parallel, but we have error "Error Code: [19:1805]" in workflow. But, workflow work correctly and backup done.finnaly, is there a way to monitor (for jobs waiting for other steps on the workflow) the execution of multiple parallel  (backup) jobs runs inside a "foreach" block outside of "foraech" block? When uses "number OfParallelExecutions" value in (for example) "10"  for "foreach" block.Thanks

1
R
Vaulter
27 days ago
EricF
Vaulter
EricFVaulter
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

backup validation

I have a customer asking if CV has a way to confirm the validity of the backups that are taken. I am not aware of any way to test whether a backup has all the content it is supposed to backup versus what is on the target server that is being backed up. Beyond the normal stuff like alerts, reports, dashboard etc etcThey ran into an issue where one of their backup admins made a mistake and let a failure ride for several months, had a critical recovery request and now they are trying to figure out a way to make sure their backups are sound.I doubt it, if the backup admins are not following the reports/dashboard and alerts then I am not sure what we could provide beyond that.  

4
Onno van den Berg
Commvault Certified Expert
30 days ago
C
Commvault Certified Expert
ChrisKCommvault Certified Expert
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Add S3 compatible Cloud Library using Python or REST API

I want to automate the creation/adding of new libraries, specifically such of the type “S3 compatible”. So, not a classical Disc Library and neither a Cloud Library (Like Azure or AWS).I’ve crawled through the Python Modules and the REST API but I can’t seem to find any way of adding such “S3 compatible” type library, only normal Disc or Cloud ones.Does anyone know of a way to get this done? Or have I missed something?

1
Onno van den Berg
Commvault Certified Expert
1 month ago
J
Byte
Just LearningByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

API to update storage policy copy retention rule(days)

Hi Everyone, I am trying to update storage policy copy retention but i am not having a much luck.In the command center you can edit the plan then edit Backup Destinations which are storage polices and it generates an Equivalent API and JSON payload, but when i post to URL it generates i am just getting a return off storagepool list.    is this the correct location post:https://mycommserve/commandcenter/api/StoragePool?Action=copyEdit what i am trying to achieve is that updating retention rule for “retainBackupDataForDays” in number of secondary copy policies. is there any sample that can help?  Thank you!  

2
J
Byte
1 month ago
christopherlecky
Byte
christopherleckyByte
posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Using the qoperation rest api endpoint to do (almost) anything you can do in the Gui

Who is this for?This is written specifically for people who cannot find a way to do something in the rest API. When should I use the qoperation execute api?If an API endpoint exists to do what you need use that, The rest api is much… much… much newer than qoperation execute and I suspect the thing that makes the rest api viable at all as a substitution for the command line is that fact that the qoperation execute api exists In other words it may be a stopgap solution.  DISCLAIMER:I am no expert, everything stated below is my opinion based on experience and experimentation.With that said I  both welcome and invite criticism from those who have deeper insight and knowledge. This post is made solely to help those who are currently looking for solutions.In order to be fair to the people reading this any pure speculation on my part will be placed in italics. That said I am quite confident that everything stated below is basically correct if not complete in scope and context. Anyone who can

0
christopherlecky
Byte
1 month ago
W
Bit
WIlliam WOodrumBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

DB2 Worklow

New to workflows and Commvault in general, having deployed in December of 22. Looking for a workflow that would enable our DB2 DBAs to do an out of place restore to devops server using the repath options on a weekly basis. 

1
christopherlecky
Byte
1 month ago
J
Bit
J-RodBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

JSON Response

I am able to successfully query the rest API and the xml data looks good but when I use ‘Accept: application/json’ the data is not formatted correctly. Is this a known issue? I tested this feature in both python and curl.

3
christopherlecky
Byte
1 month ago
J
Bit
J-RodBit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

How to query the ddbStoreId from the Rest API?

I am trying to query the Deduplication Database Details using the REST API. It works good but I have to provide the ddbStoreId. I can open the Commvault GUI I locate the ddbStoreId manually. How can I query the ddbStoreId from the REST API so I can fully automate this process?

2
J
Bit
1 month ago
J
Byte
Just LearningByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

API get Full Schedules

Hello everyone, Is it possible to get Full Schedules via API call? i am able to get the schedules and sub tasks inside the schedule but i could not find a way to differentiate schedules from Full, vs Incremental vs Full Synthetic?  Granted Full Synthetic has a display name so it lets you differentiate from Full and incremental but Full backup and incremental does not have any name in schedules.is there any other property that i can key off?       Thank you!    

8
J
Byte
1 month ago
EricF
Vaulter
EricFVaulter
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

HSX hyperscale performance tuning guides and benchmark documentation

Do we have any performance tuning guides for HSX? The customer has a 11 node\24 disk per node cluster and wants to know if they can benchmark performance and get kind of a best practices around tuning and how to get the most out of the HSX. thanks much

2
EricF
Vaulter
1 month ago
A
Bit
AECI DBABit
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Issue with RESTORE-CVSQLDATABASE -OutofPlace

I’m trying to script a process to automate my restore testing of SQL Server database backups from Commvault.  The process will one-by-one restore each production database from all of my production servers to a utility server where I can run checkdb and other validation processes against the database and log the results.  I’m doing this all through powershell and using the Commvault powershell module RESTORE-CVSQLDATABASE to do the restore with the -OutofPlace flag and the other needed paramaters to tell it where to restore. So far it works fine as long as the original database data file directory and log file directories match my utility server.  Not so fine when they don’t.  It will throw an error in Commvault saying that it cannot find the datafile directory (H:\MSSQL\Data…..etc).  Of course there is no H drive on my utility server but that should be taken care of with the -DataFilePath "E:\MSSQL\Data" -LogFilePath "F:\MSSQL\Log" parameters I’ve passed in right?  Here’s the actual sy

6
D
Bit
1 month ago
A
Byte
alligatorByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

#12! getting added in xml (Save as Script of sql restore), is not legal for a JDOM character content: 0x0012 is not a legal XML character

so when i trying to get this information to a mail, i’m getting an error , how to fix or get rid of the xml encoding error. I’m trying to fetch the path information for a sql restore to email (using workflow)  

11
A
Byte
2 months ago
O
Byte
OP TeamByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Is there any workflows available in Commvault to auto restart the VSS Writers Services ?

Is there any workflows available in Commvault to auto restart the VSS Writers Services ? 

1
Damian Andre
Vaulter
2 months ago
R
Byte
RobAbateByte
asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Use API Key for REST API authentication?

We have a custom application that was developed in-house for automation, and we are trying to integrate Commvault into it, as we have for other backup applications used here.We wanted to know if it was possible for Commvault to use an “API Key” (which Veritas NetBackup has) in order to authenticate, rather than having to use the normal authentication token which expires after 30 minutes of inactivity?For more info on the API Key in Netbackup, see: getting-started (veritas.com)A NetBackup API key is a pre-authenticated token that lets a NetBackup user run NetBackup commands(such as nbcertcmd -createToken or nbcertcmd -revokeCertificate) or access NetBackup RESTful APIs.Unlike a password, an API key can exist for a long time and you can configure its expiration.Therefore, once an API key is configured, operations like automation can run for a long time using the API key.

4
M
Vaulter
2 months ago

Badge winners

  • Topic Starter 1
    Laharihas earned the badge Topic Starter 1
  • Topic Starter 1
    Cintotecahas earned the badge Topic Starter 1
  • Solver 1
    Jaspreethas earned the badge Solver 1
  • Contributor 1
    ComBakhas earned the badge Contributor 1
  • Topic Starter 1
    Rafaelctthas earned the badge Topic Starter 1
Show all badges
Terms & ConditionsCookie settings