--- updatedAt: 2025-08-14T13:34:47.000Z agentTools: siteIndex: https://developer.n-able.com/llms.txt projectIndex: https://developer.n-able.com/n-central/llms.txt --- # Cove Data Protection Bulk Set GUI Password ```powershell PowerShell <# ----- About: ---- # Bulk Set SW Backup GUI Password # Revision v09 - 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 # Check partner level/ Enumerate partners/ GUI select partner # Enumerate devices/ GUI select devices # Prompt/ Set/ Wipe GUI password via Remote commands # # Use the -AllPartners switch parameter to skip GUI partner selection # Use the -AllDevices switch parameter to skip GUI device selection # # Use the -SetGUIPassword (default) parameter to be prompted to enter a Secure GUI Password to be applied # Use the -RestoreOnly parameter with the -SetGUIPassword parameter to allow restores when GUI password is set # Use the -WipeGUIPassword parameter to clear the GUI password from selected devices # 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/console/remote-commands.htm # -----------------------------------------------------------#> ## Behavior [CmdletBinding(DefaultParameterSetName="SetGUIPW")] Param ( [Parameter(ParameterSetName="WipeGUIPW",Mandatory=$False)] [Switch]$WipeGUIPassword, ## Clear GUI Password [Parameter(ParameterSetName="SetGUIPW",Mandatory=$False)] [switch]$SetGUIPassword, ## Specify GUI Password to set [Parameter(ParameterSetName="SetGUIPW",Mandatory=$False)] [Switch]$RestoreOnly, ## Allow Restore Only GUI Access [Parameter(ParameterSetName="SetGUIPW",Mandatory=$False)] [Parameter(ParameterSetName="WipeGUIPW",Mandatory=$False)][Switch]$AllPartners, ## Skip partner selection [Parameter(ParameterSetName="SetGUIPW",Mandatory=$False)] [Parameter(ParameterSetName="WipeGUIPW",Mandatory=$False)] [Switch]$AllDevices, ## Skip device selection [Parameter(Mandatory=$False)] [switch]$ClearCredentials ## Remove Stored API Credentials at start of script ) #region ----- Environment, Variables, Names and Paths ---- Clear-Host Write-output " Bulk Set GUI Password `n" $Syntax = Get-Command $PSCommandPath -Syntax ; Write-Output " Script Parameter Syntax:`n`n $Syntax" Write-output " Current Parameters:" Write-output " -AllPartners = $AllPartners" Write-output " -AllDevices = $AllDevices" Write-output " -SetGUIPassword = $SetGUIPassword" Write-output " -RestoreOnly = $RestoreOnly" Write-output " -WipeGUIPassword = $WipeGUIPassword" $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" $urlJSON = 'https://api.backup.management/jsonapi' #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 " Enter Exact, Case Sensitive Partner Name for SolarWinds Backup.Management API i.e. 'Acme, Inc (bob@acme.net)'" DO{ $Script: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 #endregion ----- Data Conversion ---- #region ----- Backup.Management JSON Calls ---- Function Send-GetPartnerInfo ($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 $RestrictedPartnerLevel = @("Root","Sub-root","Distributor") if ($Partner.result.result.Level -notin $RestrictedPartnerLevel) { [String]$Script:Uid = $Partner.result.result.Uid [int]$Script:PartnerId = [int]$Partner.result.result.Id [String]$script:Level = $Partner.result.result.Level [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 $($Partner.result.result.Level) Partner Level Not Allowed" Write-Output $Script:strLineSeparator $Script:PartnerName = Read-Host " Enter EXACT Case Sensitive Customer/ Partner displayed name to lookup i.e. 'Acme, Inc (bob@acme.net)'" Send-GetPartnerInfo $Script:partnername } if ($partner.error) { write-output " $($partner.error.message)" $Script:PartnerName = Read-Host " Enter EXACT Case Sensitive Customer/ Partner displayed name to lookup i.e. 'Acme, Inc (bob@acme.net)'" Send-GetPartnerInfo $Script:partnername } } ## get PartnerID and Partner Level Function CallJSON($url,$object) { $bytes = [System.Text.Encoding]::UTF8.GetBytes($object) $web = [System.Net.WebRequest]::Create($url) $web.Method = "POST" $web.ContentLength = $bytes.Length $web.ContentType = "application/json" $stream = $web.GetRequestStream() $stream.Write($bytes,0,$bytes.Length) $stream.close() $reader = New-Object System.IO.Streamreader -ArgumentList $web.GetResponse().GetResponseStream() return $reader.ReadToEnd()| ConvertFrom-Json $reader.Close() } Function Send-EnumeratePartners { # ----- Get Partners via EnumeratePartners ----- # (Create the JSON object to call the EnumeratePartners function) $objEnumeratePartners = (New-Object PSObject | Add-Member -PassThru NoteProperty jsonrpc '2.0' | Add-Member -PassThru NoteProperty visa $Script:visa | Add-Member -PassThru NoteProperty method 'EnumeratePartners' | Add-Member -PassThru NoteProperty params @{ parentPartnerId = $PartnerId fetchRecursively = "false" fields = (0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22) } | Add-Member -PassThru NoteProperty id '1')| ConvertTo-Json -Depth 5 # (Call the JSON Web Request Function to get the EnumeratePartners Object) [array]$Script:EnumeratePartnersSession = CallJSON $urlJSON $objEnumeratePartners $Script:visa = $EnumeratePartnersSession.visa #Write-Output $Script:strLineSeparator #Write-Output " Using Visa:" $Script:visa #Write-Output $Script:strLineSeparator # (Added Delay in case command takes a bit to respond) Start-Sleep -Milliseconds 100 # (Get Result Status of EnumerateAccountProfiles) $EnumeratePartnersSessionErrorCode = $EnumeratePartnersSession.error.code $EnumeratePartnersSessionErrorMsg = $EnumeratePartnersSession.error.message # (Check for Errors with EnumeratePartners - Check if ErrorCode has a value) if ($EnumeratePartnersSessionErrorCode) { Write-Output $Script:strLineSeparator Write-Output " EnumeratePartnersSession Error Code: $EnumeratePartnersSessionErrorCode" Write-Output " EnumeratePartnersSession Message: $EnumeratePartnersSessionErrorMsg" Write-Output $Script:strLineSeparator Write-Output " Exiting Script" # (Exit Script if there is a problem) #Break Script } Else { # (No error) $Script:EnumeratePartnersSessionResults = $EnumeratePartnersSession.result.result | select-object Name,@{l='Id';e={($_.Id).tostring()}},Level,ExternalCode,ParentId,LocationId,* -ExcludeProperty Company -ErrorAction Ignore $Script:EnumeratePartnersSessionResults | ForEach-Object {$_.CreationTime = [timezone]::CurrentTimeZone.ToLocalTime(([datetime]'1/1/1970').AddSeconds($_.CreationTime))} $Script:EnumeratePartnersSessionResults | ForEach-Object { if ($_.TrialExpirationTime -ne "0") { $_.TrialExpirationTime = [timezone]::CurrentTimeZone.ToLocalTime(([datetime]'1/1/1970').AddSeconds($_.TrialExpirationTime))}} $Script:EnumeratePartnersSessionResults | ForEach-Object { if ($_.TrialRegistrationTime -ne "0") {$_.TrialRegistrationTime = [timezone]::CurrentTimeZone.ToLocalTime(([datetime]'1/1/1970').AddSeconds($_.TrialRegistrationTime))}} $Script:SelectedPartners = $EnumeratePartnersSessionResults | Select-object * | Where-object {$_.name -notlike "001???????????????- Recycle Bin"} | Where-object {$_.Externalcode -notlike '`[??????????`]* - ????????-????-????-????-????????????'} $Script:SelectedPartner = $Script:SelectedPartners += @( [pscustomobject]@{Name=$PartnerName;Id=[string]$PartnerId;Level=''} ) if ($AllPartners) { $script:Selection = $Script:SelectedPartners |Select-object id,Name,Level,CreationTime,State,TrialRegistrationTime,TrialExpirationTime,Uid | sort-object Level,name Write-Output $Script:strLineSeparator Write-Output " All Partners Selected" }else{ $script:Selection = $Script:SelectedPartners |Select-object id,Name,Level,CreationTime,State,TrialRegistrationTime,TrialExpirationTime,Uid | sort-object Level,name | out-gridview -Title "Current Partner | $partnername" -OutputMode Single if($null -eq $Selection) { # Cancel was pressed # Run cancel script Write-Output $Script:strLineSeparator Write-Output " No Partners Selected" Break } else { # OK was pressed, $Selection contains what was chosen # Run OK script [int]$script:PartnerId = $script:Selection.Id [String]$script:PartnerName = $script:Selection.Name } } } } ## EnumeratePartners API Call Function Send-GetDevices { $url = "https://api.backup.management/jsonapi" $data = @{} $data.jsonrpc = '2.0' $data.id = '2' $data.visa = $visa $data.method = 'EnumerateAccountStatistics' $data.params = @{} $data.params.query = @{} $data.params.query.PartnerId = [int]$PartnerId $data.params.query.Filter = $Filter1 $data.params.query.Columns = @("AU","AR","AN","MN","AL","LN","OP","OI","OS","PD","AP","PF","PN","CD","TS","TL","T3","US","AA843","AA77","AA2048") $data.params.query.OrderBy = "CD DESC" $data.params.query.StartRecordNumber = 0 $data.params.query.RecordsCount = 2000 $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 ` -WebSession $websession ` -UseBasicParsing $Script:cookies = $websession.Cookies.GetCookies($url) $Script:websession = $websession #Write-output "$($Script:cookies[0].name) = $($cookies[0].value)" $Script:Devices = $webrequest | convertfrom-json #$Script:visa = $authenticate.visa $Script:DeviceDetail = @() ForEach ( $DeviceResult in $Devices.result.result ) { $Script:DeviceDetail += New-Object -TypeName PSObject -Property @{ AccountID = [Int]$DeviceResult.AccountId; PartnerID = [string]$DeviceResult.PartnerId; DeviceName = $DeviceResult.Settings.AN -join '' ; ComputerName = $DeviceResult.Settings.MN -join '' ; DeviceAlias = $DeviceResult.Settings.AL -join '' ; PartnerName = $DeviceResult.Settings.AR -join '' ; Reference = $DeviceResult.Settings.PF -join '' ; Creation = Convert-UnixTimeToDateTime ($DeviceResult.Settings.CD -join '') ; TimeStamp = Convert-UnixTimeToDateTime ($DeviceResult.Settings.TS -join '') ; LastSuccess = Convert-UnixTimeToDateTime ($DeviceResult.Settings.TL -join '') ; SelectedGB = (($DeviceResult.Settings.T3 -join '') /1GB) ; UsedGB = (($DeviceResult.Settings.US -join '') /1GB) ; DataSources = $DeviceResult.Settings.AP -join '' ; Account = $DeviceResult.Settings.AU -join '' ; Location = $DeviceResult.Settings.LN -join '' ; Notes = $DeviceResult.Settings.AA843 -join '' ; GUIPassword = $DeviceResult.Settings.AA2048 -join '' ; TempInfo = $DeviceResult.Settings.AA77 -join '' ; Product = $DeviceResult.Settings.PN -join '' ; ProductID = $DeviceResult.Settings.PD -join '' ; Profile = $DeviceResult.Settings.OP -join '' ; OS = $DeviceResult.Settings.OS -join '' ; ProfileID = $DeviceResult.Settings.OI -join '' } } } ## EnumerateAccountStatistics API Call Function Send-RemoteCommand { if ($SecurePassword.length -ge 1) {$UnsecureGUIPassword = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecurePassword))} if ($RestoreOnly) { $PasswordParam = "password $($UnsecureGUIPassword)`nrestore_only allow" }else{ $PasswordParam = "password $($UnsecureGUIPassword)`nrestore_only disallow" } if ($WipeGUIPassword) { $UnsecureGUIPassword = "" Write-Output " Wiping GUI Password for $($SelectedDevices.AccountId.count) Devices, please be patience. " } $url = "https://backup.management/jsonrpcv1" $Script:data = @{} $data.jsonrpc = '2.0' $data.id = 'jsonrpc' $data.method = 'SendRemoteCommands' $data.params = @{} $data.params.command = "set gui password" $data.params.parameters = "$PasswordParam" $data.params.ids = @([System.Int32[]]$selecteddevices.accountid) $webrequest = Invoke-WebRequest -Method POST ` -ContentType 'application/json' ` -Body (ConvertTo-Json $data -depth 5) ` -Uri $url ` -WebSession $websession ` -UseBasicParsing $Script:cookies = $websession.Cookies.GetCookies($url) $Script:websession = $websession $Script:Result = $webrequest | convertfrom-json } ## SendRemoteCommands API Call #endregion ----- Backup.Management JSON Calls ---- #endregion ----- Functions ---- $switch = $PSCmdlet.ParameterSetName Send-APICredentialsCookie Write-Output $Script:strLineSeparator Write-Output "" Send-GetPartnerInfo $Script:cred0 Send-EnumeratePartners $filter1 = "AT == 1 AND PN != 'Documents'" ### Excludes M365 and Documents devices from lookup. Send-GetDevices $partnerId if ($AllDevices) { $script:SelectedDevices = $DeviceDetail | Select-Object PartnerId,PartnerName,Reference,AccountID,DeviceName,ComputerName,DeviceAlias,GUIPassword,Creation,TimeStamp,LastSuccess,ProductId,Product,ProfileId,Profile,DataSources,SelectedGB,UsedGB,Location,OS,Notes,TempInfo Write-Output $Script:strLineSeparator Write-Output " $($SelectedDevices.AccountId.count) Devices Selected" }else{ $script:SelectedDevices = $DeviceDetail | Select-Object PartnerId,PartnerName,Reference,AccountID,DeviceName,ComputerName,DeviceAlias,GUIPassword,Creation,TimeStamp,LastSuccess,ProductId,Product,ProfileId,Profile,DataSources,SelectedGB,UsedGB,Location,OS,Notes,TempInfo | Out-GridView -title "Current Partner | $partnername" -OutputMode Multiple } if($null -eq $SelectedDevices) { # Cancel was pressed # Run cancel script Write-Output $Script:strLineSeparator Write-Output " No Devices Selected" Break } else { # OK was pressed, $Selection contains what was chosen # Run OK script $script:SelectedDevices | Select-Object PartnerId,PartnerName,Reference,@{Name="AccountID"; Expression={[int]$_.AccountId}},DeviceName,ComputerName,DeviceAlias,GUIPassword,Creation,TimeStamp | Sort-object AccountId | Format-Table if ($PSCmdlet.ParameterSetName -eq "SetGUIPW") { $SecurePassword = Read-Host " Enter Backup Manager GUI Password to be applied to $($SelectedDevices.AccountId.count) Devices" -AsSecureString Write-Output $Script:strLineSeparator Write-Output " Applying GUI Password to $($SelectedDevices.AccountId.count) Devices, please be patience. " } Send-RemoteCommand $result.result.result | Select-Object Id,@{Name="Status"; Expression={$_.Result.code}},@{Name="Message"; Expression={$_.Result.Message}} | Format-Table } ``` ```json Response Example {"success":true} ``` # SCRIPT # Set-APICredentials Region Authentication: Set API credentials if not present # Get-APICredentials Get API credentials ifpresent # Send-APICredentialsCookie Read API Credential File before Authentication Use Backup.Management credentials to Authenticate # Convert-UnixTimeToDateTime Region Data Conversion: Convert epoch time to date time # Send-GetPartnerInfo Region Backup.Management JSON Calls : Get PartnerID and Partner Level # CallJSON # Send-EnumeratePartners Get Partners via EnumeratePartners EnumeratePartners API Call # Send-GetDevices EnumerateAccountStatistics API Call # Send-RemoteCommand SendRemoteCommands API Call