commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 422 Topics
  • 1,928 Replies

422 Topics

M
Bit
MikeDRGBit
asked in Developer Tools, Integration and Automation

REST API Call to get all devices which are currently backed up

Hello everyone,I’m quite new to Commvault and only the “secondary admin” but the API guy in the team. We’re running Commvault 11.32.45 in a local VM and have several media agents across our datacenters (no cloud anywhere).I want to get all the devices which are backed up with any job right now. I don’t care if it’s a VM or a physical machine, a database server or a file server. All I need is the device name and maybe the backup job backing up the device.I want to use this information to request details per device from our central DCIM (Netbox) and create a simple list of devices + details.I managed to get clients and subclients via the api but it’s very confusing. There seem to be several apis and several documentations for them.What’s the currently recommended API in general? webconsole, commandcenter, WebServerCore, CVWebService.svc? Which documentation should I follow? documentation.commvault.com, api-next.commvault.com, one I didn’t find yet? Is there a straight forward way to get

7
H
Vaulter
14 hours ago
R
Byte
Rahul NairByte
asked in Developer Tools, Integration and Automation

Create multiple datasource table Group wise in horizontal table with total count

Hi Team, I am trying to prepare a custom report in which i want to have a Dataset which should give the output in horizontal tabular format. below is the sample screenshot which should be in horizontal. Basically i want to have horizontal table for each group showing job history count in similar below format. In single report there wll be multiple table with different groups. We dont want to have input. Something similar to below query for example:Select ABC group from XYZ Commcell showing job history with “xyz” fields for last 1 month. 

0
R
Byte
17 hours ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation

Need deleted VMs details from vCenter on Commvault.

I need the api that gives the deleted VMs list from the vCenter. As per the document:https://documentation.commvault.com/v11/essential/rest_api_get_virtual_machines.html I should get isDeleted in status info as a response but I didn’t see anything like that when I ran the Get VM api:import requestsimport jsonurl = "https://win/commandcenter/api/V4/VirtualMachines"payload={}headers = { 'Accept': 'application/json', 'Authtoken': '***'}response = requests.request("GET", url, headers=headers, data=payload, verify=False)pretty_json = json.loads(response.text)print (json.dumps(pretty_json, indent=2))reponse: { "name": "test", "vendor": "VMW", "displayName": "test", "hypervisor": { "id": 26, "name": "vcsapro293045.bgl1.global.tslabs.hpecorp.net" }, "vmGroup": { "id": 0, "name": "" }, "backupset": { "backupSetId": 0, "backupSetName": "" }, "os": "CentOS 9 (64-bit) ", "host": "", "status": "

4
R
Byte
1 day ago
C
Bit
Chaturvedi2809Bit
asked in Developer Tools, Integration and Automation

Automate daily/weekly repetitive tasks like latest backup status, rerun the failure after troubleshooting.

Hi Techies,Greetings !Is there any possibility that we can automate daily/weekly repetitive tasks and reduced manual efforts.Here are the few examples:→ Latest backup status information from client or other team members on tickets.→ Virtual Server removal tasks before decommissions request.→ Agent uninstallation and license removal of clients after site decommission.→ Manual retention extension tasks to retain backup till specific date.Here I want to reduce manual efforts and time, please share some ideas to achieve this. Thak you ! 

1
B
Vaulter
10 days ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation

Running commvault APIs from a jump server instead of commvault server

Hi Team, I have written a script that would delete the decommissioned VMs from the commvault. I have 2 questions.As of now my script takes the client id manually to delete the VM. I would want Commvault to detect the decommissioned VM and delete it. Please guide me on how can I add auto detect of decommissioned VMs on my script.  I have to integrate Morpheus API and Commvault API and execute the script from the Jump server from where Morpheus is accessible. As of now, Commvault APIs are running only from Commvault server. How to do this ?

1
J
Vaulter
10 days ago
T
Bit
Tai NguyenBit
asked in Developer Tools, Integration and Automation

Hardware Refresh - Replace MediaAgent (app) - Commvault version. (11.28.91)

Hi Support TeamHas anyone encountered and resolved an issue where, after replacing a MediaAgent using the app, the new MediaAgent does not appear in the Storage Policy's primary copy? I'm unsure how to fix this and add the new MediaAgent to the primary copy. (The Jobs for replace mediagent showing all completed)Best RegardsTai Nguyen

4
T
Bit
11 days ago
N
Bit
NeerajBit
asked in Developer Tools, Integration and Automation

Disable backup activity for VM for a specifc subclient

I have a situation here, after migration from 11.28.72 to 11.32.45, VM which were added using VM rules using VM tags appeared in different subclient of a Vcenter virtual server and it is impacting SLA since now the VM tag issue is resolved and backup in running under one subclient. Now i need to disable backup activity for the client for other subclient except the original subclientcurrently the VM is appearing in only ine subclient of the vcenter virtual server which is JPAWP, and the VM is not available or not showing under any other subclient. But when we check individual VM , it shows multiple backupset/subclient and it is impacting the SLA. Now i need to disable the backup activity for the VM, for specifc backupset/subclient. Do not disable backup activity on client level because the VM is curently backing up in its original subclient.Now i need to disable backup activity for the VM for all the subclient except the orignal subclient which is JPAWP here.I am creating workflow to ac

8
christopherlecky
Byte
12 days ago
P
Bit
Prashant MallBit
asked in Developer Tools, Integration and Automation

API Endpoint to GET Storage Policy

Hey,Which API endpoint to use to get Storage Policy for a client? My requirement is to get Storage Policy for all clients, preferably without querying for each client individually. For VM client, I can use the /VM endpoint which lists all the VM with their Storage Policy. I need help with FS clients. Thank You.

