Start-VBRZip in Veeam Backup Free Edition

[veremin]

Can you post the script you're trying to run? At least the portion that has been modified by you? Also, aren't you trying to backup to a repository, instead of a folder, by any chance? Thanks.

[ice2921]

Sure im using this I think its backing up to a folder vs the repository

Code: Select all

# Author: Vladimir Eremin
# Created Date: 3/24/2015
# http://forums.veeam.com/member31097.html
# 

##################################################################
#                   User Defined Variables
##################################################################

# Names of VMs to backup separated by comma (Mandatory). For instance, $VMNames = “VM1”,”VM2”
$VMNames = "VMNAME"

# Name of vCenter or standalone host VMs to backup reside on (Mandatory)
$HostName = "HOST03"

# Directory that VM backups should go to (Mandatory; for instance, C:\Backup)
$Directory = "E:\veeam backup"

# Desired compression level (Optional; Possible values: 0 - None, 4 - Dedupe-friendly, 5 - Optimal, 6 - High, 9 - Extreme) 
$CompressionLevel = "5"

# Quiesce VM when taking snapshot (Optional; VMware Tools are required; Possible values: $True/$False)
$EnableQuiescence = $False

# Protect resulting backup with encryption key (Optional; $True/$False)
$EnableEncryption = $False

# Encryption Key (Optional; path to a secure string)
$EncryptionKey = ""

# Retention settings (Optional; By default, VeeamZIP files are not removed and kept in the specified location for an indefinite period of time. 
# Possible values: Never , Tonight, TomorrowNight, In3days, In1Week, In2Weeks, In1Month)
$Retention = "Never"

##################################################################
#                   Notification Settings
##################################################################

# Enable notification (Optional)
$EnableNotification = $True

# Email SMTP server
$SMTPServer = ""

# Email FROM
$EmailFrom = "" 

# Email TO
$EmailTo = ""

# Email subject
$EmailSubject = "Veeam Backups"

##################################################################
#                   Email formatting 
##################################################################

$style = "<style>BODY{font-family: Arial; font-size: 10pt;}"
$style = $style + "TABLE{border: 1px solid black; border-collapse: collapse;}"
$style = $style + "TH{border: 1px solid black; background: #dddddd; padding: 5px; }"
$style = $style + "TD{border: 1px solid black; padding: 5px; }"
$style = $style + "</style>"

##################################################################
#                   End User Defined Variables
##################################################################

#################### DO NOT MODIFY PAST THIS LINE ################
Asnp VeeamPSSnapin

$Server = Get-VBRServer -name $HostName
$MesssagyBody = @()

foreach ($VMName in $VMNames)
{
  $VM = Find-VBRViEntity -Name $VMName -Server $Server
  
  If ($EnableEncryption)
  {
    $EncryptionKey = Add-VBREncryptionKey -Password (cat $EncryptionKey | ConvertTo-SecureString)
    $ZIPSession = Start-VBRZip -Entity $VM -Folder $Directory -Compression $CompressionLevel -DisableQuiesce:(!$EnableQuiescence) -AutoDelete $Retention -EncryptionKey $EncryptionKey
  }
  
  Else 
  {
    $ZIPSession = Start-VBRZip -Entity $VM -Folder $Directory -Compression $CompressionLevel -DisableQuiesce:(!$EnableQuiescence) -AutoDelete $Retention
  }
  
  If ($EnableNotification) 
  {
    $TaskSessions = $ZIPSession.GetTaskSessions().logger.getlog().updatedrecords
    $FailedSessions =  $TaskSessions | where {$_.status -eq "EWarning" -or $_.Status -eq "EFailed"}
  
  if ($FailedSessions -ne $Null)
  {
    $MesssagyBody = $MesssagyBody + ($ZIPSession | Select-Object @{n="Name";e={($_.name).Substring(0, $_.name.LastIndexOf("("))}} ,@{n="Start Time";e={$_.CreationTime}},@{n="End Time";e={$_.EndTime}},Result,@{n="Details";e={$FailedSessions.Title}})
  }
   
  Else
  {
    $MesssagyBody = $MesssagyBody + ($ZIPSession | Select-Object @{n="Name";e={($_.name).Substring(0, $_.name.LastIndexOf("("))}} ,@{n="Start Time";e={$_.CreationTime}},@{n="End Time";e={$_.EndTime}},Result,@{n="Details";e={($TaskSessions | sort creationtime -Descending | select -first 1).Title}})
  }
  
  }   
}
If ($EnableNotification)
{
$Message = New-Object System.Net.Mail.MailMessage $EmailFrom, $EmailTo
$Message.Subject = $EmailSubject
$Message.IsBodyHTML = $True
$message.Body = $MesssagyBody | ConvertTo-Html -head $style | Out-String
$SMTP = New-Object Net.Mail.SmtpClient($SMTPServer)
$SMTP.Send($Message)
}

