commvault.com commvault.com

Developer Tools, Integration and Automation

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

  • 462 Topics
  • 2,035 Replies

462 Topics

E
Eugen
asked in Developer Tools, Integration and Automation

To display a Commvault diagram of own infrastructure

Hello dear community,Can you perhaps help me. I heard that Commvault has a way to automatically display the Commvault infrastructure in 2D or 3D as a picture. Do you know how to do this or is this information incorrect? I would be very grateful if you gave me more information about this.That would help our employees to understand a little more of the commvault construction in our company. Best regards,Eugen

3
J
Vaulter
1 day ago
E
eimiy
asked in Developer Tools, Integration and Automation

Add content in VMgroup using REST API

I’m trying to add VM in existing VMgroup using REST API.In the VMgroup there are already many VMs are existing.Following the rule of sample from “Modify VM Group Details”  didn’t work.‘’’ curl -w -L -k -w "%{http_code}" -o response.txt -X PUT 'https://mycommvault/commandcenter/api/V4/VmGroup/12' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authtoken: $Token' \--data-raw '{  "content": {    "overwrite": false,    "virtualMachines": [      {          "name": "vm",          "GUID": "xxxx-xxx-xxx-xxxx",          "type": "VM"       }    ],  },}'  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                 Dload  Upload   Total   Spent    Left  Speed100   319    0     0  100   319      0   6645 --:--:-- --:--:-- --:--:--  6645500‘’’it worked when “overwrite” is true. but  the rest of VMs were deleted from this VMgroup.Am I missing something?How can I add VM on top of existing VM and not change anything else? 

2
christopherlecky
Byte
2 days ago
R
Byte
RandomCustomerByte
asked in Developer Tools, Integration and Automation

Need an API endpoint to get the body for one of the APIs

I was thinking about below API end-point: https://api.commvault.com/docs/SP32/api/cv/VirtualizationOperations/vsa-subclient-previewPlease help me with the API endpoint that output below body:{ "appId": { "subclientId": 31, "clientId": 12, "instanceId": 4, "backupsetId": 0, "apptypeId": 106 } }I will use the above body in the API : https://api.commvault.com/docs/SP32/api/cv/VirtualizationOperations/vsa-subclient-previewMy idea is to fetch the subclient id and from the subclient id I can retreive the subclient name and work without manually entering any details.

2
R
Byte
2 days ago
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation

qcommand/API/cs db query to find the VM Job ID in V2 Virtualization for instances in Amazon Web Services

Qcommand, API or CS sql query to retreive the information listed under Instance Status tab for a Snap job under V2 virtualization (Amazon Web Services)In V2 virtualization, we have VSAParentJobID which is 123654 in the above screenshot and each VM added in that subclient will have a VM Job ID associated to it for a Snap backup.Whereas in V1 virtualization , it was just one job id for all VM’s so there wasn’t any confusion, we use this JobID to cleanup any snapshots/ami that were left by FAILED/Partially Successful jobs.I’m finding it difficult with V2, since the snapshots are named as per the VM Job ID which is only seen within the Instance status tab in Job Details.The API for Get Job Details on a the VSAParentJobID is not giving me the associated VM Job IDIt only gives the following info:jobSummarysizeOfApplicationopTypesizeOfMediaOnDiskstatuslocalizedOperationNamebackupLevelclientGroups informationsubclient information like clientName, instanceName, backupsetId, clientID, subclientI

3
A
Byte
4 days ago
J
Bit
JanVdWBit
asked in Developer Tools, Integration and Automation

Can't kill workflow job

Hi,I have a workflow running with a loop/wait in it, so this keeps running.Another workflow needs to kill it when a specific condition happens, but this workflow can’t kill the job.I also tried to kill it manually with the “qoperation jobcontrol” command but that doesn’t work either.The only way to kill it, is right-click in the Commcell console. There’s no issue to kill other jobs with the “qoperation jobcoltrol” command.Does anyone have any idea why this is not possible and how I can get this working?Thanks and kind regards,Jan

1
S
Vaulter
8 days ago
D
Bit
dgzagm4q4cvBit
asked in Developer Tools, Integration and Automation

How to use Powershell to Disable Subclient?

Hello All.  I’m attempting to write a script to disable a subclient.  We have hundreds that we don’t require the backup of the File System, so I’d like to disable them.I can find information about the subclient...Get-CVSubclient -ClientName qct0bjsql01 | Where-Object { $_.appName -eq "File System" }clientName    : qct0bjsql01instanceName  : DefaultInstanceNamedisplayName   : qct0bjsql01backupsetId   : 2068_type_        : 7commCellName  : cvt0comsrv01instanceId    : 1csGUID        : xxxxxsubclientGUID : xxxxxsubclientId   : 4777clientId      : 5087appName       : File SystembackupsetName : defaultBackupSetapplicationId : 33subclientName : defaultentityInfo    : @{companyId=0; companyName=Commcell} However when I attempt to disable the subclient with this command it fails.Disable-CVBackupSubclient -SubclientId 4777Disable-CVBackupSubclient : Invalid URI: The format of the URI could not be determined.At line:1 char:1+ Disable-CVBackupSubclient -SubclientId 4777+ ~~~~~~~~~~~~~~~~~~~~~~~~~~

11
E
Bit
9 days ago
D
Byte
DUO-CSRByte
asked in Developer Tools, Integration and Automation

Retire VM via Rest-API

