Skip to content

feat(bootstrap): add debug params, use ToString() for Veeam IDs #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tigattack merged 3 commits into from
May 21, 2025
Merged

feat(bootstrap): add debug params, use ToString() for Veeam IDs #116

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
150224b
feat(bootstrap): add `JobId`, `SessionId` params for debugging
tigattack May 21, 2025
88a45b5
refactor(bootstrap): use `ToString()` for job/session IDs
tigattack May 21, 2025
e7321c5
[CI] Run script formatter
github-actions[bot] May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 42 additions & 13 deletions Bootstrap.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
param (
# Params allow for manually launching the script for debugging
[Parameter(Mandatory = $false)]
[string]$JobId = $null,
[Parameter(Mandatory = $false)]
[string]$SessionId = $null
)

$IsDebug = $false

if (($JobId -and -not $SessionId) -or (-not $JobId -and $SessionId)) {
Write-Output 'ERROR: If one of JobId or SessionId is provided, the other must also be specified.'
exit 1
}
elseif ($JobId -and $SessionId) {
Write-Output 'INFO: JobId and SessionId are provided. Using them to start the script.'
$IsDebug = $true
}

# Import modules
Import-Module Veeam.Backup.PowerShell -DisableNameChecking
Import-Module "$PSScriptRoot\resources\Logger.psm1"
Expand All @@ -11,8 +30,10 @@ $logFile = "$PSScriptRoot\log\$($date)_Bootstrap.log"
$idRegex = '[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}'
$supportedTypes = 'Backup', 'EpAgentBackup', 'Replica', 'BackupToTape', 'FileToTape'

# Start logging to file
Start-Logging -Path $logFile
if (-not $IsDebug) {
# Start logging to file
Start-Logging -Path $logFile
}

# Log version
Write-LogMessage -Tag 'INFO' -Message "Version: $(Get-Content "$PSScriptRoot\resources\version.txt" -Raw)"
Expand Down Expand Up @@ -40,21 +61,29 @@ else {
Write-LogMessage -Tag 'ERROR' -Message "Failed to validate configuration: $($validationResult.Message)"
}

# Get the command line used to start the Veeam session.
$parentPid = (Get-CimInstance Win32_Process -Filter "processid='$PID'").parentprocessid.ToString()
$parentCmd = (Get-CimInstance Win32_Process -Filter "processid='$parentPID'").CommandLine
if ($IsDebug) {
Write-LogMessage -Tag 'INFO' -Message "JobId: $JobId"
Write-LogMessage -Tag 'INFO' -Message "SessionId: $SessionId"
}
else {
Write-LogMessage -Tag 'INFO' -Message 'Attempting to retrieve job ID and session ID from the parent process.'

# Get the Veeam job and session IDs
$jobId = ([regex]::Matches($parentCmd, $idRegex)).Value[0]
$sessionId = ([regex]::Matches($parentCmd, $idRegex)).Value[1]
# Get the command line used to start the Veeam session.
$parentPid = (Get-CimInstance Win32_Process -Filter "processid='$PID'").parentprocessid.ToString()
$parentCmd = (Get-CimInstance Win32_Process -Filter "processid='$parentPID'").CommandLine

# Get the Veeam job and session IDs
$JobId = ([regex]::Matches($parentCmd, $idRegex)).Value[0]
$SessionId = ([regex]::Matches($parentCmd, $idRegex)).Value[1]
}

# Get the Veeam job details and hide warnings to mute the warning regarding deprecation of the use of some cmdlets to get certain job type details.
# At time of writing, there is no alternative way to discover the job time.
Write-LogMessage -Tag 'INFO' -Message 'Getting VBR job details'
$job = Get-VBRJob -WarningAction SilentlyContinue | Where-Object {$_.Id.Guid -eq $jobId}
$job = Get-VBRJob -WarningAction SilentlyContinue | Where-Object {$_.Id.ToString() -eq $JobId}
if (!$job) {
# Can't locate non tape job so check if it's a tape job
$job = Get-VBRTapeJob -WarningAction SilentlyContinue | Where-Object {$_.Id.Guid -eq $jobId}
$job = Get-VBRTapeJob -WarningAction SilentlyContinue | Where-Object {$_.Id.ToString() -eq $JobId}
$JobType = $job.Type
}
else {
Expand All @@ -64,7 +93,7 @@ else {

# Get the session information and name.
Write-LogMessage -Tag 'INFO' -Message 'Getting VBR session information'
$sessionInfo = Get-VBRSessionInfo -SessionId $sessionId -JobType $JobType
$sessionInfo = Get-VBRSessionInfo -SessionId $SessionId -JobType $JobType
$jobName = $sessionInfo.JobName
$vbrSessionLogger = $sessionInfo.Session.Logger

Expand All @@ -76,7 +105,7 @@ if ($JobType -notin $supportedTypes) {
exit 1
}

Write-LogMessage -Tag 'INFO' -Message "Bootstrap script for Veeam job '$jobName' (job $jobId session $sessionId) - Session & job detection complete."
Write-LogMessage -Tag 'INFO' -Message "Bootstrap script for Veeam job '$jobName' (job $JobId session $SessionId) - Session & job detection complete."

# Set log file name based on job
## Replace spaces if any in the job name
Expand All @@ -90,7 +119,7 @@ $newLogfile = "$PSScriptRoot\log\$($date)-$($logJobName).log"

# Build argument string for the alert sender script.
$powershellArguments = "-NoProfile -File $PSScriptRoot\AlertSender.ps1", `
"-SessionId `"$sessionId`"", `
"-SessionId `"$SessionId`"", `
"-JobType `"$JobType`"", `
"-Config `"$configRaw`"", `
"-Logfile `"$newLogfile`""
Expand Down
Loading