[veremin]

Ok, I think I've found out the problem. You're running a vSphere version of the script against Hyper-V infrastructure.

Kindly, download the appropriate version provided at the bottom of the said blog post. Also, be aware to set $False to $EnableNotification variable to disable notification completely, or fill requested information, such as SMTP server, from and to addresses, etc.

Thanks.

[ice2921]

Yeah i figured it out after I went back and looked at it the command in this case should be

Code: Select all

Find-VBRHvEntity

vs

Code: Select all

Find-VBRViEntity

So the reason it was that way is because in the blog post the link for the HV download has two files in it one called

Code: Select all

VeeamZIP (HV).ps1

and the other

Code: Select all

VeeamZIP (updated).ps1

i just assumed the one name updated was the correct one to use. Was just a little confused that's all thanks for providing a great script to the community.

[veremin]

Yep, archives available under links in first paragraph contain both versions (VI, HV). Thus, the confusion. In the meantime, the links provided at the bottom of the article lead to the archives having only one script version - which is correct and expected behaviour.

We're going to resolve the issue soon by correcting the first links.

Thanks.

[veremin]

The links have been updated with the correct archives containing only one script each.

Thank you for notifying us about the said inconsistency (special thanks goes to Rick Vanover for taking care about links update); appreciated.

[thomascouno]

Hi,

New to the forum so i hope this is in the correct place.

We are running VeeamZIP on our Windows 2012 R2 HyperV host with two Windows 2012 VM's.

I am having trouble with the powershell script to schedule the backup, we would also like SMTP reporting. I found this link on the forums which i attempted to follow but i did not work, i'm not really familiar with scripting backups so i may have been completely wrong. "https://www.veeam.com/blog/veeam-backup ... shell.html" I also attempted to follow this guide again with little success "http://blog.mwpreston.net/2015/04/29/sc ... n-backups/"

Does anybody have this working? If so could i take a peak at your code and edit to allow mine to work?

Thanks in advance,

Thomas

[PTide]

Hi,

Could you please elaborate on what exactly has gone wrong with the script? Any error messages?

Thank you.

[thomascouno]

Hi,

This is what i created using the 2nd link.

Code: Select all

Param(
  [Parameter(Mandatory=$true)][string]$VMNames = "vmname",
  [Parameter(Mandatory=$true)][string]$Directory = "backuplocation mapped drive",
  [Parameter(Mandatory=$true)][ValidateSet(5)][int]$Compression,
  [bool]$DisableQuiesce=$true,
  [Parameter(Mandatory=$true)][ValidateSet("Never")][string]$Autodelete
)
#Load Veeam Toolkit
& "C:\Program Files\Veeam\Backup and Replication\Backup\Initialize-VeeamToolkit.ps1"
#Validate any parameters
$vmentity = Find-VBRHvEntity -Name $"vmname"

I was told to change this as before i was set for VMware not HyperV

Code: Select all

