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

Hi Mohit, I am pretty sure that real-time monitoring is not possible through the currently exposed apis.

The VM information is gathered during sub-client discovery. and VMgroups are consequently populated.

To get exactly what you are asking for would probably requires that you use a VMware API or Powercli. Even then I’m not sure an API exists that will get the information in real time. 

Perhaps if you tell us what it is that you are trying to accomplish we may be able to help. 

Thanks.

Chris.

Is the goal to ensure that every vm in the company is backed up?

CommVault obviously can only backup up VMs that it is aware of, so to ensure that something isn’t being missed by a filter or other shenanigans you should really be comparing against vmware.

How are your vm backup subclient contents defined?

The simplest way to find this is to get the annotations from the VM

If you have access to Powercli you can do this 

Get-vm  myvmhere | get-annotation -name *Backup* | format-list

There are two annotations added by CommVault when a backup completes.

“Backup Status” which includes the Jobid, Backupset, and subclient and  ”Last Backup” which includes the date of the last backup.

You can get the same information from the vmware apis, but they are really just horrible.

 

Please confirm if this API call will provide information about VMs which are being backed up in last how many hours , days etc ?  

http://WebConsoleHostName/webconsole/api/VM?status=1

 

 

Here is the standard output object that you get from GET VM API.

 

vmHost                                : vmhost.home.com
bkpStartTime                          : 1650582895
type                                  : 9
vmStatus                              : 1
slaStatus                             : 1
vmUsedSpace                           : 1030151006
subclientId                           : 9560
bkpEndTime                            : 1650582898
vmFailureReasonForWarning             :
name                                  : vm1
storagepolicyName                     : Backup-Plan
slaCategory                           : 1
vmGuestSpace                          : 95629309943
latestBackupTimeCatalogedSuccessfully : 0
isIndexingV2                          : True
vmBackupJob                           : 24026392
strOSName                             : SUSE Linux Enterprise 12 (64-bit)
isDeleted                             : False
vendor                                : 1
osType                                : 2
applicationSize                       : 95629309943
vmSize                                : 164313553758
slaCategoryDescription                : Protected
vmAgent                               : proxy1
retireClientPhase                     : 0
isContentIndexded                     : False
isBackupAllowed                       : True
schedulePolicy                        : Incremental backup schedule
vmHardwareVer                         : vmx-09
strGUID                               : 508990bf-a3e3-06bc-514e-49debd3x56e0
subclientName                         : SubclientName
vsaNextBackupSubClientEntity          : @{backupsetId=2357; subclientId=9560; subclientName=SubclientName; flags=}
instanceEntity                        : @{instanceId=304}
commCell                              : @{_type_=1; commCellName=CVCS; csGUID=62cccdd-4DC3-4D2A-A494-54678468AA}
proxyClient                           : @{clientId=85; clientName=proxy1}
plan                                  : @{planName=Backup-Plan; planId=206}
vsaSubClientEntity                    : @{backupsetId=2357; subclientId=9560; subclientName=subclientName}
client                                : @{clientId=2859; clientName=vm1; displayName=vm1}
pseudoClient                          : @{clientId=2612; clientName=vCenter; flags=}
lastBackupJobInfo                     : @{jobID=24026652; commCellID=2; failureReasonMessageEnglish=; status=1; startTime=; endTime=}
dcPlan                                :
vmSubClientEntity                     : @{backupsetId=2638; instanceId=2; subclientId=3221; subclientName=default}
advancedPrivacySettings               : @{authType=1; passkeySettings=}

It has the information like SubclientName, vCenter etc that you can use to compare the data from VMware. 

Here are the couple of PowerShell functions that I am using to achieve this:

 

$CV = CVCS.HOME.COM
Function Get-CVToken {
    [CmdletBinding(
    )]
    Param (
    [Parameter(Mandatory=$True)]
    [string]$UserName,

    [Parameter(
        Mandatory = $True,
        ParameterSetName = 'Secret'
    )]
    [Security.SecureString]$Password
    )
    #Write-Verbose $Password
    $headers = @{}
    $headers.Add("Content-Type","application/json")
    $headers.Add("Accept","application/json")
    $plainPassword = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password))
    #Write-Verbose $UserName
    #Write-Verbose $plainPassword
    $encPassword = [convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes($plainPassword))
    $body = @{username=$userName;password=$encPassword;}
    $response = Invoke-RestMethod "http://$CV/webconsole/api/login" -Method Post -Headers $headers -Body $($body | ConvertTo-Json)
    Write-Verbose $response.token
    $Global:cvToken = $response.token
}

function StageVMData {
    param ()
    $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
    $headers.Add("Accept","application/json")
    $headers.Add("AuthToken", $Global:cvToken)
    $headers.Add("PagingInfo","0,10000")
    $body = ""
    $response = Invoke-RestMethod "http://$CV/webconsole/api/VM?status=0" -Method Get -Headers $headers
    $Global:CVVMData = $response

}

First function to generate the token and second to stage the data in a global variable that you can use for your reports.

Hope this helps.

Thanks

Abdul