Skip to main content

Developer Tools, Integration and Automation

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

  • 475 Topics
  • 2,062 Replies
475 Topics
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Calling a process block multiple times from within a script.

I have the following function setup in a script : JSONObject getVmwareApiOutput(String apiUrl, String vCenterSessionToken){ ExecuteSuperProcess getVmwareApi = new ExecuteSuperProcess(); getVmwareApi.processBlock = WorkflowElement.parse("<processBlock>pbGetVmwareApi</processBlock>"); getVmwareApi.inputs = WorkflowElement.parse("<inputs><url>" + apiUrl + "</url><vmware-api-session-id>" + vCenterSessionToken + "</vmware-api-session-id></inputs>"); getVmwareApi.execute(workflow); JSONObject vmWareApiOutput = new JSONObject(xpath:{/workflow/variables/restCallOutPut}.replace("[","").replace("]",""));return vmWareApiOutput;} This works fine the first time I call the script.But subsequents calls result in the following: 9908 ExecuteSuperProcess     : [Search vCenters for Virtual Machines (scrSearchForVirtualMachine)] process block for super process id [9321], has already completed9908 ExecuteSuperProcess     : [Search v

2
christopherlecky
Byte
5 months ago
A
Bit
Andrey2024Bit
asked in Developer Tools, Integration and Automation
Get all Clients properties

Hello everyone, please help me understand if there is such an opportunity in the api? There is such a method - according to the cat, I can get a request from the developers of Commvault - GET <webservice>/Client HTTP/1.1 Yes, it returns a list of all objects, but there is not complete information about the object and there is a method for obtaining complete information - GET <webservice>/Client/{ClientID} HTTP/1.1 The question is that I have a list of unique IDs or Names and I want to upload full information on them right away, but there is no way in Python to do this. Is it possible to do this at all, or will you have to cycle through all the IDs and unload them piece by piece and slowly?

6
H
Vaulter
5 months ago
clecky
Vaulter
cleckyVaulter
asked in Developer Tools, Integration and Automation
Is there an easy way to unlock a workflow?

Every once in a while my Java session will crash and leave a workflow “locked” By me, and it won’t allow me to make modifications. I know that restarting the workflow services will unlock it, but there is a way that doesnt require cycling services?

3
Scott Moseman
Vaulter
5 months ago
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Java imports failing

The following imports:import commvault.cte.workflow.activities.HttpClient;import commvault.cte.workflow.types.WebRequest;import commvault.cte.workflow.types.NameValue;import commvault.cte.workflow.types.WebMethod;Produces the following:Script1.groovy: 8: unable to resolve class commvault.cte.workflow.types.WebRequest @ line 8, column 1. import commvault.cte.workflow.types.WebRequest; ^Script1.groovy: 9: unable to resolve class commvault.cte.workflow.types.NameValue @ line 9, column 1. import commvault.cte.workflow.types.NameValue; ^Script1.groovy: 10: unable to resolve class commvault.cte.workflow.types.WebMethod @ line 10, column 1. import commvault.cte.workflow.types.WebMethod; ^ 

3
christopherlecky
Byte
5 months ago
D
Byte
Dipayan SarkarByte
posted in Developer Tools, Integration and Automation
The response value of Virtual Machine Backup API is not in the right JSON format.

Hello, I'm trying to use the API for virtual machine backup. When I run the Go Lang API sample, the API call works, but the JSON response appears to be not in correct format, as shown in the example below.}7101"d":2706,"jobIds":[I tried changing the "Accept" and "Content-Type" headers to XML to see if I could receive the response in XML, but this does not work for this API, despite working for a few other APIs.However, when I do this API call using POSTMAN, I get a JSON response in format.{ "taskId": 2655, "jobIds": [ "7045" ]}What seems to be the issue here? I need to make the call using Go Lang.API : Backup virtual machines | Commvault®

0
D
Byte
5 months ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Deleting the decommissioned VMs from commvault using the rest api

I have to remove/Delete the VM from commvault using the Rest APIhttps://api.commvault.com/docs/api/cv/OpenAPI3/delete-virtual-machine I have tried test running the api using python and I got the below mentioned error:C:\Users\Ansible_user\Downloads>python vmdel.py WIN-C6TBRLJG6IM <commandcenter username> <commandcenter passwordimport requestsimport urllib#proxies={ #'http':'http://10.***.***.***:8080', #'https':'http://10.***.***.***:8080'#}url = "https://win-c6tbrljg6im/commandcenter/api/V4/VirtualMachines/:<VM UUID>"payload={}headers = { 'Accept': 'application/json', 'Authtoken': '*******'}response = requests.request("GET", url, headers=headers, data=payload, proxies=urllib.request.getproxies())print(response.text)>Traceback (most recent call last):  File "C:\Users\Ansible_user\AppData\Local\Programs\Python\Python312\Lib\site-packages\urllib3\connectionpool.py", line 779, in urlopen    self._prepare_proxy(conn)  File "C:\Users\Ansible_user\AppData\Local\Program

5
R
Byte
6 months ago
B
Bit
BezzarBit
asked in Developer Tools, Integration and Automation
REST API - GET Job - with job filter

HII working with rest api I have a process for checking daily backupsThe process works fine!I need help running a backup check  between  dateFeb 01, 2024 12:00 AM and Feb 29, 2024 11:59 PMThis is for example part of a URL that I access to get a daily reporturlrest = "/webconsole/api/Job?jobFilter=Backup&jobCategory=all&completedJobLookupTime=86400&limit=500"; // 24 hoursAny help will be appreciated

7
C
Vaulter
6 months ago
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Query vCenter for a vm, without creating a subclient?

I am looking to use the vmname to get the details of a vm without having to generate a subclient.Essentially I need the API equivalent of this : When I click preview it searches vcenter, I want the query generated and the  output of that search. Thanks.  

4
christopherlecky
Byte
6 months ago
K
Keshav Sawant
asked in Developer Tools, Integration and Automation
how to add active directory user in commvault commcell user

how to integrate the active directory user in CommVault CommCell console.is there any LDAP configuration require or any other process.  (Actually I have a created normal user in CommCell and assigned the role also, it is working. ) 

2
S
Vaulter
6 months ago
Onno van den Berg
Commvault Certified Expert
Onno van den BergCommvault Certified Expert
asked in Developer Tools, Integration and Automation
Who seeks protection for Jira Cloud??

I'm curious to learn if there are other Commvault customers who are looking for data protection for Jira Cloud or currently have a point solution running to protect the data that resides in Jira Cloud.

3
Onno van den Berg
Commvault Certified Expert
6 months ago
G
Bit
gszollBit
asked in Developer Tools, Integration and Automation
Alert via Access nodes?

Hi,We are trying to configure Alerts for failed backups. Tested a few scenarios out and it seems there is no way to get notified about failed backup via the access nodes.The access nodes(proxies) are carrying out backup jobs for multiple instances and hoped we would be able to set up only 1 alert definitions for those instances instead of creating individual alerts for all our instances. (plus we hope to be future proof with this, so if any new instances are being onboarded, then we don’t need to amend/create any alerts).Could you confirm that failed backup alerts cannot be configured via access nodes in such way?Is there any alternative that allows us to automatically add newly onboarded instances to alerts to check for failed backups?

3
G
Bit
6 months ago
N
Byte
NeerajByte
asked in Developer Tools, Integration and Automation
workflow or REST API call or Qcommands to delete client VM client and Agent base client

I want to automate deletion of client which is already retired, please assist with correct article.I used below , <App_DeleteClientRequest><association><entity>                                             <clientName>xpath:{/workflow/ProcessBlock_6/pb_client}</clientName></entity></association></App_DeleteClientRequest> but gets below error. Delete client automation , automatically evokes DeleteClientAuthorization, not sure what to do here. Error Code: [19:857]Description: startup failed: Script1.groovy: 7: Unexpected input: '{ timeout = v_26695f15_7028_414d_a7c7_a074e9e7358f * 1440*60; //Convert timeout in days to unix time workflow.setVariable("VAR_TIMEOUT",timeout); } else { workflow.setVariable("VAR_TIMEOUT",14400*60); //If timeout is not set in configuration, set default timeout as 10 days and converting it to unix time }' @ line 7, column 371. d converting it to unix time } ^ 1 errorSource: ap1smacvcmc002, Process: Workflow 