4
christopherlecky
Byte
12 days ago
chrisknows
Byte
chrisknowsByte
asked in Developer Tools, Integration and Automation

is there an api equivalent of "create vm client"?

What this does is a discovery on a hypervisor sub client and creates a vm pseudo client for any discovered virtual machines.The functionality is outlined here:https://documentation.commvault.com/11.26/expert/104558_creating_vm_clients_before_performing_backup_operations.html In practice it looks like this.   Thanks!Chris

13
christopherlecky
Byte
13 days ago
P
Bit
Prashant MallBit
asked in Developer Tools, Integration and Automation

How to know when a failover happened and to which node using REST API?

Hey! I am developing automation scrips using Commvault APIs for my team. I know the names of primary commserve which I use, BUT whenever a failover happens my API calls of course don’t work as there is no web service active on the primary commserve.  Is there a way to know which node the failover happened to using just the APIs? And also get the list of all failover nodes?  

1
A
Vaulter
14 days ago
M
Byte
Michael SeickertByte
asked in Developer Tools, Integration and Automation

Restore SQL database to Availability Group

via Command Center it is not possible to restore a SQL-database “in place” to an availability group. Does anybody have a workflow or Powershell-Script that can remove the database from the availability group before the restore … and back to the availability group after the restore? Any help is very much appreciated. Best regards. Michael

2
M
Byte
14 days ago
P
Bit
Prashant MallBit
asked in Developer Tools, Integration and Automation

GET description of client in /Client

Hey,I am getting all clients and basic details with /Client endpoint. Is there a way I can also get the client description without making individual API calls for each client?  Thank You.

3
christopherlecky
Byte
16 days ago
R
Byte
Rahul NairByte
asked in Developer Tools, Integration and Automation

Need to use object from two List as different parameters inside For Each Loop

Hi Team, I have two different lists with names in it. I want to use each value from both the list inside for each how that can be done in workflow? <App_SetClientPropertiesRequest>    <association>        <entity>            <clientName>xpath:{/workflow/ForEach_1/OldName}</clientName>            <newName>xpath:{/workflow/variables/new_name}</newName>        </entity>    </association>    <clientProperties>        <client>            <clientEntity>                <clientName>xpath:{/workflow/ForEach_1/OldName}</clientName>            </clientEntity>        </client>    </clientProperties></App_SetClientPropertiesRequest> xpath:{/workflow/variables/new_name} has a list of names which is not working, everytim it is taking same object it also should work as ForEach value which can be used, any idea or suggestion

7
christopherlecky
Byte
23 days ago
N
Bit
NeerajBit
asked in Developer Tools, Integration and Automation

creating SP_GDSP as a global non-deduplication policy using worklow

Creating a Global Non-Deduplication Enabled Storage PolicyOnce you create a global non-deduplication policy, you can use it to enable global non-deduplication for any storage policy.Download the SP_creation.xml file and save it on the computer from where the command will be executed. Before running the command, review the Available Parameters for Storage Policy Configuration. Execute the following command from the software_installation_directory**/Base folder after substituting the parameter values. qoperation execute -af <downloaded location>\sp_copycreation.xml -storagePolicyName 'xxxxx' useGlobalStoragePolicy 1 -useGlobalPolicy/storagePolicyName "xxxxx" -retainArchiverDataForDays xx -retainBackupDataForCycles xx -retainBackupDataForDays xx -copyName 'xxxxx'       For example, to create a global non-deduplication enabled storage policy, with name SP1, that is using SP_GDSP as a global non-deduplication policy, execute following command: Here it is creating a stroge policy using

1
S
Vaulter
24 days ago
N
Bit
NeerajBit
asked in Developer Tools, Integration and Automation

send response back to vra/vro at the end of calling the workflow throught REST API call

I have created a workflow to configure Azure NetApp NAS Storage Backupnow i am calling this workflow from VRA/VRO through REST API , VRA/VRo teams wants more details on response after executing the workflow with the success staus of the client configurationAs of now VRA/VRO receives on the workflow execution job ID, after rest api call.  VRA admin needs to have more details send back to VRA as response , like the workflow execution staus, client creation status. How i can achieve this ?  

2
N
Bit
27 days ago
M
Byte
ManojRByte
asked in Developer Tools, Integration and Automation

Description of columns for cf_SurveyLibraryThroughput table under CVCloud Database

Where do we get Description of columns for cf_SurveyLibraryThroughput table under CVCloud Database.What is the formula to get avg throughput per day from these parameters in the table[cf_SurveyLibraryThroughput ]? 

8
H
Vaulter
27 days ago
N
Bit
NeerajBit
asked in Developer Tools, Integration and Automation

created s3 cloud library , now I need to share the mount path to another MA agent using workflow

I have created s3 cloud library , now I need to share the mount path to another MA agent.https://documentation.commvault.com/2022e/expert/adding_new_mediaagent_to_cloud_storage_device.htmlBy Using Device IDhttps://documentation.commvault.com/2023e/expert/files/products/media_agent/xml/ShareMountpath.xmlYou can use the device ID to share a mount path with one or more MediaAgents Here I can see sharing mount path using device IDs, I need the same using names, not IDs I can see xml parameter for Disklibrary , need xml file for cloud lbrary – mount path sharing.

2
T
Vaulter
27 days ago
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
28 days 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
29 days 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
30 days 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
30 days 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
1 month 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
1 month 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
1 month 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
1 month ago

Badge winners

Show all badges
Terms & ConditionsCookie settings