--- updatedAt: 2025-08-14T13:35:02.000Z agentTools: siteIndex: https://developer.n-able.com/llms.txt projectIndex: https://developer.n-able.com/n-central/llms.txt --- # Cove Data Protection - Get All Device Installations ```powershell PowerShell <# ----- About: ---- # Get All SW Backup Device Installations # Revision v08 - 2020-12-24 # Author: Eric Harless, Head Backup Nerd - SolarWinds # Twitter @Backup_Nerd Email:eric.harless@solarwinds.com # -----------------------------------------------------------#> ## About <# ----- Legal: ---- # Sample scripts are not supported under any SolarWinds support program or service. # The sample scripts are provided AS IS without warranty of any kind. # SolarWinds expressly disclaims all implied warranties including, warranties # of merchantability or of fitness for a particular purpose. # In no event shall SolarWinds or any other party be liable for damages arising # out of the use of or inability to use the sample scripts. # -----------------------------------------------------------#> ## Legal <# ----- Compatibility: ---- # For use with the Standalone edition of SolarWinds Backup # -----------------------------------------------------------#> ## Compatibility <# ----- Behavior: ---- # Check/ Get/ Store secure credentials # Authenticate to https://backup.management console # Get / Prompt for exact partner name # Enumerate device installations # Optionally display output via Powershell Out-Gridview # Export to XLS/CSV # Optionally launch XLS/CSV file # # Results include all Historic installation instances of current devices (Backup, Restore Only, Bare-Metal Recovery, Recovery Console and Recovery Testing) # Useful for auditing the last active date for a specific installation Id # # Use the -GridView switch parameter to display output via Powershell Out-Gridview # Use the -DeviceCount ## (default=5000) parameter to define the maximum number of devices returned # Use the -Launch switch parameter to launch the XLS/CSV file after completion # Use the -ExportPath (?:\Folder) parameter to specify alternate XLS/CSV file path # Use the -Delimiter (default=',') parameter to set the delimiter for XLS/CSV output (i.e. use ';' for The Netherland) # Use the -ClearCredentials parameter to remove stored API credentials at start of script # # https://documentation.solarwindsmsp.com/backup/documentation/Content/service-management/json-api/home.htm # https://documentation.solarwindsmsp.com/backup/documentation/Content/service-management/json-api/API-column-codes.htm # -----------------------------------------------------------#> ## Behavior [CmdletBinding()] Param ( [Parameter(Mandatory=$False)] [int]$DeviceCount = 5000, ## Change Maximum Number of devices results to return [Parameter(Mandatory=$False)] [switch]$GridView, ## Display Output via Powershell Out-Gridview [Parameter(Mandatory=$False)] [switch]$Launch, ## Launch XLS or CSV file [Parameter(Mandatory=$False)] [string]$Delimiter = ',', ## specify ',' or ';' Delimiter for XLS & CSV file [Parameter(Mandatory=$False)] $ExportPath = "$PSScriptRoot", ## Export Path [Parameter(Mandatory=$False)] [switch]$ClearCredentials ## Remove Stored API Credentials at start of script ) #region ----- Environment, Variables, Names and Paths ---- Clear-Host Write-output " Get All Device Installations`n`n" $Syntax = Get-Command $PSCommandPath -Syntax ; Write-Output " Script Parameter Syntax:`n" $Syntax Write-output " Current Parameters:" Write-output " -GridView = $GridView" Write-output " -Launch = $Launch" Write-output " -ExportPath = $ExportPath" Write-output " -Delimiter = $Delimiter" $scriptpath = $MyInvocation.MyCommand.Path $dir = Split-Path $scriptpath Push-Location $dir [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 $Script:strLineSeparator = " ---------" $CurrentDate = Get-Date -format "yyy-MM-dd_hh-mm-ss" #endregion ----- Environment, Variables, Names and Paths ---- #region ----- Functions ---- #region ----- Authentication ---- Function Set-APICredentials { Write-Output $Script:strLineSeparator Write-Output " Setting Backup API Credentials" if (Test-Path $APIcredpath) { Write-Output $Script:strLineSeparator Write-Output " Backup API Credential Path Present" }else{ New-Item -ItemType Directory -Path $APIcredpath} Write-Output $Script:strLineSeparator Write-Output " Enter Exact, Case Sensitive Partner Name for SolarWinds Backup.Management API i.e. 'Acme, Inc (bob@acme.net)'" DO{ $PartnerName = Read-Host " Enter Login Partner Name" } WHILE ($partnerName.length -eq 0) $PartnerName | out-file $APIcredfile $BackupCred = Get-Credential -UserName "" -Message 'Enter Login Email and Password for SolarWinds Backup.Management API' $BackupCred | Add-Member -MemberType NoteProperty -Name PartnerName -Value "$PartnerName" $BackupCred.UserName | Out-file -append $APIcredfile $BackupCred.Password | ConvertFrom-SecureString | Out-file -append $APIcredfile Start-Sleep -milliseconds 300 Send-APICredentialsCookie ## Attempt API Authentication } ## Set API credentials if not present Function Get-APICredentials { $Script:True_path = "C:\ProgramData\MXB\" $Script:APIcredfile = join-path -Path $True_Path -ChildPath "$env:computername API_Credentials.Secure.txt" $Script:APIcredpath = Split-path -path $APIcredfile if (($ClearCredentials) -and (Test-Path $APIcredfile)) { Remove-Item -Path $Script:APIcredfile $ClearCredentials = $Null Write-Output $Script:strLineSeparator Write-Output " Backup API Credential File Cleared" Send-APICredentialsCookie ## Retry Authentication }else{ Write-Output $Script:strLineSeparator Write-Output " Getting Backup API Credentials" if (Test-Path $APIcredfile) { Write-Output $Script:strLineSeparator " Backup API Credential File Present" $APIcredentials = get-content $APIcredfile $Script:cred0 = [string]$APIcredentials[0] $Script:cred1 = [string]$APIcredentials[1] $Script:cred2 = $APIcredentials[2] | Convertto-SecureString $Script:cred2 = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($Script:cred2)) Write-Output $Script:strLineSeparator Write-output " Stored Backup API Partner = $Script:cred0" Write-output " Stored Backup API User = $Script:cred1" Write-output " Stored Backup API Password = Encrypted" }else{ Write-Output $Script:strLineSeparator Write-Output " Backup API Credential File Not Present" Set-APICredentials ## Create API Credential File if Not Found } } } ## Get API credentials if present Function Send-APICredentialsCookie { Get-APICredentials ## Read API Credential File before Authentication $url = "https://api.backup.management/jsonapi" $data = @{} $data.jsonrpc = '2.0' $data.id = '2' $data.method = 'Login' $data.params = @{} $data.params.partner = $Script:cred0 $data.params.username = $Script:cred1 $data.params.password = $Script:cred2 $webrequest = Invoke-WebRequest -Method POST ` -ContentType 'application/json' ` -Body (ConvertTo-Json $data) ` -Uri $url ` -SessionVariable Script:websession ` -UseBasicParsing $Script:cookies = $websession.Cookies.GetCookies($url) $Script:websession = $websession $Script:Authenticate = $webrequest | convertfrom-json #Debug Write-output "$($Script:cookies[0].name) = $($cookies[0].value)" if ($authenticate.visa) { $Script:visa = $authenticate.visa }else{ Write-Output $Script:strLineSeparator Write-output " Authentication Failed: Please confirm your Backup.Management Partner Name and Credentials" Write-output " Please Note: Multiple failed authentication attempts could temporarily lockout your user account" Write-Output $Script:strLineSeparator Set-APICredentials ## Create API Credential File if Authentication Fails } } ## Use Backup.Management credentials to Authenticate #endregion ----- Authentication ---- #region ----- Data Conversion ---- Function Convert-UnixTimeToDateTime($inputUnixTime){ if ($inputUnixTime -gt 0 ) { $epoch = Get-Date -Date "1970-01-01 00:00:00Z" $epoch = $epoch.ToUniversalTime() $epoch = $epoch.AddSeconds($inputUnixTime) return $epoch }else{ return ""} } ## Convert epoch time to date time Function Save-CSVasExcel { param ( [string]$CSVFile = $(Throw 'No file provided.') ) BEGIN { function Resolve-FullPath ([string]$Path) { if ( -not ([System.IO.Path]::IsPathRooted($Path)) ) { # $Path = Join-Path (Get-Location) $Path $Path = "$PWD\$Path" } [IO.Path]::GetFullPath($Path) } function Release-Ref ($ref) { ([System.Runtime.InteropServices.Marshal]::ReleaseComObject([System.__ComObject]$ref) -gt 0) [System.GC]::Collect() [System.GC]::WaitForPendingFinalizers() } $CSVFile = Resolve-FullPath $CSVFile $xl = New-Object -ComObject Excel.Application } PROCESS { $wb = $xl.workbooks.open($CSVFile) $xlOut = $CSVFile -replace '\.csv$', '.xlsx' # can comment out this part if you don't care to have the columns autosized $ws = $wb.Worksheets.Item(1) $range = $ws.UsedRange [void]$range.AutoFilter() [void]$range.EntireColumn.Autofit() $num = 1 $dir = Split-Path $xlOut $base = $(Split-Path $xlOut -Leaf) -replace '\.xlsx$' $nextname = $xlOut while (Test-Path $nextname) { $nextname = Join-Path $dir $($base + "-$num" + '.xlsx') $num++ } $wb.SaveAs($nextname, 51) } END { $xl.Quit() $null = $ws, $wb, $xl | ForEach-Object {Release-Ref $_} # del $CSVFile } } ## Save as output XLS Routine #endregion ----- Data Conversion ---- #region ----- Backup.Management JSON Calls ---- Function Get-PartnerInfo ($PartnerName) { $url = "https://api.backup.management/jsonapi" $data = @{} $data.jsonrpc = '2.0' $data.id = '2' $data.visa = $Script:visa $data.method = 'GetPartnerInfo' $data.params = @{} $data.params.name = [String]$PartnerName $webrequest = Invoke-WebRequest -Method POST ` -ContentType 'application/json' ` -Body (ConvertTo-Json $data -depth 5) ` -Uri $url ` -SessionVariable Script:websession ` -UseBasicParsing $Script:cookies = $websession.Cookies.GetCookies($url) $Script:websession = $websession $Script:Partner = $webrequest | convertfrom-json if (($Partner.result.result.Level -ne "Root") -and ($Partner.result.result.Level -ne "Sub-root")) { [String]$Script:Uid = $Partner.result.result.Uid [String]$Script:PartnerId = $Partner.result.result.Id [String]$Script:PartnerName = $Partner.result.result.Name Write-Output $Script:strLineSeparator Write-output " $PartnerName - $partnerId - $Uid" Write-Output $Script:strLineSeparator }else{ Write-Output $Script:strLineSeparator Write-Host " Lookup for Root, Sub-root and Distributor Partner Level Not Allowed" Write-Output $Script:strLineSeparator $PartnerName = Read-Host " Enter EXACT Case Sensitive Customer/ Partner display name to lookup i.e. 'Acme, Inc (bob@acme.net)'" Get-PartnerInfo $partnername } if ($partner.error) { write-output " $($partner.error.message)" $PartnerName = Read-Host " Enter EXACT Case Sensitive Customer/ Partner display name to lookup i.e. 'Acme, Inc (bob@acme.net)'" Get-PartnerInfo $partnername } } ## get PartnerID and Partner Level Function Get-Devices { $url = "https://api.backup.management/jsonapi" $data = @{} $data.jsonrpc = '2.0' $data.id = '2' $data.visa = $Script:visa $data.method = 'EnumerateAccountStatistics' $data.params = @{} $data.params.query = @{} $data.params.query.PartnerId = [int]$PartnerId $data.params.query.SelectionMode = "PerInstallation" $data.params.query.Filter = $Filter1 $data.params.query.Columns = @("AU","AR","AN","PF","LN","OP","OI","OS","OT","PD","AP","PN","AA843","MN","TS","EI","IP","MO","MF","CD","VN","II","IM","RTG","RP") $data.params.query.OrderBy = "T7 ASC" $data.params.query.StartRecordNumber = 0 $data.params.query.RecordsCount = $devicecount $data.params.query.Totals = @("COUNT(AT==1)","SUM(T3)","SUM(US)") $webrequest = Invoke-WebRequest -Method POST ` -ContentType 'application/json' ` -Body (ConvertTo-Json $data -depth 6) ` -Uri $url ` -SessionVariable Script:websession ` -UseBasicParsing $Script:cookies = $websession.Cookies.GetCookies($url) $Script:websession = $websession $Script:Devices = $webrequest | convertfrom-json Write-Output " Requesting details for $($Devices.result.result.count) devices." Write-Output " Please be patient, this could take some time." Write-Output $Script:strLineSeparator $Script:DeviceDetail = @() ForEach ( $DeviceResult in $Devices.result.result ) { $Script:DeviceDetail += New-Object -TypeName PSObject -Property @{ AccountID = [String]$DeviceResult.AccountId; PartnerID = [string]$DeviceResult.PartnerId; DeviceName = $DeviceResult.Settings.AN -join '' ; PartnerName = $DeviceResult.Settings.AR -join '' ; Reference = $DeviceResult.Settings.PF -join '' ; DataSources = $DeviceResult.Settings.AP -join '' ; Location = $DeviceResult.Settings.LN -join '' ; Notes = $DeviceResult.Settings.AA843 -join '' ; Product = $DeviceResult.Settings.PN -join '' ; ProductID = $DeviceResult.Settings.PD -join '' ; Profile = $DeviceResult.Settings.OP -join '' ; OS = $DeviceResult.Settings.OS -join '' ; MachineName = $DeviceResult.Settings.MN -join '' ; MFG_Name = $DeviceResult.Settings.MF -join '' ; MFG_Model = $DeviceResult.Settings.MO -join '' ; IP = $DeviceResult.Settings.IP -join '' ; Ext_IP = $DeviceResult.Settings.EI -join '' ; Creation = Convert-UnixTimeToDateTime ($DeviceResult.Settings.CD -join '') ; TimeStamp = Convert-UnixTimeToDateTime ($DeviceResult.Settings.TS -join '') ; ClientVersion = $DeviceResult.Settings.VN -join '' ; InstallID = $DeviceResult.Settings.II -join '' ; InstallMode = $DeviceResult.Settings.IM -join '' ; LastRestore = Convert-UnixTimeToDateTime ($DeviceResult.Settings.RTG -join '') ; ProfileID = $DeviceResult.Settings.OI -join '' } } } ## Enumerate devices under specified Sub-distributor or lower partner #endregion ----- Backup.Management JSON Calls ---- #endregion ----- Functions ---- Send-APICredentialsCookie Write-Output $Script:strLineSeparator Write-Output "" Get-PartnerInfo $cred0 $filter1 = "AT == 1" ## Exclude M365 devices Get-Devices $DeviceDetail = $DeviceDetail | select-object PartnerID,PartnerName,Reference,AccountId,DeviceName,MachineName,Creation,LastRestore,TimeStamp,DataSources,ClientVersion,MFG_Name,MFG_Model,OS,InstallMode,InstallID,Ext_IP,IP,location,productID,Profile,Notes | Sort-Object Partnername,devicename,timestamp ## Display GridView (Required -GridView Parameter) if ($GridView) { $DeviceDetail | out-gridview -Title "Device Installation Audit" } ## Export CSV $Script:csvoutputfile = "$ExportPath\$($CurrentDate)_Backup_Install_Audit_$($Partnername -replace(`" \(.*\)`",`"`") -replace(`"[^a-zA-Z_0-9]`",`"`"))_$($PartnerId).csv" $DeviceDetail | Export-Csv -Path $csvoutputfile -delimiter "$Delimiter" -NoTypeInformation -Encoding UTF8 -append ## Generate XLS from CSV $xlsoutputfile = $csvoutputfile.Replace("csv","xlsx") Save-CSVasExcel $csvoutputfile Write-output $Script:strLineSeparator ## Launch CSV or XLS if Excel is installed (Required -Launch Parameter) if ($Launch) { If (test-path HKLM:SOFTWARE\Classes\Excel.Application) { Start-Process "$xlsoutputfile" Write-output $Script:strLineSeparator Write-Output " Opening XLS file" }else{ Start-Process "$csvoutputfile" Write-output $Script:strLineSeparator Write-Output " Opening CSV file" Write-output $Script:strLineSeparator } } Write-output $Script:strLineSeparator Write-Output " CSV Path = $csvoutputfile" Write-Output " XLS Path = $xlsoutputfile" Write-Output "" Start-Sleep -seconds 10 ``` ```json Response Example {"success":true} ``` # SCRIPT # Set-APICredentials # Get-APICredentials # Send-APICredentialsCookie # Convert-UnixTimeToDateTime # Save-CSVasExcel # Resolve-FullPath # Release-Ref # Get-PartnerInfo # Get-Devices