Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 536 Topics
  • 2,223 Replies
537 Topics
A
Bit
Alex TBit
asked in Developer Tools, Integration and Automation
Custom report using SQL archAgingRule VS archAgingRuleExtended

Hi folks, I'm building a custom report using SQL. The final output should look more or less like the “Backup Job Summary” report in Command Center. However, I'm running into issues with the Retention column. I’ve figured out how to pull the standard retention using the following query: SELECT J.jobId, AR.retentionDaysFROM JMJobDataStats JINNER JOIN archGroup AG ON J.archGrpId = AG.idINNER JOIN archAgingRule AR ON J.archGrpCopyId = AR.copyId The problem is that this query doesn’t return jobs that have extended retention. I’m aware of the archAgingRuleExtended table and tried selecting from both tables and then taking the greater value — but this approach doesn’t seem to work. I also tried applying the extended retention only when JMJobDataStats.retentionFlags > 0, but that didn’t help either 🙁 I’m sure I’m missing something obvious, but I can’t figure out what exactly. There must be some indication that a particular job is using extended retention, but I haven’t been able to find it. A

261
P
Vaulter
D
Bit
DanOBit
asked in Developer Tools, Integration and Automation
SAP for MaxDB - Security

In the MaxDB Workflow properties, what should the Security tab look like? Does ‘master’ user and ‘master’ role need to be added? Or just the specific commvault service account with master (or custom) role be applied?

80
D
Bit
dude
Byte
dudeByte
asked in Developer Tools, Integration and Automation
Draw.io stencils

I am looking for stencils that can be imported into draw.io to build backup diagrams and environments for documentation purpose. Is this something Commvault has available to customer? If so, can you send a link for download please? Thank you

3353
Onno van den Berg
Commvault Certified Expert
J
Bit
JDodsBit
asked in Developer Tools, Integration and Automation
Defining Filters for a Subclient (VMware command line)

I see that update_subclient_filters_template.xml allows for specific VMs to be added to filters but can it also be used to remove them? I tried changing -vmFilterOperationType ADD to DEL or REM but no luck.