if ($vmentity -eq $null)
{
  Write-Host "VM: $VM not found" -ForegroundColor "red"
  exit
}
if (-Not (Test-Path $Destination))
{
  Write-Host "Destination: $vmname not valid" -ForegroundColor "red"
  exit
}
if ($DisableQuiesce -eq $true)
{
    Start-VBRZip -Entity $vmentity -Folder $destination -Compression $Compression -AutoDelete $Autodelete -DisableQuiesce
}
else
{
    Start-VBRZip -Entity $vmentity -Folder $destination -Compression $Compression -AutoDelete $Autodelete
}

Then when testing the script via powershell i get this output.

Code: Select all

PS C:\Users\VMAdmin> C:\Users\VMAdmin\Documents\VeeamZip.ps1
cmdlet VeeamZip.ps1 at command pipeline position 1
Supply values for the following parameters:

- For some reason i have to type all these below.

Code: Select all

VMNames: vmname
Directory: destination
Compression: 5
Autodelete: Never
          Welcome to the Veeam Backup and Replication PowerShell Toolkit!

To list available commands, type Get-VBRCommand
To open online documentation on all available commands, type Get-VBRToolkitDocumentation

       Copyright © Veeam Software AG. All rights reserved.


Find-VBRHvEntity : Failed to connect to Veeam Backup & Replication server: 
Access denied.
At C:\Users\VMAdmin\Documents\VeeamZip.ps1:11 char:13
+ $vmentity = Find-VBRHvEntity -Name $"vmname"
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Find-VBRHvEntity], Exception
    + FullyQualifiedErrorId : System.Exception,Veeam.Backup.PowerShell.Command.FindVBRHvEntity
 
VM:  not found

Like i said above i do coding/scripting so i dont know if this is right.

Thanks,

[PTide]

Code: Select all

Find-VBRHvEntity : Failed to connect to Veeam Backup & Replication server:
Access denied.

Could you please run Find-VBRHvEntity command in PS console and post its output?

[thomascouno]

Hi,

Do you mean like this?

PS C:\Users\VMAdmin> Find-VBRHvEntity -Name $"vmname"
Find-VBRHvEntity : Failed to connect to Veeam Backup & Replication server:
Access denied.
At line:1 char:1
+ Find-VBRHvEntity -Name $"vmname"
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : NotSpecified: (:) [Find-VBRHvEntity], Exception
+ FullyQualifiedErrorId : System.Exception,Veeam.Backup.PowerShell.Command.FindVBRHvEntity

[PTide]

Did you run it on VBR server or from a remote PS console? If the latter then please try to do the same on VBR server. If the same error persists then please try to do the following:

Code: Select all

$Server = Get-VBRServer -name $HvHostName
$VM = Find-VBRHvEntity -Name $VMName -Server $Server

If that does not work I'd recommend reaching our support team directly (yes, it's available for FREE version users too).

P.S. If you have PS 2.0 installed try to update it as people already had similar problems with PS 2.0.

Thank you.

[Bjorko]

Hi, After backup VM Debian, I get notification: "Creating snapshot Microsoft Software Shadow Copy provider 1.0 (mode: Crash consistent)".
Task finished success. What does it mean?

I'm using Veeam B&R 9.0 with Hyper-V.

[veremin]

It means that crash consistent snapshot (the same as it would be after a power outage) has been taken on the Debian VM. Thanks.

[lirving]

Hi I have got the script working but it only seems to work on the local drive of the box it is installed on.

If I put in a UNC path or mapped drive to my NAS it brings up the transfer info screen but never transfers any data and then it just finishes without having done anything and with no error.

The NAS is a member of the domain and I am testing the script under a domain admin account.

Thanks

Lewis

[PTide]

Hi,

I'm not sure I'm following you. Do you want to execute the script that is located on your NAS or something else? Please elaborate.

Thank you.

[lirving]

Thanks for the reply

I am running the script from a windows 2012 r2 box that does not have a lot of free space.
It has a mapped drive ie drive X: which is mapped to "\\NAS\vms\backup", the NAS has 15 TB of free space.
if i run the script and use a local drive as the target ie "c:\backup" the script runs and stores the backup file in "c:\backup", but it fills up the hard drive.
if I run the script using the X: drive or the UNC path "\\NAS\vms\backup" as the target I see the progress info but there is no progress. All progress figures stay at 0 and the the script finishes without any error messages but no backup file has been written.

