commvault.com commvault.com

Events
Platform Updates
Support
How-To Videos
Vault Club

Community
Commvault Cloud Topics
Developer Tools, Integration and Automation

Developer Tools, Integration and Automation

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

364 Topics
1,711 Replies

When you subscribe we will email you when there is a new topic in this category

364 Topics

Recently active

Most replies Most views Newest first

christopherleckyByte

asked in Developer Tools, Integration and Automation

Cancelling workflow from within process-block

I often have a wizard-block defined with a process-block in order to make my workflows clean.The problem is that the workflow end activity doesn't actually kill the workflow it just exits the process block. Is there a way to kill the entire workflow from within the process-block?

asked in Developer Tools, Integration and Automation

Need to fetch job id from http request output

I am using http request in workflow which is in running in loop to run vm level backup. as an output it returns output for each http request as show below [{ "taskId":250501,"jobIds":[ "21035126" ] },{ "taskId":250502,"jobIds":[ "21035127" ] I want to fetch the jobids from this and add it is list. How can this be achieved.

TNOByte

asked in Developer Tools, Integration and Automation

User Permission

Hi,We are trying to create a role for a specific user that only needs to do remote qlogin from a linux client computer and triger a backup for the same client.What will be the minimium required CV priviliges to do it ? Thanks

caspByte

asked in Developer Tools, Integration and Automation

SAPA HANA Media Agent configuration

Hello everyone,I’ve to protect a two node SAP HANA database.The floating IP is managed by pacemaker cluster framework.After install the SAP HANA agent on both servers, have I to configure a Unix cluster client and use the host cluster name, referring to the VIP, into the SAP HANA pseudo-client instance host details? Thanks and regards

asked in Developer Tools, Integration and Automation

Linux script output on workflow

I want to run one script on linux client, if success them trigger backup job, could you guide me how to select linux client in workflow?

Greg KurzawaBit

asked in Developer Tools, Integration and Automation

REST API for TapeStorage and Media details

Hello, I’m using Commvault v11.32.28.In building some custom Python scripts that utilize the API I’ve found an endpoint that seems to be broken, or else I’m not using it properly.The endpoint is: /V4/Storage/Tape/{libraryId}/MediaMy understanding is that this is supposed to return media associated with a specific tape library. The “/V4/Storage/Tape” endpoint works, returning details about my library.But “/V4/Storage/Tape/{libraryId}/Media” gives me a status 200 (success), but no data.Is anyone else out there successfully gathering media details from the API?

caspByte

asked in Developer Tools, Integration and Automation

SQL Server TempDb

Hello, I need to move CV SQL Tempdb to a different drive.I’ve found in the documentation there is a SQL Server Relocate TempDb workflow, but I’m unable to find it on the CV store.What I’m doing wrongThanks and regards

Burak KoskerByte

asked in Developer Tools, Integration and Automation

Commvault Outlook Add In Crashs outlook session

We have a customer who uses commvault mail archive system and when they try to use outlook addin they says it was be crush the outlook session , and when they try to download archived e mail thay took a certificate problems . Is commvault have a updated new add in of this solition or how we can fix theese problems

asked in Developer Tools, Integration and Automation

Change hostname using Set-CVClient seems not to work

Friends, Version 11.28.89 I need to update the hostname on a bunch of clients, so I try to do this via Set-CVClient as described here: https://documentation.commvault.com/v11/essential/101881_set_cvclient.html But eventhough I receive errorCode 0, it seems that nothing is done. Can anyone tell me what is going wrong? Thanks in advance,Maurice van ‘t Loo PS C:\test> $clientprops = Get-CVClient -Name TESTSERVER_INST01_AGClientPS C:\test> $clientpropsName Value---- -----clientId 5193type 3clienthostName TESTSERVER_INST01_AGClientclientName TESTSERVER_INST01_AGClientcvdPort 0clientIdGUID B07D5C10-663B-41D4-8B81-A9CC77087D63PS C:\test> $clientprops.clienthostName = 'TESTSERVER.domain.nl'PS C:\test> $clientpropsName Value---- -----clientId

KayBByte

asked in Developer Tools, Integration and Automation

automated mail restore from Exchange DB - folderTag and mailboxTag parameter

Hello,in a workflow for automated mail restore from a Exchange DB, I need the parameter folderTag and mailboxTag. How I can request/get this values for a specific user from a recovery point? As part of the recovery point creation and mining, I can see the edb file info and folderTag/mailboxTag of user within the Exchange database, in the Commvault logs… but the logs roll over, so no source to grab the parameter for the specific user. Thx, Kay

asked in Developer Tools, Integration and Automation

Trouble with CVPowershellSDK module Get-CVSchedulePolicy

I am using the CV Powershell module found on GitHub - Commvault/CVPowershellSDK: Developer SDK - Powershell. I can successfully log into our Commvault server and run get-cvjob commands just fine so i know it is authenticating and working. What I am having trouble with is using the command Get-CVSchedulePolicy. When I just run it by itself, I get the output INFO: Get-CVSchedulePolicy: no policies found. I have a ton of Schedules. My goal is to disable an existing. Schedule Policy using the command Disable-CVSchedulePolicy. I am using an account that has full Commvault permission, and I can do this in the Commcell Java client just fine. What am I missing trying to see all the existing Schedule Policies and then disabling one of them via powershell? I looked at this Get-CVSchedulePolicy (commvault.com) and tried various swithes. Please help.

asked in Developer Tools, Integration and Automation

Automate software installation through REST API

Hi Vaulters,I am new to Commvault and I am trying to use REST API to install DB2 on a client computer. This is what I have done and found so far:1.I first used XML file generated by “Save as script” in Commcell console installation process and the JSON version of it, and used /InstallClient API which, according to the REST API reference, installs packages on a new client or an existing client. However this only gave a 500 error and no more information was provided. (The file is attached as File1.txt)2.Then I tried to imitate the json sample given in the API reference of /InstallClient (https://documentation.commvault.com/v11/essential/130184_rest_api_post_install_client_associations.html) but the same 500 error code was returned. I think there are many important fields for DB2 that are never covered in the API reference. (This json request is attached as File2.txt)3.After combining the content from 1. and format in 2., I somehow wrote a request accepted by the system and a job was laun

bpinByte

asked in Developer Tools, Integration and Automation

deleteClientAuthorization email approval configuration

We recently moved from on Prem email to cloud, and with the move the deleteClientAuthorization workflow stopped working. I know we have to reconfigure the Email Approval settings (image below) but not really sure what server to define there. Tried outlook.office365.com and made sure the account we are using has IMAP enabled but still doesn’t work. Anyone here has this configuration on their environment? Any other tweak we need to change on the user account/user mailbox for it to be able to login using IMAP?Appreciate any idea that anyone thinks be helpful in this scenario. Thanks in advance.

asked in Developer Tools, Integration and Automation

What are some options i can use with the qscript for GetAllRunningJobs

Hi https://documentation.commvault.com/2023e/expert/GetAllRunningJobs.htmlI want to filter the output for the qscript to get all running jobs. DescriptionGet the list of running jobs (backup, admin, restore) on the clientsUsageqoperation execscript -sn GetAllRunningJobsscript_name :GetAllRunningJobs The document doesn’t have much details to it. by OperationType - backup/ restoreby Client - which has %prd% or by ClientName - ‘abc001’ Is there a way to achieve this?where can i get the list of valid options / filters that we can use with qscript. ?

asked in Developer Tools, Integration and Automation

DR Backup Post Process unable to run Powershell script ?

Hi!We’re currently running a .bat script to do some simple copying of files to another destination, and we’re in the process of updating this to a powershell script, that basicly does the same, but does some additional checks and such first. I’ve verified that i can run the script manually with when i’m logged in as the user specified in the “run as user” But when i run a disaster recovery backup, i get the followig error: Error Code: [7:78] Description: Unable to run [C:\Path_to_Script\Name-of-script.ps1] on the client. Internal Error [150995005] in CVSession while communicating with remote host [Remote system [FQDN of Commcell server]. Remote execute request returned error: [].]. [] Source: commcellserver, Process: startPrePostCmd Anyone know what could be the issue here ? As far as i can see/understand, there should not be any “Remote System” ?

JanRByte

asked in Developer Tools, Integration and Automation

Register a decoupled installation with RestAPI

Hi,I have a question regarding register a client with RestAPI.In our environment we install by default a decoupled file system agent on each client.In case we need the client to register (e.g. for additional agents), we register the client via Console and fetch the configuration from the client. Additionally we have a script, which can do the same. This script is using qcommands.Since we are planning to migrate all of our scripts to use RestAPI instead of qcommands, we are looking for a method to perform the register via RestAPI.I saw, there is a function for POST Install Client, but I didn’t get it running to do the registering only.Do anybody has a clue how to perform a register and fetching client info only?I tried to check that Command Center and have a look on the “aquivalent API”, but it seems a register only isn’t implemented there. Also in the documentation there is described only how to perform via Console and SimCallWrapper.Maybe somebody has an idea :-)Many thanks in advance

asked in Developer Tools, Integration and Automation

/v4/Kubernetes/Applications returns less than what I have in webconsole

Hello,In my WebConsole of CommVault, we have 4712 Kubernates applications.So, in Databricks, I’ve written this codeapplicationCount is 5757.Now, the json returned is made from 2 keysapplicationCount that is an int applications that is a list of dictionariesso, in json_kubernates I should have 5757 dictionaries, instead I’ve got 100.From API documentation, there is no pagination and about the user we tested it between master user and my user they can see the same clients. Can you help me in understanding why it is doing that?

asked in Developer Tools, Integration and Automation

Is it Possible to get hostName from ClientID

I’m integrating CommVault API in order to have all client ( VM, client which make backup and Kubernates Application) in a single dataframe./client route returns hostName,clientName,displayName/VM returns several information of which returns clientName,displayName but not HostName/v4/Kubernetes/Applications return several information of which name but not displayName and HostNameWhile I know that a VM may not have a phisical hostName and kubernates Applications may not have an hostName since it’s dockerized containers, it is possible to have the hostName for Kubernates and VMs?/client has all 3 name columns(hostName,clientName,displayName)/VM has 2 name columns(clientName,displayName)/Applications has only one name column (name)Or, I can do the assumption thatVM Client Name can be added to hostnameKubernates application names can be considered as HostName?like hostName = clientName = name ?Thanks for all the clarification

asked in Developer Tools, Integration and Automation

Workflow to Run Bulk VM level backup

I am trying to create a workflow to run multiple VSA backups through workflow by just selecting the client from the list. For VSA backup it is not working. Same is working for File System level backup. Is there some limitation to run for VSA backup? If yes, what is the easiest way to achieve this. Tried from Rest API as well but we need to give vm name and client name which becomes a bit complex.

Abdul WajidByte

asked in Developer Tools, Integration and Automation

Automate backup of selected VMs from a VMGroup using RESTAPI

Hello All We take adhoc backups every day for patching activities and we search for each and every client in Command Center and trigger incremental backups for those clients(more than 100 every day). Is there a way that we can trigger the backup for these clients using RESTAPI. Foreach through these clients and trigger the incremental backup. I was able to authenticate and generate the authentication token but cannot trigger the backups for those clients. Its my first time with RESTAPIs. Would be grateful if someone can point in the right direction. I am using PoweShell. Thanks

asked in Developer Tools, Integration and Automation

API /Client does not return all the clients

I’ve started to integrate the api within Databricks. With common script and managed to extract all client / sub Clients using the documentation provided from customer Support.I asked internally to our SysAdmin that manage CommVault, to give me an extraction of the data from CommVault (All Clients).The list given from sysAdmin does not match with what I extract from API ( Like 4000+ hostname in mismatch).My Question is :Has someone encountered this issue? Shouldn’t route /Client return ALL and I Mean ALL clients that I see on CommVault application? Why do we encounter a mismatch between API and commVault Extraction?

asked in Developer Tools, Integration and Automation

Commvault - Send Logs automation with powershell

Hi everyone,I’m using powershell to automate the send logs file for a specific job in commvault. I want send these logs to a specific local path in the server, but according to the this documents Send-CVLogFile (commvault.com) the available option is to email. So my question is, there’s another way using powershell or other api to do this? Thanks.

asked in Developer Tools, Integration and Automation

Monitoring the Status of the Commserve Activty Control

Hi, is there a way to monitor the Status of the Commserve Activy Control. We are using PRTG to Monitor our Systems and want to get notfied about the Status of the Activity Control in the Commserve. I checked the API but did not find anything which is related to this case. Maybe there is a way to trigger a SQL Statement to the Database or SNMP. Kind RegardsFlorian

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

Aaron BrockmeyerBit

asked in Developer Tools, Integration and Automation

Status Codes For Status

Hello,I’m curious if anyone has encountered the issue of decoding the status codes for vms and other api endpoints for protection status. For example:"vmStatus": 1 I know these typically are 1-6 but could commvault support provide a mapping for each of these to help us determine what this means for protection status? Also, if it differs for vm clients to db clients, what should I expect from those as well? PS - I did see this topic /webconsole/api/v2/MediaAgents status and offlineReason codes and it was close to what I was looking for but this was for MediaAgents where I’m specifically concerned with VMs and DBs

1
2
3
4
...
15

Page 1 / 15

Badge winners

Georgioshas earned the badge Contributor 1
Brockhas earned the badge Contributor 5
D4T4Pr0T3ctionhas earned the badge Contributor 5
Fusihas earned the badge Topic Starter 5
yuneohas earned the badge Topic Starter 1

Show all badges

Powered by Gainsight

Terms & Conditions Cookie settings

Sign up

Already have an account? Login

Commvault Login

Login to the community

Commvault Login

Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.

Username or e-mail

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

OK