commvault.com commvault.com

Metallic
News & Events
Support Portal
How-To Videos

Community
Commvault topics
Developer tools, integration and automation (workflow/REST/Powershell etc.)

Developer tools, integration and automation (workflow/REST/Powershell etc.)

Discuss REST API, Workflows, scripting, customization, and more!

342 Topics
1,639 Replies

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

342 Topics

Most replies

Recently active Most views Newest first

benjaminasByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Automatic Installation AD iData Agent with install.xml - Password hash (enyryption)

We do automatic rollouts of Active Directory in Azure for our Customers with Ansible.We want to install the AD iData Agent with the Unattend Package and Custom “install.xml” File.These we are already doing successful for MA, Proxy and Restore Agent.If you do Unattend AD Installation in the XML is PW for AD Agent needed. But it is expected a hash, but i cannot find what hash (for the PW) the Installer expect. Normal PW is not working and sha-256 hash of PW is not working, too.This is the line in XML:<activeDirectory> <userAccount password="3820c5c6992b6774aced93ecd88e04e35b4398d99e3f0a7d8" domainName="q1xyz.local" userName="svc-adbackup" /></activeDirectory>So it would be important to know with what the setup when you create the package the PW encryptes, because during automatic rollout we get it from our central key Vault during installation.

2 years ago

Stefan VollrathByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Workflow Script API

Documentation for Workflows mentions some Functions for Java to interact with or access other Resources during execution https://documentation.commvault.com/commvault/v11_sp20/article?p=49729.htm.But alone from browsing through the other Pages it gets clear there are way more options like activity.exitCode or workflow.setFailed().Dissecting built in Workflows reveals other treasures like csdb.execute(“sqlquery”).Is there a complete list of all available Functions and how/when to use them? Trial-and-Error and Reverse-Engineering by Customers seems error-prone and inefficient.

1 year ago

christopherleckyByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Need help to get a list of vCenter instance hostnames

I cannot use the client list because we have duplicates with the same hostname. I need a query or even a rest api call that can get this information. thanks.Chris.

10 months ago

christopherleckyByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Query for VMs that have been discovered but not backed up

The APP_VM table seems to only include information for VM’s that have been backed up.Where is non-backed up VM information held? Thanks.Chris.

1 year ago

Onno van den BergCommvault Certified Expert

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Rest API: Explanation vmStatusInfo-> Vendor property / identify underlying HV type

I'm trying to automate certain tasks by querying the APIs. I first tried the newly released Powershell SDK which turned out to be broken right now. The development team is aware and they stated they will fix it somewhere next week so I decided to continue without SDK and write the modules myself.I'm trying to achieve the following:In case the client is discovered via VSA I would like to know the hypervisor vendor. In case a client is not part of VSA I would like to know if it runs as a virtual instance and preferably I would like to know what kind of virtualization platform. I know Commvault pulls this information from a client using the agent to make the distinction between OI and VOI and also that they can identify the platform but would like to leverage this myself as well and I would expect this information to be available as a client property that can by pulled over via the API. 1)So I already discovered that in case a client is discovered through the VSA client that the client pr

1 year ago

Allan0105Byte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

workflow query

Can anyone have workflow for below steps ? we would need to run the workflow as the first step and then the workflow would have a box that pops up asking for the name of the Client we want to decommission where we input the client name.Then we want the workflow to remove the client from all the groups it is part of (with the exception of automated client groups).Next we want the workflow to turn off backup activity of the client.Next we want the workflow to add the client to the decommissioned group.

1 year ago

thomas.SByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Report Client Monthly Growth report change from Monthly to Daily.

Is it possible to set the Client Monthly Growth Report to update the data not only monthly but daily ?Somewhere there should be a schedule, which is set to monthly transfer of the data.with kind regardsThomas

1 year ago

DarkKnightBit

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

API Token Authentication

Is there any way we access Rest API without token ? because we just run the script on the local commvault computer and we don't want user + password in the plaintext ?Thank you

6 months ago

jmiamaralByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Email notification on schedule via command line

Hello, I’m trying to add an alert to my script, when a scheduler runs to send the output via email to the client.I want to configure this via command line.I searched in the documentation but didn’t seem to find any information about this.Does anyone know how to do this configuration? Kind regards,Jmiamaral

1 year ago

BoyiByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Is there a way to add keywords in client descritpion in bulk

Hi, I created a client group to include 100+ clients using auto association based on rules.I am looking for a way to add the same keywords in client description of every client in this group.As there are more than 100 clients, if it is possible I am trying to avoid going through them one by one to add this keyword. Kind regards,Boyi

1 year ago

Mohit ChordiaByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Rest API call to update sub-client content of virtual sever sub-client

Can anyone share the REST API call to update subclient content of virtual sever sub-client ?Also what does this error means - Func[addVMToSubClient] Line[629]: status=401 content=u'<Api_GenericResp errorMessage="Access denied" errorCode="5" />'INFO:api.v1.services:status=401 content=u'<Api_GenericResp errorMessage="Access denied" errorCode="5" />'

2 years ago

Thomas GutjahrByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Office 365 Mailbox Backup via Workflow

Dear Community,Comcell: 11.24.23i want to created a workflow for the UseCase Mailbox User Offboarding. The Form should be trigger with smtp Mail Variable and create a Backup and Restores the Mailbox as .pst to a UNC Path. My big Problem here is that the Workflow doesnt understand the InstanceTyp → Exchange Mailbox there is no Q_xxx that suits for that in the List , when i try with Q_MSECH_MB the jobs goes in pending state with “Failed to enumarate iDataAgent…..”, there are only Q_MSEXCH for 2003,2k archiv,db available but nothing Office 365.Or he says that the Client has not installed the Module …. When you initiate a backup via GUI he uses as iDataAgent “Exchange Mailbox”. Is there anyone out there who managed to get a running workflow for Office 365 Mailbox Backup. Cheers,Thomas