122
J
Bit
A
Bit
Alex TBit
asked in Developer Tools, Integration and Automation
Not enough details in Storage Policy Copy Details API :(

Hi folks, I need to amend storage policy copy details (using API), particularly this block: I need to change the value of streams number.. The GET request I use to obtain storage policy copy details:<webservice>/V2/StoragePolicy/{storagePolicyId}/Copy/{copyId} However, looks like this parameter is missing in the response 😒

394
A
Bit
N
Byte
NOSByte
asked in Developer Tools, Integration and Automation
Can't get "autoresume" parameter to work on suspend API call

Hello everyone, hope you’re having a good day. I’ve been trying to build an API call that would suspend and then autoresume a job but I’m not being able to figure out how. These have been my attempts so far: 1. curl -s -L -k -X POST "${URL}/Job/30409890/action/pause?autoResumeInSec=60" \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H "Authtoken: $key" \ -H "Content-Length: 0" \ --data '{}' > /dev/null 2. curl -s -L -k -X POST "${URL}/Job/$jobid/action/pause" \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H "Authtoken: $key" \ --data '{ "options": { "autoResumeInSec": 600 } }' > /dev/null Request 1. will suspend but never end up resuming. I’m basically stuck first suspending and putting it in a loop finding when the job is finally suspended to then make a call to resume. If I was able to use the autoresume parameter it would really simplify things. Has anyone made this work? We’re on version 11.36 in case that is relevant. Thank you in

212
N
Byte
0
Byte
0ber0nByte
asked in Developer Tools, Integration and Automation
CommServe HA Windows in place upgrade

Hello Team, We have Windows 2016 servers in 3DC(active-standby-standby) and CommServe LiveSync for High Availability(link below). We want to upgrade these servers to Windows 2022 with Windows in-place upgrade. As far as I know, Commvault software supports Windows in-place upgrade, but does it support it in HA structure? I couldn't find any information about this in the documentation. If it supports it, would it make sense to upgrade standby first, then do production failover, and then do the other one?Is production failover supported on different Windows versions, does it make sense to do it? Thanks in advance! https://documentation.commvault.com/2024e/expert/commserve_livesync_for_high_availability_disaster_recovery.html

91
J
Vaulter
0
Byte
0ber0nByte
asked in Developer Tools, Integration and Automation
VM backup automation

Hi Team, I am trying to do an automation. As part of this, I want to add a VM that I have pulled as a variable via a form to a subclient first (if the subclient content is full, it will clean it and then add the VM) and I want to trigger the Full backup of the relevant subclient. Which Rest API, qcommand, commvault powershell module etc. can I do this better with and which API or commands can I do it with, can you give me some guidance? Another question is, how can I start the Full backup of a VM that I have pulled as a variable via a form (a VM that I have never backed up before, that Commvault does not know yet)?

221
A
Vaulter
M
Byte
Marcin_CFByte
asked in Developer Tools, Integration and Automation
credential vault

how to create in automatic way for example 100 entries type of “SQL_SERVER_ACCOUNT” in credential vault ...anyway i am intrested API , powrshell , worflow etc i can list existed one as type of “SQL_SERVER_ACCOUNT” exist in Get list of credentials | Commvault® but in CREATE section Create Credential | Commvault® like type of “SQL_SERVER_ACCOUNT” not exist

387
M
Byte
X
Bit
Xufeng YuanBit
posted in Developer Tools, Integration and Automation
How zabbix to collect commvault's alert, and one by one client?

Backgroup: Commvault is nice backup platform, and it is helpfull to us who are IT admins. IT team charges the backup operation daily, and include over 400 clients; usually, the backup faild or other alert are gerented everyday, and only autherization user is able to login commvault software to check and fixe the alerts, but it not kindly way to share or push client’s owner to move on. Originally, IT team want to use Zabbix collect the alert from Commvault, and now the way is successful.

3910
X
Bit
P
Bit
patrick.neetensBit
asked in Developer Tools, Integration and Automation
how to create a CLient Group with new rules in Python & cvpysdk ?

I try in Python 3.11.5 with Cvpysdk v11.38 ( or 11.34 before ) to create a ClientGroup with some rules in it . But when I run it I can see the new Client Group , the new rules added but strangely the value of the rule … associated Storage Policy has another value and thus the result , all associated clients to this new client group, is not correct. It’s very difficult to find any help ? Even Brave A.I returns me some faulty samples or probably some old python and cvpysdk samples. Thanks in advance, Patrick

131
A
Vaulter
Javier Herrera
Javier Herrera
asked in Developer Tools, Integration and Automation
Alert for lost conection webhook

Good afternoonI would like to ask you a question, we are with Commvault recently and we have configured Webhook, so that through the service we generate incidents for problems with backups, with the circumstance that has lost the webhook connection on a couple of occasions, and we do not realize the situation until we check it manually.Is there any way to configure an e-mail alert to warn that Webhook has lost communication? Thanks in advance for your time, and replies

171
Onno van den Berg
Commvault Certified Expert
R
Byte
Rixon01Byte
asked in Developer Tools, Integration and Automation
Re-Associate clients to different storage policy

Looking for a automated way to re-associate client in a storage policy to a different storage policy. Our DR/Failover plan requires us to different libraries, Data paths When we failover our Comserve to our Secondary site. Once our Primary site has failed over to secondary site we will bring up the Commserve and re-associate the client in “primary Site/s Storage Policies” to “Secondary Site’s Storage Policies” so backups will then start backing up to Storage located at Secondary Site. Thus for the reasom that I’m looking for a script/ Automated way to re-associate several Primary Site SP’s to their counterpart Secondary Site SP’s

323
D
Vaulter
P
Byte
Prashant MallByte
asked in Developer Tools, Integration and Automation
Release License API

Hi! I had been using the release license API and it used to work, until today. I am not sure if something changed in the backend, or am I missing something in the payload? Payload1: { "isClientLevelOperation": true, "licensesInfo": [ { "platformType": 1 } ], "clientEntity": { "clientId": 12345 }, "license": { "licenseName": "Server File System - Windows File System" } } Payload2: { "isClientLevelOperation": true, "licensesInfo": [ { "platformType": 1 } ], "clientEntity": { "clientId": 12345 } } Response: { "warningCode": 0, "errorMessage": "", "errorCode": 0, "warningMessage": "" } Even tho I see an error code 0, the license is not released.

262
P
Byte
D
Bit
danbjBit
asked in Developer Tools, Integration and Automation
Python SDK - releases and versions

Hi all, I am trying to automate our Commvault platform, and have been using the cvpysdk package a bit - however, I am missing some information. First of all, are there any release notes available for the different versions/releases of the package? I can not find anything really in pypi or in github. Secondly, I can also see that the releases are versioned as 11.32, 11.34, 11.36, 11.38, is this directly correlating to what version of Commvault software you are using or what release should one use? Is it possible to use 11.38 on a 11.32 platform or should I be expecting operational difficulties? Lastly, what python versions are supported? Thank you in advance, Daniel

431
C
Vaulter
H
HelderCoelho
asked in Developer Tools, Integration and Automation
Report with Oldest recovery point

Hi, I know that at Command Center > Protect > Virtualization > VM we can get “Oldest recovery point” for that specific VM. I need a report with all VMs with “Oldest recovery point”. Any ideas? I know that “Latest recovery point” is easy and already available at some predefined reports. Thanks HC

132
H
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Does the reports API accept bearer tokens?

The documentation appears to be contradictory. https://documentation.commvault.com/2024e/expert/rest_api_get_data_set.html GET /CustomReportsEngine/rest/reportsplusengine/datasets/<datasetID>/data Host: <host name>Accept: application/xmlAuthtoken: <authentication token> When I attempt to use a bearer token, I get 401 not authenticated.

472
christopherlecky
Byte
S
Byte
ShaneWByte
asked in Developer Tools, Integration and Automation
New PostgreSQL Cluster Psuedo Client - Command Line

Hi all, We’re on version 11.36.46 and I cannot get the syntax to work. I’ve downloaded the template and used the syntax from https://documentation.commvault.com/v11/expert/command_line_interface_configuration_postgresql_idataagent.html#creating-a-multinode-cluster-instance but I get: execute: Error 0x911: Failed to process request due to invalid entity information.Invalid clientId for clientName[CLUSTERNAME].Invalid instanceId for instanceName[INSTANCENAME] The new name is unique and has never been used. Has anyone gotten this to work as yet?

242
S
Byte
M
Byte
Marc St.Byte
asked in Developer Tools, Integration and Automation
Command to change the container of tape media

Hello, I’m looking for a command to change the container of a tape media. In the CommandCenter it’s not possible to change the container and therefore I can’t find an equivalent API. In the Console I’m able to change the container of a tape but even if I activated logging (ALT-F8) there was nothing useful in the logs. I was searching through documentation but found no qcommand or anything to change the container.

413
M
Byte
F
Filipe Asaph
asked in Developer Tools, Integration and Automation
Workflow SMTP Error - 19:857

Hello! All good?My name is Filipe Asaph, work in StorageOne. I would like to ask you questions about Commvault's "Workflow" tool. I'm trying to send an email in Workflow, but it always gives an error. The error number is 19:857. Grateful, Filipe Asaph.

71519
N
Bit
A
Bit
AmarnathBit
asked in Developer Tools, Integration and Automation
qoperation how to get the databse instance name to pass it to schedule policy assignment command.

In below example at the end we are passing the instance name by checking it manually by login in to commcell console but our requirement is to fetch the database instance name automatically through a command. .\qmodify.exe schedulepolicy -o add -scp <Schedule policy name> -c <Host Name> -a Q_MSSQL -b defaultBackupSet -s default -i <Instance name> We need your help in getting the right command to get the instance name.

432
A
Bit
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?

16214
dude
Byte
E
Eugen
asked in Developer Tools, Integration and Automation
Exchange Backup fails because of EWS issue

Hello everyone, We have had a problem with Exchange Backup since today because of the EWS error (see image below). We have already re-entered the credentials for the service account, but unfortunately that didn't help. Does anyone have a useful tip on what to do in this case? We have re-entered the credentials for the service-account at Commvault Exchange Client (see below)

1187
S
Vaulter
L
Byte
LucienByte
asked in Developer Tools, Integration and Automation
API that returns which node uses current node as Access Node

In CC ( Protect → File Servers → <item>-->tab Configuration (down&left) a list of servers that use current node as Access Node is displayed. I would like to get this list using an API, but I am not able to find the API. Is there an API that provides this info ? Thanks in advance !!

321
M
Vaulter
A
Byte
Alex_GByte
asked in Developer Tools, Integration and Automation
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.html but 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 advanced Regards Alex

2204
A
Byte
description of image

Popular tags

Badge winners

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