Passing the variable/ argument like backup Job name or job id, in script configuration in veeam backup and replication

[Aravind]

Hello,

Currently we are working on powershell script which pushes the backup related information to a third party tool. We want to know is there any way to pass the arguments like Backup job name or job id in the script configuration.
Suppose lets say a backup job called "Agent back up" starts and get finished. After this the powershell script gets executed where we need to pass the name of backup job (in this case it is "Agent back up"). So like from where should we need get this name and pass it in the script?

Hoping to get some help in this forum.

[david.domask]

Hi @Aravind, do you want just general collection on the jobs running or you want each job to report on itself when it runs?

I think probably you want something like MyVeeamReport: https://gist.github.com/smasterson/9136468

You could use the code from there as a framework to understand what cmdlets to use to get more information.

If you want to have each job report on itself, you can use this code to get the job from a pre/post job script:

$ScriptPID = Get-WMIObject win32_process | Where-Object {$_.ProcessID -eq $PID}
$ParentProc = Get-WMIObject win32_process | Where-Object {$_.ProcessID -eq $ScriptPID.ParentProcessId}
$JobID = $ParentProc.CommandLine.Split()[7].Trim('"')
$Job = Get-VBRJob | Where-Object {$_.id -eq $JobID}

The $job variable will return the job itself and you can pass the Job to the various session cmdlets: https://helpcenter.veeam.com/docs/backu ... ml?ver=120

[marco.horstmann]

Hi Aravind,

I think I implemented all you need in this examples:

Code: Select all

function Get-MHOVbrJobNameFromPID {
    $parentPid = (Get-WmiObject Win32_Process -Filter "processid='$pid'").parentprocessid.ToString()
    $parentCmd = (Get-WmiObject Win32_Process -Filter "processid='$parentPid'").CommandLine
    $cmdArgs = $parentCmd.Replace('" "','","').Replace('"','').Split(',')
    $jobName = (Get-VBRJob | ? {$cmdArgs[4] -eq $_.Id.ToString()}).Name
    return $jobName
}

https://github.com/marcohorstmann/psscr ... veeam.psm1
https://horstmann.in/log-your-errors-di ... veeam-job/

Regards
Marco

[Aravind]

@ marco.horstmann
$jobName = (Get-VBRJob | ? {$cmdArgs[4] -eq $_.Id.ToString()}).Name
This command is returning null
I am getting $cmdArgs as - D:\Veeam Backup\Console\veeam.backup.shell.exe
$cmdArgs[4] is empty in my case.
What to do?

[Aravind]

Hi @Aravind, do you want just general collection on the jobs running or you want each job to report on itself when it runs?

I think probably you want something like MyVeeamReport: https://gist.github.com/smasterson/9136468

You could use the code from there as a framework to understand what cmdlets to use to get more information.

If you want to have each job report on itself, you can use this code to get the job from a pre/post job script:

$ScriptPID = Get-WMIObject win32_process | Where-Object {$_.ProcessID -eq $PID}
$ParentProc = Get-WMIObject win32_process | Where-Object {$_.ProcessID -eq $ScriptPID.ParentProcessId}
$JobID = $ParentProc.CommandLine.Split()[7].Trim('"')
$Job = Get-VBRJob | Where-Object {$_.id -eq $JobID}

The $job variable will return the job itself and you can pass the Job to the various session cmdlets: https://helpcenter.veeam.com/docs/backu ... ml?ver=120

$JobID = $ParentProc.CommandLine.Split()[7].Trim('"')
This command is not working in my case.
I am getting $ParentProc as "D:\Veeam Backup\Console\veeam.backup.shell.exe"

[Aravind]

Hi Aravind,

I think I implemented all you need in this examples:

Code: Select all

function Get-MHOVbrJobNameFromPID {
    $parentPid = (Get-WmiObject Win32_Process -Filter "processid='$pid'").parentprocessid.ToString()
    $parentCmd = (Get-WmiObject Win32_Process -Filter "processid='$parentPid'").CommandLine
    $cmdArgs = $parentCmd.Replace('" "','","').Replace('"','').Split(',')
    $jobName = (Get-VBRJob | ? {$cmdArgs[4] -eq $_.Id.ToString()}).Name
    return $jobName
}

https://github.com/marcohorstmann/psscr ... veeam.psm1
https://horstmann.in/log-your-errors-di ... veeam-job/

Regards
Marco

$jobName = (Get-VBRJob | ? {$cmdArgs[4] -eq $_.Id.ToString()}).Name
This command is returning null
I am getting $cmdArgs as - "D:\Veeam Backup\Console\veeam.backup.shell.exe"
$cmdArgs[4] is empty in my case.
What to do?

[david.domask]

Hi @Aravind,

I just tested on fully patched v12, and for me the code worked

Code: Select all

3439443e-b148-4e7d-9a33-3f2bb1fa0437

Job Name                  Type            State      Last Result  Description                                          
--------                  ----            -----      -----------  -----------                                          
vmware-ffi-cap-bb         VMware Backup   Working    None         Created by DDOM-VEEAM-RB4\some-guy at 8/29/2022 11:14...

The above got printed to a file I Out-Filed the last variable to.

What type of job did you try it with? I've not tested this with Agent based jobs, so maybe that's the difference? And not sure on Backup Copies, since with the new Backup Copy format, that gets a bit tricky, but maybe you can output the $Job variable to some file in your pre-job script and show what it returns.

[marco.horstmann]

@Aravind Did you run this manually? Because it needs to be run as Pre-Job Script. Otherwise it would not work.