Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 545 Topics
  • 2,247 Replies
546 Topics
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Need help to get a list of vCenter instance hostnames

I cannot use the client list because we have duplicates with the same hostname. I need a query or even a rest api call that can get this information. thanks.Chris.

16015
christopherlecky
Byte
T
Vaulter
Takanori KikumotoVaulter
posted in Developer Tools, Integration and Automation
Workflow Configuration

This is related to this Documentation: Adding a Configuration Value for a Workflow. Workflow Configuration is very useful in the following scenarios (copied from Documentation), Values apply to the workflow the majority of the times that the workflow runs. You do not want to redeploy the workflow when the values change (the workflow version is not updated). Actual use cases, if you're having very simple workflow dedicated to single task, you don't need to use Configuration, instead you can pass all parameters to run the workflow via workflow's Inputs. If you're having workflow for common purpose, like maintain multiple clients with common configuration between them, you should prepare single wofklow with Configuration.

772
Surendra Nadh Arla
Vaulter
O
Bit
OPadbergBit
asked in Developer Tools, Integration and Automation
Job Rest-API doesn't show Auxcopys anymore

we use the Rest API to retrieve various job information. We used "Job?completedJobLookupTime=86400" to show all backup jobs and AuxCopys for the last 7 days. But since we installed the 11.28.14 update, we don't get any auxcopys informations. Also if we don't set the filter "completedJobLookupTime" we get 2500 results but the past auxcopys are not shown either. We have now also installed the 11.28.19 update, but it did not fix the problem.The permissions for the user have not changed.We can reproduce the problem via API Explorer or Postman. The API documentation refers to a "JobFilter Parameter Values" list where auxcopys are still listed. https://documentation.commvault.com/v11/essential/47608_rest_api_get_job.htmlAre auxcopys no longer displayed via the Job Rest API?

1675
O
Bit
N
Byte
Nick Laflamme II
asked in Developer Tools, Integration and Automation
Example needed: QOPERATION EXECUTE within POST QCOMMAND built in PowerShell?

Can someone provide an example of invoking “qoperation execute” via a POST QCOMMAND call to the REST API? I’m trying to build the XML for the “qoperation execute” as a PowerShell variable (in a loop, updating backed on what we’re looping on), but since I’ve never done anything like this, I can’t tell why I’m getting an “internal error” response, apart from, “clearly I don’t know what I’m doing.” If I can see a successful example, I can see how different my attempt looks and hopefully adjust accordingly. Thanks,NickSince someone is likely to ask: $napTime = "<?xml version=`"1.0`" encoding=`"UTF-8`"?><App_SetMediaAgentPropertiesReq> <mediaAgentInfo><mediaAgent mediaAgentName=`"$thisma`"/> <mediaAgentProps markMAOfflineForMaintenance=`"1`" enableMAAfterDelay=`"60`"/></mediaAgentInfo></App_SetMediaAgentPropertiesReq>"            $takeNap = "$origin/Qcommand/qoperation%20execute -req $naptime"            $a5 = Invoke-RestMethod -Uri $takeNap -Method

4726
christopherlecky
Byte
B
Byte
benjaminasByte
asked in Developer Tools, Integration and Automation
Workflow to assign to schedule policy

Hi, maybe someone has already made a CV workflow to assign client to a schedule policy and are willing to share such workflow? I was looking for any xml option that I could run from client side with qcommands but could not find such thing for schedule policy associations… Thanks!

1924
Commvault Marcus
Vaulter
M
Byte
Marc St.Byte
asked in Developer Tools, Integration and Automation
Problem extracting the vmGUID in a Workflow using Javascript

 Hi,I want to work with VMUtilities in Workflows.Therefore, I created a simple workflow to extract the vmGUID using RestAPI.  The the first step created 2 Variables, on with the name of the VM  and the other for my vShpere-Client:  As the first activity I use HttpClient to get the client details including the vmGUID  1. Solution:In the next step I’m using the activity «PowerOn», insert the two variable and try to extract the vmGUID from previous output: To extract the vmGUID, I used the example I found in documentation and changed it to suite my needs.https://documentation.commvault.com/v11/essential/132060_specifying_script_to_retrieve_input_value_for_workflow_activity.html    I get the following errors:org.jdom2.input.JDOMParseException: Error on line 2: Element type "vm" must be followed by either attribute specifications, ">" or "/>".VMOperationsHandler     : [PowerOn (PowerOn_1)] ERROR: failed to encode xml 2. Solution: Then I thought I could put these lines into the “OnStar

