Skip to main content
commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 538 Topics
  • 2,228 Replies
539 Topics
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
VM backup API returning internal server error

I need to backup VMs and I am using the below API:(tried both of them) https://api.commvault.com/docs/SP34/api/cv/OpenAPI3/virtual-machine-backup https://api.commvault.com/docs/SP34/api/cv/VirtualizationOperations/perform-vm-backup But they are not working and throwing internal server. Can someone help me with this. P.S. I am testing it on a test commvault with similar environment to production. Below are the logs for one of my API calls: 14536 175 05/31 11:44:36 175 admin - WEBAPI-STARTED processing [POST]:[/v4/VirtualMachines/52c0fb3f-9cf0-ea0c-6518-ff20a5d37a6f/backup] request. : /v4/VirtualMachines/52c0fb3f-9cf0-ea0c-6518-ff20a5d37a6f/backup : Parameters : [backupLevel=FULL] : AdditionalInfo[ ConsoleType[API]]14536 175 05/31 11:44:36 175 admin GetTemplateInfoForAPI - Pipeline Stages selected : default14536 175 05/31 11:44:36 175 admin ProcessStep - Pipeline stage 'default' will be executed14536 175 05/31 11:44:36 175 admin ProcessStep - Request from the pipeline after rendering: 14

1212
R
Byte
V
Bit
VladimirPBit
asked in Developer Tools, Integration and Automation
Cannot restore VM to different VMware vCenter

I restored a VM from a backup to another VMWare vCenter manually from the Commvault console. Then I tried the same from a PowerShell script using the REST API. Thanks to @Jos Meijer help I was able to execute the code, the job was created and started. After a while, Commvault reported that the job failed with the error message "Unable to modify the VMX file to restore the virtual machine." Does anyone know why it works fine from the Commvault console and not when the same VM is restored using the REST API? What can I check regarding the error message? I researched this error message on Internet but didn't find any helpful articles. ​ ​

86612
Onno van den Berg
Commvault Certified Expert
L
Bit
Lukasz JaroszBit
asked in Developer Tools, Integration and Automation
OID SNMP MIB Simpana.mib

Hello. I have a questions about MIB.1. Where I find a link in the documentation to the latest MIB file with the latest OIDs? Is there a place on the Commvault 11.32 server where I can find this file?2. How often is the MIB updated?

2971
L
Vaulter
A
Bit
Akshay1998Bit
asked in Developer Tools, Integration and Automation
Silent/Automatic Software Agent Deployment via Script for Endpoints Laptops and desktops

I'm working on a project where I need to deploy a software agent to endpoint devices. The requirement is for the deployment to be completely silent and automatic, initiated by a script running on the user's device. Here are the specific details: The script will download the agent from a cloud storage location (e.g., S3 bucket). The downloaded agent will then be automatically installed on the user's device. The entire process should be seamless and require no user interaction. Can someone please help me with the script or any other approach I can take here? Thanks!

481
A
Vaulter
M
Bit
mjcBit
asked in Developer Tools, Integration and Automation
API to Get the summary for a specific job mistake

