Symantec BackupExec PowerShell Job Report

Script Info

This script will connect to Symantec BackupExec server and using PowerShell, it will collect the following  information about the backup jobs:

  • Job Name
  • Selection Summary
  • Storage
  • Start Time
  • Elapsed Time
  • Job Status
  • Media Label
  • Total Data Size Bytes
  • Job Rate MB Per Minute

Script Filters

The script has two filters :

  • Name Like Expression: You can say for example give me jobs where the name contains “*OffSite*”
  • Time Expression: You can either use:
    • Since X Days : like give me all jobs happened since X days
    • From Last Job Run: give me the last job run information for the jobs

Script Parameters

Below is the list of Script Parameters:

.PARAMETER ScriptFilesPath
Path to store script files like “.\” to indicate current directory or full path like C:\myfiles

.PARAMETER SendMail
Send Mail after completion. Set to $True to enable. If enabled, -MailFrom, -MailTo, -MailServer are mandatory

.PARAMETER MailFrom
Email address to send from.

.PARAMETER MailTo
Email address to send to.

.PARAMETER NameLike
Expression filter to filter on Job names. Example is “*OffSite*” to filter for any job with the word “OffSite” in the job name.

.PARAMETER Days
Filter jobs happening in the past X days.This parameter cannot be used with the -FromLastJobRun switch parameter

.PARAMETER FromLastJobRun
Switch parameter. When used, the script will bring only the last run job instances. This switch parameter cannot be used with the (-Days) parameter.

 

Script Examples

.EXAMPLE
Get BackupExec Jobs and send email with the results
\Get-BEJobs.ps1 -ScriptFilesPath .\ -SendMail:$true -MailFrom noreply@contoso.com -MailTo me@contoso.com -MailServer smtp.contoso.com

.EXAMPLE
Get BackupExec Jobs happening in the last 3 days
\Get-BEJobs.ps1 -ScriptFilesPath .\ -Days 3

.EXAMPLE
Get BackupExec Jobs with the name containing “*Yearly*”
\Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike “*Yearly*”

.EXAMPLE
Get BackupExec Jobs with the name containing “*Yearly*” and only returning the last job run results
\Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike “*Yearly*” -FromLastJobRun

.EXAMPLE
Get BackupExec Jobs with the name containing “*Yearly*” happening last week
\Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike “*Yearly*” -Days 7

Script Output

The script will generate three log files:

  • Info Log : will help you track what the script is doing.
  • Error Log : in case of errors
  • Detailed Log : contains detailed information about each job run

The script will also generate a nice HTML table that contains the list of jobs and their information

The script has an option to send these info via an email if you choose to configure SMTP settings via one of the script parameters.

BackupExec PowerShell Report

Notes

The challenge i faced writing this script is querying the Media Label field because this field is represented by XML file returned from the Get-JobLog.

So if you write Get-Job |Get-JobHistory |GetJobLog

then you will have XML file with the media label information there. I had to do some string operations to extract the media label information.

The script should be running from within the BackupExec server and it is tested with BackupExec 2014 only.

 

Download Script

You can download the script from here Get-BEJobs

14 comments on “Symantec BackupExec PowerShell Job Report

    • Problem that they are not listed in same line but seperated in multiple lines..so it is hard to find a terminator where the tape list ends.. this is because im doing substring on the job log xml which is not easy and not object based.

  1. Ammar: Great Job on this. Pulling values like All Media Used and other useful metrics is not trivial, even when using the BE reporting tool. I do agree that multiple tapes / storage B2D files is valuable, but it also makes a bloated report. A consideration if you revise the script might be to add a hyperlink in the job name that would open the job log XML file. (Of course assuming read access to the Backup Exec log files). The script does work on BE2012 too.

  2. Ammar
    Thanks for looking into it. I wonder if Symantec just takes all the media labels from a given job log then just removes the duplicates and displays that output as All Media Used?

  3. Ammar, first of all, congrats for the fantastic script you’ve developed! I would like to ask why the report gives me the last ran jobs plus the queue jobs stated as N/A?

  4. Thank you very much for this script Ammar!

    When I run this script, I’m having many N/A jobs as output, Can I exclude this?
    If possible and you don’t know what I mean with N/A. I can send the output to you?

  5. Hey Ammar,

    I’m not all that familiar with powershell so I was wondering if you could tell me how to filter for two different job names at once? I’ve got it to filter for one but when I add a second one like this: “job 1”, “job 2” it just crashes and won’t run

  6. Hello Ammar,
    Very good script, I use it everyday
    Could you please add an option for TotalDataSizeBytes in GB ?
    I’m think it’s more practical.

    Thanks.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s