1864
christopherlecky
Byte
J
Byte
Joel BatesByte
asked in Developer Tools, Integration and Automation
Fully automating client installs - assign storage policy & client group

Hello all! I am trying to simplify installing agents for DBA’s and other app teams. I have created custom packages that can run silently, but by default I cannot assign things like storage policy to the specific agent. For example, an MSSQL custom package will install but no storage policy is assigned. What I’d like to do: DBA takes a custom package, runs the installer in “silent install” mode, server registers to the commserve. Storage policy is assigned to the discovered DB instancesClient computer group is assigned (which has a schedule connected to it) Ideally run a first full backup after install completes (that’s a low priority) Pulls latest client updates - maybe executes a workflow on itself? (I know I’m dreaming)Is there a way to customize the install.xml file in the installer? Has someone done this post-install with a qscript or other means?I am running 11.26.41 - and it seems some custom package options have gone away. Sorry, haven’t migrated to plans yet - but if this can b

6074
J
Byte
S
Byte
Stefan VollrathByte
asked in Developer Tools, Integration and Automation
Subclient Properties Attribute List

Hi GuysEach Subclient that gets created has 200+ Parameters and Options, some are set always, some not, new ones get added with every FeatureReleases and Default-Values might change with every other MaintenanceRelease. After couple of years I now have a Zoo full of varying configurations that I need to consolidate to a hand full of standards.Anybody know a convenient way to gather all available Options for a given Subclient-Type? Intention is to gather a giant table to be able to compare f.E. setting up same diskCleanupRules for all FIleSystem Agents.Tried to extract the Data from App_GetSubClientPropertiesResponse xml-Output but couldn’t find a good way to extract all Entity and Attribute Paths as source for a XPath-Query Loop through everything.  XPath 3.0 would support something like “//@*/path()” to do that in a one-liner but Commvault Java stack doesn’t seem to support that.Anybody had the same challenge and found a solutionBest RegardsStefan

1282
S
Byte
N
Byte
Nick Laflamme II
asked in Developer Tools, Integration and Automation
Distinguishing LInux Media Agents from Windows using PS SDK V2

Is there a canonical way using the Powershelll SDK V2 to tell the Linux media agents from the Windows media agents? (When it comes time each month to apply Windows patches, putting the Linux media agents into maintenance mode just because they’re media agents aggravates my OCD.) 

405
N
Byte
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

260622
K
Vaulter
Z
Bit
Zer0c00LBit
asked in Developer Tools, Integration and Automation
Question about custom package remote deployment via PowerShell