Friends,I want to use a script to retire/delete VMs from Commvault when the last backup is at a certain age. As we are a tenant customer, we don’t have options like Workflows.So I build a Powershell script to collect data, do different checks and fire Rest calls to Commvault.I can delete via the following command and this works fine:Invoke-RestMethod -Method 'Delete' -Headers $headers -Uri $($url + "/v4/virtualmachines/$UUID") But I can’t find the option to Retire the VM !And important in this case that I only retire the VM backup, not the client, as FS and SQL backups might be still in use. Anyone who knows how to Retire a VM using Rest-API ? Thanks in advance, Maurice

18
D
Byte
10 days ago
Henk22
Vaulter
Henk22Vaulter
asked in Developer Tools, Integration and Automation

Migrating backup vendor archives - is there a plan for other than file system data?

Hi all,In the 2024E release I read something about migrating data from other backup vendors to Commvault. Unfortunately this can only be done for file ystem data (the the moment). Is there a plan to migrate other data (databases, VM's) too? That would be a complete solution when a customer wants to migrate from another vendor to CommvaultHopefully we have some information on this! Thanks in advance for the answerKind regards,Henk

1
A
Vaulter
14 days ago
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation

Qcommand or way to retreive the Instance Size details per VM from the job details for a Snap Backup job

I would like retrieve the instance size information for each VM for a specific job? Is there any qcommand / API that i can use to get this info

2
A
Byte
16 days ago
christopherlecky
Byte
christopherleckyByte
asked in Developer Tools, Integration and Automation

How do get my workflows to just start and return a jobid?

All my workflows will start but stay on the submission page until the workflow completes.What am I doing wrong?I want to enter the options for the workflow and then have it return the jobid. Thanks.

6
christopherlecky
Byte
17 days ago
M
Vaulter
MNRunner
published in Developer Tools, Integration and Automation

“sqladmin_cv and sqlexec_cv” accounts password change workflow

Does your organization have a mandatory password change policy and Commvault SQL accounts (sqladmin_cv and sqlexec_cv) are not in an exception? No worries. We have you covered. We now have “Refresh Commserve Database Access Key” workflow  available in your Commserve and it can be scheduled to change passwords of these accounts.  Happy meeting your security/audit requirements.  Have fun. 

13853
Erase4ndReuseMedia
Byte
25 days ago
Y
yogesh.tech
asked in Developer Tools, Integration and Automation

No "cc" field when sending Reports via command center

Hi ,I am trying to send an Daily Job summary report to Helpdesk team and keep my Manager in CC from COmmvault.But there is no option for “cc” field, it;s there in Alert section but not in reports.Can somebody help me if there is any option to customize the report and add CC form?

3
J
Vaulter
28 days ago
B
Bit
bpandaBit
asked in Developer Tools, Integration and Automation

Flag in API to enable WORM

So far we’ve utilized non-worm server plans for VM group and SQL instance backups via Equivalent API.Is there any approach in API to enable Worm flag.Any suggestions would be greatly appreciated.

2
B
Bit
1 month ago
A
Byte
alligatorByte
asked in Developer Tools, Integration and Automation

How to invoke/run a custom report from workflow, if we have the Equivalent API for it

I have customized report (from Backup Job Summary report)which has the information of certain jobs with for ex:the report has a table which contains the following columnsJobid, subclient, job status, start time, end time  I have added a schedule to this report to generate csv format file at a specific time.If have to run this report from workflow, which API shall i use? 

1
H
Vaulter
1 month ago
L
Bit
Lukasz JaroszBit
asked in Developer Tools, Integration and Automation

FIPS

Hi,its possible enable FIPS mode on the Commvault server via API. If is possible please share me API endpoint for this. How I can check via API status for FIPS ? 

2
L
Bit
1 month ago
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-backuphttps://api.commvault.com/docs/SP34/api/cv/VirtualizationOperations/perform-vm-backupBut 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:

2
R
Byte
1 month ago
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.​​

12
Onno van den Berg
Commvault Certified Expert
1 month ago
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?

1
L
Vaulter
1 month ago
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!

1
A
Vaulter
1 month ago
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/15848821555accept: application/jsonAuthtoken: {{auth_token}} I suppose that is because the job id is hight, but the response is incorrect,What is the problem ?

2
christopherlecky
Byte
1 month ago
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? 

2
Onno van den Berg
Commvault Certified Expert
1 month ago
J
Byte
Jass GillByte
asked in Developer Tools, Integration and Automation

Unable to find equivalent API for server plan association with SQL server database/instance

Hi Team,We are trying to automate commvault backups and restore process.We need to backup SQL server instances and databases.Created server plan and we have database and instances added it to command center. I also associated a single database using instructions from here: https://documentation.commvault.com/2022e/essential/associating_plan_with_sql_database.htmlBut I am not able to see any equivalent API for this that I can leverage to automate the process.

4
christopherlecky
Byte
1 month ago
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’

1
S
Vaulter
1 month ago
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,        "runBackupO

4
L
Byte
1 month ago
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-contenthttps://api.commvault.com/docs/SP34/api/cv/SubclientOperations/get-subclient-propertiesThe api that is giving me a different subclient id:https://api.commvault.com/docs/SP34/api/cv/SubclientOperations/get-subclient-idimport requestsimport jsonurl = "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 = json

2
R
Byte
1 month ago

Badge winners

  • Contributor 1
    Zawrohas earned the badge Contributor 1
  • Topic Starter 1
    bauernfeindhas earned the badge Topic Starter 1
  • Topic Starter 1
    Zawrohas earned the badge Topic Starter 1
  • Contributor 1
    Vincent633has earned the badge Contributor 1
  • Topic Starter 1
    Tommy123has earned the badge Topic Starter 1
Show all badges
Terms & ConditionsCookie settings