I am in SP32 version . When I try to get summary for a jobid, the response content 100 jobs details instead of my only mine. FYI my jobid is not in the response ;-( GET {{serverurl}}/Job/15848821555 accept: application/json Authtoken: {{auth_token}} I suppose that is because the job id is hight, but the response is incorrect, What is the problem ?

232
christopherlecky
Byte
A
Bit
Andrew StrömBit
asked in Developer Tools, Integration and Automation
Simcallwrapper set plan for client?

We are automating CV client installations by registering a Decoupled installation using simcallwrapper. Is it possible to associate or change backup plan for the client using simcallwrapper ? I can only se this flag -subclientPolicy but dosent seem to work?

752
Onno van den Berg
Commvault Certified Expert
T
Byte
tonytonyByte
asked in Developer Tools, Integration and Automation
Assign Storage Policy to SQL Server Subclient

I am using CVpySDK and trying to assign storage policy for a client that currently doesn’t have a storage policy. I tried the code below from the documentation but it didn’t work: client = commcell.clients.get(client_name) agent = client.agent.get(‘sql server’) backupset = agent.backupset.get(‘defaultBackupSet’) subclient = backupset.subclients.get(‘default’) subclient.storage_policy = ‘MyStoragePolicy’

451
S
Vaulter
L
Byte
lborekByte
asked in Developer Tools, Integration and Automation
add mysql instance

Hi, We are trying to add mysql instance, but both cvpysdk and API failed to do so. For cvpysdk i opened github issue, but not sure it’s actively maintained? For API, using this page and example values: curl -k -L -X POST 'https://commsrv/commandcenter/api/Instance' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer [...]' \ --data-raw '{ "instanceProperties": { "instance": { "instanceName": "aymasterr_3306", "applicationId": 104, "clientId": 461, "clientName": "a-o0" }, "mySqlInstance": { "BinaryDirectory": "/usr/bin", "LogDataDirectory": "/var/lib/mysql", "ConfigFile": "/etc/my.cnf", "port": "/var/lib/mysql/mysql.sock", "EnableAutoDiscovery": true, "SAUser": { "userName": "root", "password": "cm9vdAo" }, "proxySettings": { "isProxyEnabled": false, "proxyInstance": { "instanceId": 0 }, "isUseSSL": false, "runBackupOnProxy": false }, "xtraBackupSettings": { "enableXtraBackup": true, "xtraBackupBinPath": "/usr/bin" }, "mebSettings": { "enabl

1164
L
Byte
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
subclient Id is different on url and API gives different ID

I need an API endpoint to fetch the subclient id. For testing purpose I copied the ID from the url: https://win-igicqf1affn/commandcenter/#/collectionDetails/content/3/10 In the above mentioned URL 10 is the subclient id. I have used it in other API endpoints. But when I use the api in order to fetch the subclient id it gives me 14 instead of 10. Below are the links to APIs I have been manipulating. https://api.commvault.com/docs/SP34/api/cv/VirtualizationOperations/update-subclient-virtual-machine-content https://api.commvault.com/docs/SP34/api/cv/SubclientOperations/get-subclient-properties The api that is giving me a different subclient id: https://api.commvault.com/docs/SP34/api/cv/SubclientOperations/get-subclient-id import requestsimport json url = "https://win-igicqf1affn/commandcenter/api/subclient?clientId=8" payload={}headers = { 'Accept': 'application/json', 'Authtoken': 'token'} response = requests.request("GET", url, headers=headers, data=payload, verify=False) pretty_json

502
R
Byte
S
Byte
samyrByte
asked in Developer Tools, Integration and Automation
Custom Alert

Hello all, I search to create a SQL alert in order to notify me if an agent have no schedule policy associated. I found an sql query…. but not sure of it. Can you help me ? Thank you ! use commserv select distinct CommCellSubClientConfig.clientname, CommCellBkScheduleForSubclients.scheduePolicy, CommCellBkScheduleForSubclients.scheduleName, CommCellBkScheduleForSubclients.schedbackuptypefrom CommCellSubClientConfig join CommCellBkScheduleForSubclientson CommCellSubClientConfig.appid = CommCellBkScheduleForSubclients.appid

321
Erase4ndReuseMedia
Byte
H
Bit
Heemansu GehlotBit
asked in Developer Tools, Integration and Automation
API to Fetch "Reason for job delay" (error/Failure message of job)

Can you please provide API to Fetch "Reason for job delay" message (error/Failure message of job)

391
S
Vaulter
S
Byte
samyrByte
asked in Developer Tools, Integration and Automation
create a report of schedule policy

Hello, I have many backup database to enable / disable and some times we forgot to renable it. Is there a report to view schedule policy checked and unckecked ? Or how can i create it ? Thank you for your help.

673
J
Vaulter
J
Byte
Jacob.spByte
asked in Developer Tools, Integration and Automation
Delete VMDisk Filter doesnt work

Hello, does anyone know how to delete Disk Filters on a Hyper-V Subclient via qcommand? Add works, modify works but delete doestn do anything to the filters. Im Using this XML: documentation.commvault.com/2023e/expert/files/products/vs_vmware/command_line_xml/update_disk_filters_template.xml And the job is running (any spelling error results in pending jobs) but nothing happens to the filters. XML Parameters for Microsoft Hyper-V Backup Set Configuration (commvault.com) In the xml i’m just swapping “ADD” to “DELETE” and this entry should have been removed. Thanks for help and regardsJacob

232
J
Byte
A
Bit
alexmcBit
asked in Developer Tools, Integration and Automation
How to get all the agent id and agent name that exist?

I can't find any url that I can attack to return these values.

956
A
Bit
A
Bit
alexmcBit
asked in Developer Tools, Integration and Automation
How can I get the backups of the last 24 hours of the SQLServer?

I am trying to get the different backups from the sql database, but I can't find the way without having to go through client, instances....

342
Scott Moseman
Vaulter
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation
qcommand or the CS view which contains the information for GET Failed Items in a Job (API)

I would to get the list of failed items (details) using cli/ SQL command I’m trying to create an event/ custom report for whichever option which reports more than 0 failed items and trying to gather the details per job. The cli/ Commserve Table/View that’s equivalent to the following API https://documentation.commvault.com/2024/essential/get_failed_items_in_job.html GET <webservice>/Job/{{jobId}}/FailedItems Host: <host name> Accept: application/json Authtoken: <authentication token> or the table/view where this API is fetching the data Thanks in advance.

313
H
Vaulter
T
Byte
TNOByte
asked in Developer Tools, Integration and Automation
REST API to check last successfull Full / Synthetic Full job and its retention

Hello, We are looking for the REST API to check last successfull Full / Synthetic Full job and its retention of a specific client. Preferably one API call for both ( job date + retention ). Any Ideas ? Thanks

231
A
Vaulter
N
Byte
NeerajByte
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 Backup now 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 configuration As 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 ?

393
N
Byte
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Delete manually added VMs from content via api

I have used the apis to retire and delete the VMs but since the VMs are added everytime manually in the subclient, I would like to use the API to remove it from the content as well. I used the below mentioned API and it deletes the complete content. I just want one VM to be removed. import requests url = "https://commandcenterhostname/commandcenter/api/Subclient/100/content" payload = json.dumps({ "children": [ { "allOrAnyChildren": True, "displayName": "test", "equalsOrNotEquals": True, "name": "503a1c32-6616-10ds-k9l8-130535306451", "path": "" } ]})headers = { 'Content-Type': 'application/json', 'Authorization': '*token*'} response = requests.request("PUT", url, headers=headers, data=payload, verify=False) print(response.text)

391
A
Vaulter
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
Need to delete the VMs from content as well as it reappears

I need the api to get the contents of the of the subclient and then remove/delete it from the content itself.

282
A
Vaulter
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation
API to launch VM backup job

I am trying to launch VM backup via API but the api is not returning anything and there is no log in webserver.log. url = "https://commandcenterhostname/commandcenter/api/v2/vsa/vm/{{GUID}}/backup?backupLevel=FULL" import requests url = "https://commandcenterhostname/commandcenter/api/v2/vsa/vm/503RF3C6-03BC-24M9-7MVV-3833433C96AB/backup?backupLevel=FULL" payload={}headers = { 'Accept': 'application/json', 'Authtoken': '**Token**'} response = requests.request("POST", url, headers=headers, data=payload,verify=False) print(response.text) There is no return code or output from running the api.

362
R
Byte
A
Byte
AndyCByte
asked in Developer Tools, Integration and Automation
BMC - Entuity Integration

BMC - Entuity Integration Has anyone had any experience of integrating CommVault with BMC - Entuity for network infrastructure monitoring, Looking at monitoring CommVault jobs within Entuity as a ‘one pane glass’ SIEM.

974
O
Bit
D
Byte
dorotaByte
asked in Developer Tools, Integration and Automation
Continuous Data Replication (CDR) and Network Topology

Hi, is it possible to run continuous data replication (CDR) using the Network Topology functionality? The point is that the source and destination servers are in different network segments and do not communicate with each other - but both communicate with MediaAgent. Is it possible to setup such configuration to perform replication using gateway (MediaAgent)? Regards Dorothy

211
Damian Andre
Vaulter
A
Bit
AleAleBit
asked in Developer Tools, Integration and Automation
How can I force discovery my postgresql instance from api or cvpysdk in python cvpysdk ?

Hi,i conosle I can click Discover Instance: But I must do the same from api or cvpysdk ? Perhaps, Can I do the same for agent (host with postgresql (linux)) ? brK

331
A
Bit
Richard Kent
Byte
Richard KentByte
asked in Developer Tools, Integration and Automation
Chain Schedule Jobs

Hi, I have several NDMP jobs that I need to run but due to the hardware having a 16 NDMP connection limit, I need to allow each schedules jobs to complete before initiating the next schedule. I am aware that a workflow may be the solution but wondered if anyone had any templates or guides to create the workflow as I am at a loss with the Workflow designer. The schedule has 15 sub-clients in each and all 15 need to complete before the next schedule should run to ensure the hardware limit is not hit. Appreciate any help or guidance/ Many thanks, Rich.

522
Richard Kent
Byte
description of image

Popular tags

Badge winners

  • Topic Starter 1
    fabrihas earned the badge Topic Starter 1
  • Topic Starter 1
    Putrahas earned the badge Topic Starter 1
  • Topic Starter 5
    Sougato Royhas earned the badge Topic Starter 5
  • Contributor 10
    kagohas earned the badge Contributor 10
  • Contributor 75
    Lukas3Dhas earned the badge Contributor 75
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