Symantec Backup Exec PowerShell
I was wondering if it is possible to connect using PowerShell to Symantec Backup Exec server, and pull a summary of backup jobs. You might think that Symantec Backup Exec already has many notification options, so why to invest time to do that via PowerShell.
Well, imagine that you have a complex backup cycle and you want to do customized reporting, but you need to get the data first. Also, sometimes you might have many installations of Backup Exec and you want to generate one report. It is always nice to know that you can use PowerShell to query information about your Backup Exec server.
Symantec Backup Exec PowerShell report
This script will connect to Symantec Backup Exec server and using PowerShell, and will collect the following information about the backup jobs:
- Job Name
- Selection Summary
- Start Time
- Elapsed Time
- Job Status
- Media Label
- Total Data Size Bytes
- Job Rate MB Per Minute
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.
Below is the list of Script Parameters:
Path to store script files like “.\” to indicate current directory or full path like C:\myfiles.
Send Mail after completion. Set to $True to enable. If enabled, -MailFrom, -MailTo, -MailServer are mandatory
Email address to send from.
Email address to send to.
Expression filter to filter on Job names. Example is “*OffSite*” to filter for any job with the word “OffSite” in the job name.
Filter jobs happening in the past X days.This parameter cannot be used with the -FromLastJobRun switch parameter
Switch parameter. When used, the script will bring only the last run job instances. This switch parameter cannot be used with the -Days parameter.
Get BackupExec Jobs and send email with the results
Get-BEJobs.ps1 -ScriptFilesPath .\ -SendMail:$true -MailFrom firstname.lastname@example.org -MailTo email@example.com -MailServer smtp.contoso.com
Get BackupExec Jobs happening in the last 3 days
Get-BEJobs.ps1 -ScriptFilesPath .\ -Days 3
Get BackupExec Jobs with the name containing “*Yearly*”
Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike "*Yearly*"
Get BackupExec Jobs with the name containing “*Yearly*” and only returning the last job run results
Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike "*Yearly*" -FromLastJobRun
Get BackupExec Jobs with the name containing “*Yearly*” happening last week
Get-BEJobs.ps1 -ScriptFilesPath .\ -NameLike "*Yearly*" -Days 7
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 results via an email if you choose to configure SMTP settings via one of the script parameters.
The challenge I faced writing this script is querying the Media Label field because this field is obtained from the XML returned by 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.
You can download the script from Microsoft TechNet Gallery.
Blog Post Notification
Be the first to get notification when key blog post articles are released. No marketing material.
How hard would it be to show all the tapes used in a backup job instead of just the one tape?
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.
im trying to get it, but the PowerShell module does not provide such information even when pulling the XML of the job itself. I will continue to search and see.
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.
Thanks.. i will do another try to understand how data is stored and try to pull it. Hope it will work 🙂
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?
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?
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?
Sure mean while i will review the script again
Did you have reviewed the script?
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
I was wondering this as well. This would be really helpful.
I LOVE THIS SCRIPT!!
Very good script, I use it everyday
Could you please add an option for TotalDataSizeBytes in GB ?
I’m think it’s more practical.
Is there a way to add Totaldatasizebytes in GB
I love your script… I am new to scripting, but i was trying to modify it to display currently running jobs as well. Can you point me to where i can change that