I figure that I could put a 4 terabyte drive into the windows box, schedule the script and synchronize the local backup folder with the NAS. The trouble is that adds complication that could be avoided if I could save directly to the NAS.
I mentioned the NAS being a domain member because as such the logged on user on the windows box has full access to the NAS folders ie there is no extra authentication required to save to the NAS folders.

Regards
Lewis

[PTide]

Did I get it right - you are using this VeeamZIP PS script?

[djockheck]

Hi,

since I use Veeam 9 (9.0.0.1491) I have a lot of messages like

Code: Select all

"Error: Zugriff verweigert --tr:Error code 0x00000005 Cannot create folder. Folder path: \\..."

- the folder path is valid
- the folder path is writeable
- only some (different) machines fail

Today I received a diskfull message too, but
- the directory has space anough (5 TB free),
- disk quota is disabled.

what can I do to find de reason?

cheers detlef

[Azerty]

Hi
First, sorry for my bad English.

I use the script of Vladimir Eremin : VeeamZIP for VMWare (Veeam Backup Free Edition).
And I wonder if it is possible to send an email with different recipients depending on the status of the backup. Success or failure.

I do not know how to do, I need your help.

Merci

[PTide]

I do not know how to do, I need your help.

Please find two extra variables: EmailToOk and EmailToFail. Assing needed values to them.

Code: Select all

# Author: Vladimir Eremin
# Created Date: 3/24/2015
# http://forums.veeam.com/member31097.html
#

##################################################################
#                   User Defined Variables
##################################################################

# Names of VMs to backup separated by semicolon (Mandatory)
$VMNames = ""

# Name of vCenter or standalone host VMs to backup reside on (Mandatory)
$HostName = ""

# Directory that VM backups should go to (Mandatory; for instance, C:\Backup)
$Directory = ""

# Desired compression level (Optional; Possible values: 0 - None, 4 - Dedupe-friendly, 5 - Optimal, 6 - High, 9 - Extreme)
$CompressionLevel = "5"

# Quiesce VM when taking snapshot (Optional; VMware Tools are required; Possible values: $True/$False)
$EnableQuiescence = $True

# Protect resulting backup with encryption key (Optional; $True/$False)
$EnableEncryption = $False

# Encryption Key (Optional; path to a secure string)
$EncryptionKey = ""

# Retention settings (Optional; By default, VeeamZIP files are not removed and kept in the specified location for an indefinite period of time.
# Possible values: Never , Tonight, TomorrowNight, In3days, In1Week, In2Weeks, In1Month)
$Retention = "Never"

##################################################################
#                   Notification Settings
##################################################################

# Enable notification (Optional)
$EnableNotification = $True

# Email SMTP server
$SMTPServer = ""

# Email FROM
$EmailFrom = ""

# Email TO
$EmailTo= ""

$EmailToOk = ""

$EmailToFail = ""

# Email subject
$EmailSubject = ""

##################################################################
#                   Email formatting
##################################################################

$style = "<style>BODY{font-family: Arial; font-size: 10pt;}"
$style = $style + "TABLE{border: 1px solid black; border-collapse: collapse;}"
$style = $style + "TH{border: 1px solid black; background: #dddddd; padding: 5px; }"
$style = $style + "TD{border: 1px solid black; padding: 5px; }"
$style = $style + "</style>"

##################################################################
#                   End User Defined Variables
##################################################################

#################### DO NOT MODIFY PAST THIS LINE ################
Asnp VeeamPSSnapin

$Server = Get-VBRServer -name $HostName
$MesssagyBody = @()