Hello,I am new to CommVault and attempting to remotely deploy MediaAgents and Virtual Server Agents using a PowerShell script.I created a custom package selecting the “Virtualization” role (Per this article: https://documentation.commvault.com/2022e/essential/135950_installation_roles_and_packages.html). I did not create a self-extracting executable file because it failed to generate one, so my package files are all contained with a folder.The package successfully installs, but it is only installing the “File System Core” component. Even though my install.xml file explicitly says “ selectedRoles="51,713" “ which I noted are the Media Agent and Virtual Server in WinPackages.xml.Is my install.xml not being read properly?Here is my PowerShell one-liner:(start-process "C:\localpath\Setup.exe" -ArgumentList '/silent /install /authcode XXXXXXXX' -Wait -NoNewWindow -PassThru).ExitCodeI also tried using this command on the local box: Setup.exe /play install.xml /silent /authcode authcodeThe ab

3997
J
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
P
Byte
ptmorrisByte
asked in Developer Tools, Integration and Automation
Commvault Powershell SDK v2

Hello all, is anyone using the Powershell SDK v2?  I see it hasn’t been touched since initial commit, is this still a thing?  I really like the v1 and wanted to see what else is now available in v2.  https://github.com/Commvault/CVPowershellSDKV2 The documentation is scarce at best and CV docs still references SDK v1 which is not the same as v2.  From the github page it just says to use Invoke-SetupLogin, which I am able to connect and get a token.  But then how do I use the cmdlets at that point?  When I run a command afterwards I just get “Unauthorized”  In v1 once you run connect-CVServer, you can run any commands against the currently logged in Commcell. I really think this PS module is a great thing and hope it is still being developed.  The API is nice but the PS code is much easier to use and less code involved. Thanks for any details!

3552
P
Byte
A
Byte
AIMS.StorageBackupByte
asked in Developer Tools, Integration and Automation
Splunk plugin not accepting credentials

Hi @Mike Struening ,I am also facing similar issue. I have installed the configured the Commvault Splunk plugin available at: https://splunkbase.splunk.com/app/5718/  and I am trying to get respective data from Commvalut version-11.24.48.I have checked the permissions for the user(not a service account) of Commcell it is same as per your shared screenshot still no luck.  Please help me understand the possible reasons it is not accepting the credentials. 

1311
Mike Struening
Vaulter
D
Bit
DmitiyBit
asked in Developer Tools, Integration and Automation
Get-CVSQLDatabaseBackupHistory backup history for the database [test] is not available

Can't get database backup historyPS C:\Windows\system32> Get-CVSQLDatabaseBackupHistory -Name test -ErrorAction SilentlyContinueValidateResponse : Status: ProtocolErrorMessage: The remote server returned an error: (500) Internal Server Error.ErrorMessage: RecommendedAction: At C:\Program Files\WindowsPowerShell\Modules\CVPowershellSDK-master\Modules\Commvault.RESTSession\Commvault.RESTSession.psm1:410 char:17+                 ValidateResponse $response $output $ValidateProperty+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,ValidateResponse INFO: Get-CVSQLDatabaseBackupHistory: backup history for database [test] is not availableInitially, using the CVPowershellSDK-master module, the Get-CVSQLDatabaseBackupHistory function worked correctly and returned a list of backups. Can you please tell me if the co

2767
D
Bit
S
Bit
Steve FBit
asked in Developer Tools, Integration and Automation
Elasticsearch Backup using SSL/TLS

We have deployed the Elasticsearch Backup and Restore workflows and found that the URL references within them are using http://. We prefer to use encryption so is it as simple as changing the (4 in Backup / 13 in Restore) actions from http:// to https:// ?

4726
S
Bit
A
Byte
Allan0105Byte
asked in Developer Tools, Integration and Automation
Help with powershell Script

Hi Team,I am trying to run the workflow using PowerShell and capture the workflow job id output to the text file, that text file will be read by our BigFix tool. Below is the scripts and the error i am gettingPS C:\Users\awilliamtell> $jobid = Start-CVWorkflow -name baas_workflow -Force | select jobidINFO: Start-CVWorkflow: enter inputs for workflow [baas_workflow]PS C:\Users\awilliamtell> qlist job -cs BTEEGVPCSTVW001.forsythehosting.com -j $jobid -waitForJobComplete -waitTimeoutSecs 600 | out-file -filepath c:\test\test.txt -appendjob: Error 0x303: Invalid job Id @{jobId=18850} **************************************************************************************************I tried to print the $jobid and if its giving output as Can't find file @{jobId=18866; processId=18866}PS C:\Windows\system32> $jobid = Start-CVWorkflow -name baas_workflow -ForceINFO: Start-CVWorkflow: enter inputs for workflow [baas_workflow]PS C:\Windows\system32> print ($jobid)Can't find file @{job

2641
J
Vaulter
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
Restore Request Authorization : approval via email

is it possible to provide the approval through email response which are in these workflowusually, the mail shows a link to the commandcenter which takes to the Monitoring » Approvals section Can we enable this approval with email response?

6521
Mike Struening
Vaulter
E
Byte
Eduardo BragaByte
asked in Developer Tools, Integration and Automation
Query to return list of Bad Orphaned Media

I need help to produce a query to return a list of Orphaned Media (LTO tapes) with condition equals to Bad/Good. Which database and which table should I use?    

692
J
Vaulter
B
Byte
benjaminasByte
asked in Developer Tools, Integration and Automation
403 random error on api

Hi guys, could not open old thread here:  So creating new one.. Still same problem, I’ve increased debugging and file versions on webserver.log and couple more, but I think webserver.log is relevant here now as I see some strange lines in the logs.First of all - login is actually successful, afterwards I can see connection being aborted!login OKDoes someone have the knowledge to comment on those here?ABORT connectionABORT connection 2Log lines:18824 397c  07/26 12:52:34 ### XMLSerializer::serialize() - Serialized xml is : [<?xml version="1.0" encoding="UTF-8" standalone="no" ?><CNSession_PAbortRequest time="0"><status close="2" errnum="0" errtype="2"/></CNSession_PAbortRequest>]18824 397c  07/26 12:52:34 ### BinarySerializer::serialize() - [<?xml version="1.0" encoding="UTF-8" standalone="no" ?><CNSession_PAbortRequest time="0"><status close="2" errnum="0" errtype="2"/></CNSession_PAbortRequest>]18824 3224  07/26 12:53:28 ### CCvNetwork::

1704
Mike Struening
Vaulter
N
Bit
nerdgirlBit
asked in Developer Tools, Integration and Automation
'bulk edit' data interface pairs for commserve ?

I am going to be rebuilding my commserve in the near future, and the IP address is going to be changing.  Is there a way to 'bulk edit' all of the DIPs associated with the commserve, or will I have to do them all one by one?  I thought there used to be a control panel feature that displayed all DIPs (and could edit them there) but I don't see that option.

2526
chrisknows
Byte
V
Byte
VjduurenByte
asked in Developer Tools, Integration and Automation
Intelligent AirGap flow

Hi,I am currently testing with Airgap technology to make aux/offline copies to an isolated environment with WORM enabled. To explain the situation bit more this is how it works -- see picture below.FYI; to Power On/Off the MA’s I use the Workflow: Airgap which commvault provided.To make it more intelligent I created an PoSH which checks all the jobs that is being initiated by the AirGap Schedule Policy and if all the jobs contains: ‘completed’, ‘completed with errors’ or ‘failed’, the machines are going down using the Workflow.Now I know there are some Administrative Jobs that has to run as well like;Data AgingDDB BackupsData verificationReclamation etc...Ofcourse I can make this part of the PoSH script before Power Off the MA’s but is it smart to do? Is there anyone who has experience with the administrative processes and this technology below?   

3207
Mike Struening
Vaulter
B
Byte
BloopaByte
asked in Developer Tools, Integration and Automation
uninstall agents on windows machines (ansible)

Dear all,I am trying to find a way to uninstall the commvault file system agent on some Windowss Virtual machines. We want to keep only Vmware Snapshot backup and sql agent inside the VM.Do you have any clue on where to find the rights commandsWe use ansible, and actually it works only for linuw machines. Thanks ! 

2456
Graham Swift
Vaulter
J
Bit
JayBRBit
asked in Developer Tools, Integration and Automation
Problem with API access through API Explorer

Hello community,We’ve been trying to retrieve a QSDK token in Swagger API Explorer to develop some custom tools and we always get the below error even when we try to log in with csadmin (and yes the password is converted to Base64).Are there any Advanced\Additional Settings that need to be added to the Web Server object in order to access the web service? Thanks for your help!"errLogMessage": "Username or password is incorrect", "errorCode": 1117

5214
Mike Struening
Vaulter
V
Bit
VladimirPBit
asked in Developer Tools, Integration and Automation
REST API call for PowerShell command Get-CVVirtualMachine

What can replace the "Get-CVVirtualMachine" PowerShell command in the Commvault REST API?I use the "Get-CVVirtualMachine -Protected" command to get a list of virtual machines that are being backed up so that I can start a restore.Looked at the API page on my Commvault server (https://CommvaultSRV/webconsole/sandbox/apiexplorer/#/Virtualization%20Operations) and I couldn't identify any GET command that would give me the same result as the PowerShell command. Does anyone have any idea how to get a list of all protected VMs from Commvault REST API?

1543
Onno van den Berg
Commvault Certified Expert
description of image

Badge winners

Show all badges
Terms & ConditionsCookie settings