3
christopherlecky
Byte
6 months ago
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
Using the httpclient activity in a Java script

Does anyone have a quick rundown on what methods to use to set the httpclient methods and execute?I know it goes something like so : import commvault.cte.workflow.activities.HttpClient;def httpclient = new HttpClient(); But then what next? How do I set the http method, headers and, and url? 

1
christopherlecky
Byte
6 months ago
G
Bit
gszollBit
asked in Developer Tools, Integration and Automation
Default Dump based backup set configuration

Hi,I’d like to enable parallel backup config for PostgreSQL databases. I can see I can modify the parallel dump based back up set config to enable parallel backups, but wondering if the default dump based backup set config can have this feature enabled by default?I don’t find any related article about it.For reference, this is the attribute I’d like to get enabled by default:https://documentation.commvault.com/2024/essential/using_parallel_jobs_to_dump_postgresql_database.html Thanks,

2
G
Bit
6 months ago
S
Byte
sinanByte
asked in Developer Tools, Integration and Automation
Fetching job history for the 24 hours issue

I am working on a code to fetch all jobs for a spesific client group and count each job status so that I can preprare a report to display all jobs status for the last 24 hours. But “lookup_time” is not working as expected, less job fetched. Even changed the time for the lookup_time with different hours but the output is alwasy the same. I think lookup_time is not working as it should. Do you have any idea why it is not working ?   jobs_last24hours = job.finished_jobs(client, lookup_time=24)

1
S
Byte
6 months ago
T
Byte
tonytonyByte
asked in Developer Tools, Integration and Automation
REST API to create MSSQL Server AvailabilityGroup