foreach ($VMName in $VMNames)
{
  $VM = Find-VBRViEntity -Name $VMName -Server $Server
 
  If ($EnableEncryption)
  {
    $EncryptionKey = Add-VBREncryptionKey -Password (cat $EncryptionKey | ConvertTo-SecureString)
    $ZIPSession = Start-VBRZip -Entity $VM -Folder $Directory -Compression $CompressionLevel -DisableQuiesce:(!$EnableQuiescence) -AutoDelete $Retention -EncryptionKey $EncryptionKey
  }
 
  Else
  {
    $ZIPSession = Start-VBRZip -Entity $VM -Folder $Directory -Compression $CompressionLevel -DisableQuiesce:(!$EnableQuiescence) -AutoDelete $Retention
  }
 
  If ($EnableNotification)
  {
    $TaskSessions = $ZIPSession.GetTaskSessions().logger.getlog().updatedrecords
    $FailedSessions =  $TaskSessions | where {$_.status -eq "EWarning" -or $_.Status -eq "EFailed"}
 
  if ($FailedSessions -ne $Null)
  {
    $MesssagyBody = $MesssagyBody + ($ZIPSession | Select-Object @{n="Name";e={($_.name).Substring(0, $_.name.LastIndexOf("("))}} ,@{n="Start Time";e={$_.CreationTime}},@{n="End Time";e={$_.EndTime}},Result,@{n="Details";e={$FailedSessions.Title}})
    $EmailTo=$EmailToFail
  }
   
  Else
  {
    $MesssagyBody = $MesssagyBody + ($ZIPSession | Select-Object @{n="Name";e={($_.name).Substring(0, $_.name.LastIndexOf("("))}} ,@{n="Start Time";e={$_.CreationTime}},@{n="End Time";e={$_.EndTime}},Result,@{n="Details";e={($TaskSessions | sort creationtime -Descending | select -first 1).Title}})
    $EmailTo=$EmailToOk
  }
 
  }   
}

If ($EnableNotification)
{
$Message = New-Object System.Net.Mail.MailMessage $EmailFrom, $EmailTo
$Message.Subject = $EmailSubject
$Message.IsBodyHTML = $True
$message.Body = $MesssagyBody | ConvertTo-Html -head $style | Out-String
$SMTP = New-Object Net.Mail.SmtpClient($SMTPServer)
$SMTP.Send($Message)
}

Thanks.

[Azerty]

Thank you for your reply.

[Azerty]

Hello

I tested the script but for now it does not work the way I want.
For now it works with the notification:

Code: Select all

If ($ EnableNotification)
{
$ Message = New-Object System.Net.Mail.MailMessage $ Emailfrom, $ Emailto
$ = $ Message.Subject EmailSubject
$ Message.IsBodyHTML = $ True
$ = $ Message.Body MesssagyBody | ConvertTo-Html $ -head style | Out-String
$ SMTP = New-Object Net.Mail.SmtpClient ($ SMTPServer)
$ SMTP.Send ($ message)
}

But I would rather that it works with activated from notification from the GUI Veeam. Because it allows to receive a more complete email that the email received by the notification of the script that does not give details of the failure.

Merci
Bon Week end

[PTide]

Because it allows to receive a more complete email that the email received by the notification of the script that does not give details of the failure.

Actually the notification should contain "Details" field. Do you see it?

[lirving]

Did I get it right - you are using this VeeamZIP PS script?

Yes I got the original from the article and then found an updated version in the forum

[Azerty]

Actually the notification should contain "Details" field. Do you see it?

Good evening
I'm not sure where to put this detail field.
I guess it is in notification variables, but how.
Thanks for your help.

[veremin]

what can I do to find de reason?

Have you already checked the answers provided to users with similar problem in this thread? Thanks.

[veremin]

I'm not sure where to put this detail field.

Actually, the report generated by the script should already contain a field called Details that provides information regarding root cause of the error (take a look at the original blog post to see how it's supposed to work).

You can play with $Zipsession and $MessageBody variable in order to include in an email whatever data you want to.

Thanks.

[PTide]

Yes I got the original from the article and then found an updated version in the forum

Please check whether the account specified for VBR service has read/write permissions on a share.

Thanks

[Azerty]

Re: Different email in case of backup failure

To answer Ptide
In fact, the script you gave me does not work.