1 year ago

Nick Laflamme II

posted in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Meta: Developing Custom Reports

Every now and then (perhaps once a year, usually soon after installing a feature release), I return to the challenge of writing reports in Commvault to report on current status consistent with the way I think. Is there a section of this community that deals with developing custom reports (and dashboards) in more abstract, theoretical ways?I don’t want to be told how to solve a very narrow, specific problem, let alone told of five reports that display similar data; I want to discuss the mechanics of, for example, how to link from one Commvault report, such as one that might sort data by subclient ID, to another Commvault report that displays information relevant to one specific subclient ID. Another time I might want to discuss the various data display widgets in the report writing tools. I try to use Books Online, but I’m almost convinced my brain works differently than the editors of Books Online, so I’m looking for an alternate perspective or resource to address some of those arcane

1 year ago

christopherleckyByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

is there a way to modify workflow activity inputs dynamically?

Well here is a good one…Is there a way to hide the inputs of a popup activity using java or javascript?

1 year ago

BenjisByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

QScript failure both locally and via API

Hi All, Qscript in the link here started to fail randomly since yesterday for me..in both of our commcells..Could not understand why I have this issue, for fun sake I tried to copy paste from CV’s documentation, from -help section of qcommand - maybe after 5 months of succesfull everyday use somehow script decided for himself to mistype the command...lol - laughing through tears here when example in -help section in itself is faulty :) Same goes for API call, response code is ‘200’ - but in the response is one of CV generic resp codes, which is ‘2’. def get_commvault_clients(self): """This method returns all servers with backups in past 24 hours from DK1 and DK2 commcells""" job_history = [] for api in self.api_url: jobs_request = api["url"] + "ExecuteQCommand" jobs_response = requests.post( jobs_request, headers=api["headers"], timeout=3600, data="command=qoperation execscript -s

1 year ago

Abdul WajidByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Commvault PowerShell Module Dead Slow

Hi Everyone I have been trying to get my head around Commvault’s PowerShell module and it runs so slow, not sure why. Has anyone else has faced the same issue? Below script returned 3676 objects and it took more than two hours: Get-Date$clients = Get-CVClient$subClientObjs = @()foreach ($client in $clients){ $subClients = Get-CVSubclient -ClientName $client.clientName -AllProperties foreach ($subClient in $subClients){ $subClientObj = [PSCustomObject]@{ 'clientName' = $subClient.subClientProperties.subClientEntity.clientName 'subClientName'= $subClient.subClientProperties.subClientEntity.subclientName 'backupSetName' = $subClient.subClientProperties.subClientEntity.backupsetName 'clientType' = $subClient.subClientProperties.subClientEntity.appName 'clientInstanceName' = $subClient.subClientProperties.subClientEntity.instanceName 'vmContents' = $subClient.subClientProperties.vmContent.children.displayName -jo

2 years ago

Mohit ChordiaByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Automate Commvault agent installation and Configuration

We are looking to automate Commvault IDA agents Installation and client settings configuration such as encryption, dedupe , storage policy , filters , schedules , database subclient settings such as oracle home, path etc. .Does anyone has custom workflows deployed for agent installation and client configuration ? if yes please share .Also , what is recommended way of achieving this ?Is it possible to achieve 100% configuration for client through RestAPI ?

9 months ago

alligatorByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

#12! getting added in xml (Save as Script of sql restore), is not legal for a JDOM character content: 0x0012 is not a legal XML character

so when i trying to get this information to a mail, i’m getting an error , how to fix or get rid of the xml encoding error. I’m trying to fetch the path information for a sql restore to email (using workflow)

5 months ago

Mohit ChordiaByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

API Call to get information about VMs which are present in VMgroup

Hi Team,I need an API which can give real time information about the VMs which are added in VMgroup/sub client for all vmgroups and VMware centers configured in CommCell console.Let me know if this is possible.Regards,Mohit

1 year ago

gary mcneelyByte

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Increase the maximum number of characters allowed in Commvault VSA subclient description error

Would you ask the Commvault if they can increase the number of characters allowed in Commvault VSA subclient description field to 10,000

9 months ago

mhamelBit

asked in Developer tools, integration and automation (workflow/REST/Powershell etc.)

Unable to backup a filesystem (subclient content issue) - cvpysdk - Python

Hello,I'm trying to backup a filesystem from a storage array, I noticed that the update of the subclient content using this syntax :subclient.content = ["My_storage_array:/My_Filesystem"]This syntax is not executed correctly, we can write anything in the content even if it is not present in the storage array, no validation is done by commvault.The output of the backup job fails and returns the following error:"File system scan failed - there is nothing to back up. A possible cause is that none of the subclient contents exist.".the code that i'm using to do my backup is bellow :commcell = Commcell('My_commcell', commcell_login ,commcell_password)client = commcell.clients.get('My_storage_array')agent = client.agents.get('My_Agent')backupset = agent.backupsets.get('My_Backupset')backupset.subclients.add("backup_tmp", storage_policy="My_storage_policy")subclient = backupset.subclients.get("backup_tmp")subclient.content = ["My_storage_array:/My_Filesystem"]subclient.enable_backup()job_backu

2 years ago

Page 1 / 14

Badge winners

Zach Khas earned the badge Contributor 1
Arun Kumar Dadihas earned the badge Contributor 10
ComBakhas earned the badge Contributor 5
Marcos Silvahas earned the badge Contributor 1
Thinusdbahas earned the badge Contributor 1

Show all badges

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.

This file cannot be downloaded

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