I am working on automation which installs SQL iDataAgent on new clients and also creates AG (Availability Group) Instance.I have found this API endpoint to push install the MSSQL iData Agent on the servers but I can’t find an example of creating AG Instance via API.

4
T
Byte
6 months ago
A
Byte
AdamDavenportByte
asked in Developer Tools, Integration and Automation
All Active Jobs Report

All,I’m looking for some guidance. There is a report that can be installed from the CV Store that claims to show “Active Jobs” and it does so, but only backup type jobs. Is anyone aware of a report like this but that shows Administrative type jobs as well? Essentially what I’d like to do is create a custom dashboard that would show any jobs that would be running in the job controller plus some other data/metrics. I want all this data to come from the Metrics Server’s CVCloud database. The table is there for the Admin jobs, so I know the data is there. I unfortunately don’t know anything about the report builder and/or MS SQL to build a customer report. It would be nice if this came as a canned report, but I haven’t found one. Thank you in advance for any and all guidance/input. Adam Davenport 

13
A
Byte
6 months ago
B
Byte
barbarosByte
asked in Developer Tools, Integration and Automation
Commvault humio

Hello All,Does Commvault have integration with Humio? Thanks in advance Regards   

1
S
Vaulter
6 months ago
0
Byte
0ber0nByte
asked in Developer Tools, Integration and Automation
Creation Authtoken and accepting it

Hi Team, I'm very new to the Rest API, but I was only able to create an authtoken :) As far as I learned, when the authtoken is created, the max. It can be used for 30 days. After this period, it is necessary to create a new authtoken and use the new authtoken. We are thinking something like this, Is it possible to do this?We are trying to create a powershell script, this script will create a new authtoken every time it runs and will automatically use the new authtoken, then we will be able to GET the information we want from Commvault. Rest

1
J
Byte
6 months ago
U
Bit
UchennaBit
posted in Developer Tools, Integration and Automation
DELETE SCHEDULE POLICY USING PYTHON OR POSTMAN REST

Hello Vaulters, I have been to automate schedule policy delete using by calling the API using the syntax on the document but I keep facing error, does any one have an already executed script or guide and how to achieve this?

9
H
Vaulter
6 months ago
P
Byte
Prashant MallByte
asked in Developer Tools, Integration and Automation
How to add VM Filters on Backupset via API?

Hi! I am trying to add a VM Filter via API for the Backup Set - how to achieve this via API?

1
H
Vaulter
6 months ago
J
Byte
johanningkByte
asked in Developer Tools, Integration and Automation
Is it possible to use gMSA for User Domain Integration ?

Hi,is there any option available to use Microsoft’s Group Managed Service Accounts as Service Account to add a Windows User Domain to Commvault ?Meanwhile regular Service Accounts require to change their password from time to time which always leads to problems with Commvault User Authentication ….BRKlaus

1
K
Vaulter
6 months ago
R
Byte
Rahul NairByte
asked in Developer Tools, Integration and Automation
Commvault Database to see schedule policy assigned to a VM

Hi Team, I want to see schedule policy which is assigned or which ran for a VM backup job. From ComcellBackupInfo, i am able to get all the details related to Backup job but only schedule name is not available. Is there any other databse or table using which we can fetch this information.

6
H
Vaulter
6 months ago
D
Byte
Dipayan SarkarByte
asked in Developer Tools, Integration and Automation
ResAPI for restore responding with error "ClientInfo is not complete","errorCode":9517

Hello, I am trying to test the Retrieve to Client (Restore) API following the document  Retrieve to Client (Restore) | Commvault®. I tested the API with both Postman and Golang, and both times I received an error in response. The error is pasted below."ClientInfo is not complete","errorCode":9517Please see the sample GoLang code below. I followed the example in the Commvault rest API docs, but I can't figure out what's missing here. package mainimport ( "crypto/tls" "fmt" "io/ioutil" "net/http" "strings")func main() { url := "https://hostname/commandcenter/api/retrieveToClient" method := "POST" payload := strings.NewReader(`{ "mode": 2, "serviceType": 1, "userInfo": { "userGuid": "da752adf-79f0-47d6-8be5-d3dadc9abc5e" }, "advanced": { "restoreDataAndACL": true, "restoreDeletedFiles": true }, "header": { "destination": { "clientId": 171, "clientName": "<<clientname>>", "inPlace": false, "destPath": [ "C://Users//Administrator//Do

6
D
Byte
6 months ago
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation
How do I create a list entities to populate a dropdown?

Is it as simple as create an XML representation of the entity list?  I have been attempting to create it via Java with strange results.  

2
christopherlecky
Byte
6 months ago

Badge winners

  • Solver 1
    Deepthihas earned the badge Solver 1
  • Topic Starter 1
    jlintsihas earned the badge Topic Starter 1
  • Contributor 1
    Dan Rhas earned the badge Contributor 1
  • Topic Starter 1
    Kuweekeehas earned the badge Topic Starter 1
  • Contributor 5
    Nikhil Guptahas earned the badge Contributor 5
Show all badges
Terms & ConditionsCookie settings