Hyper-V-Backup.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 |
<#PSScriptInfo
.VERSION 21.05.30 .GUID c7fb05cc-1e20-4277-9986-523020060668 .AUTHOR Mike Galvin Contact: mike@gal.vin / twitter.com/mikegalvin_ .COMPANYNAME Mike Galvin .COPYRIGHT (C) Mike Galvin. All rights reserved. .TAGS Hyper-V Virtual Machines Full Backup Export Permissions Zip History .LICENSEURI .PROJECTURI https://gal.vin/posts/vm-backup-for-hyper-v .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES .RELEASENOTES #> <# .SYNOPSIS Hyper-V Backup Utility - Flexible backup of Hyper-V Virtual Machines. .DESCRIPTION This script will create a full backup of virtual machines, complete with configuration, snapshots/checkpoints, and VHD files. This script should be run on a Hyper-V host and the Hyper-V PowerShell management modules should be installed. To send a log file via e-mail using ssl and an SMTP password you must generate an encrypted password file. The password file is unique to both the user and machine. To create the password file run this command as the user and on the machine that will use the file: $creds = Get-Credential $creds.Password | ConvertFrom-SecureString | Set-Content c:\foo\ps-script-pwd.txt .PARAMETER BackupTo The path the virtual machines should be backed up to. Each VM will have its own folder inside this location. Do not add a trailing backslash. .PARAMETER List Enter the path to a txt file with a list of Hyper-V VM names to backup. If this option is not configured, all running VMs will be backed up. .PARAMETER Wd The path to the working directory to use for the backup before copying it to the final backup directory. Use a directory on local fast media to improve performance. .PARAMETER NoPerms Configures the utility to shut down the running VM(s) to do the file-copy based backup instead of using the Hyper-V export function. If no list is specified and multiple VMs are running, the process will run through the VMs alphabetically. .PARAMETER Keep Instructs the utility to keep a specified number of days’ worth of backups. VM backups older than the number of days specified will be deleted. Every effort has been taken to only remove backup files or folders generated by this utility. .PARAMETER Compress This option will create a zip file of each Hyper-V VM backup. Available disk space should be considered when using this option. .PARAMETER Sz Configure the utility to use 7-Zip to compress the VM backups. 7-Zip must be installed in the default location ($env:ProgramFiles) if it is not found, Windows compression will be used as a fallback. .PARAMETER SzThreads Configure 7-Zip to use more threads. -mmt1 [1 thread] -mmt8 [8 threads]. Please note this switch is passed through to 7-Zip. See 7-Zip help for more information. .PARAMETER SzComp Configure 7-Zip's compression strength. -mx1 [fast compression] -mx9 [ultra compression]. Please note this switch is passed through to 7-Zip. See 7-Zip help for more information. .PARAMETER SzType Configure which archive type 7-Zip should use. -t7z, -tzip, or -ttar. Please note this switch is passed through to 7-Zip. See 7-Zip help for more information. .PARAMETER SzSplit Configure 7-Zip to split the files into a configurable size. For example: -v100m, -v2g Please note this switch is passed through to 7-Zip. See 7-Zip help for more information. .PARAMETER ShortDate Configure the script to use only the Year, Month and Day in backup filenames. .PARAMETER NoBanner Use this option to hide the ASCII art title in the console. .PARAMETER L The path to output the log file to. The file name will be Hyper-V-Backup_YYYY-MM-dd_HH-mm-ss.log. Do not add a trailing \ backslash. .PARAMETER Subject The subject line for the e-mail log. Encapsulate with single or double quotes. If no subject is specified, the default of "Hyper-V Backup Utility Log" will be used. .PARAMETER SendTo The e-mail address the log should be sent to. .PARAMETER From The e-mail address the log should be sent from. .PARAMETER Smtp The DNS name or IP address of the SMTP server. .PARAMETER User The user account to authenticate to the SMTP server. .PARAMETER Pwd The txt file containing the encrypted password for SMTP authentication. .PARAMETER UseSsl Configures the utility to connect to the SMTP server using SSL. .EXAMPLE Hyper-V-Backup.ps1 -BackupTo \\nas\vms -List C:\scripts\vms.txt -Wd E:\temp -NoPerms -Keep 30 -Compress -Sz -SzThreads -mmt8 -SzComp -mx5 -SzType -t7z -SzSplit -v2g -L C:\scripts\logs -Subject 'Server: Hyper-V Backup' -SendTo me@contoso.com -From hyperv@contoso.com -Smtp smtp.outlook.com -User user -Pwd C:\foo\pwd.txt -UseSsl This will shutdown, one at a time, all the VMs listed in the file located in C:\scripts\vms.txt and back up their files to \\nas\vms, using E:\temp as a working directory. A .7z file for each VM folder will be created using 7-zip. 7-zip will use 8 threads, medium compression and split the files in 2GB volumes. Any backups older than 30 days will also be deleted. The log file will be output to C:\scripts\logs and sent via e-mail with a custom subject line. #> ## Set up command line switches. [CmdletBinding()] Param( [parameter(Mandatory=$True)] [alias("BackupTo")] $Backup, [alias("Keep")] $History, [alias("List")] [ValidateScript({Test-Path -Path $_ -PathType Leaf})] $VmList, [alias("Wd")] $WorkDir, [alias("SzThreads")] $SzThreadNo, [alias("SzComp")] $SzCompL, [alias("SzType")] $SzTypeF, [alias("SzSplit")] $SzSplitF, [alias("L")] [ValidateScript({Test-Path $_ -PathType 'Container'})] $LogPath, [alias("Subject")] $MailSubject, [alias("SendTo")] $MailTo, [alias("From")] $MailFrom, [alias("Smtp")] $SmtpServer, [alias("User")] $SmtpUser, [alias("Pwd")] [ValidateScript({Test-Path -Path $_ -PathType Leaf})] $SmtpPwd, [switch]$UseSsl, [switch]$NoPerms, [switch]$Compress, [switch]$Sz, [switch]$ShortDate, [switch]$NoBanner) If ($NoBanner -eq $False) { Write-Host "" Write-Host -ForegroundColor Yellow -BackgroundColor Black " _ _ __ __ ____ _ _ _ _ _ _ _ _ " Write-Host -ForegroundColor Yellow -BackgroundColor Black " | | | | \ \ / / | _ \ | | | | | | | (_) (_) | " Write-Host -ForegroundColor Yellow -BackgroundColor Black " | |__| |_ _ _ __ ___ _ _\ \ / / | |_) | __ _ ___| | ___ _ _ __ | | | | |_ _| |_| |_ _ _ " Write-Host -ForegroundColor Yellow -BackgroundColor Black " | __ | | | | '_ \ / _ \ '__\ \/ / | _ < / _ |/ __| |/ / | | | '_ \ | | | | __| | | | __| | | | " Write-Host -ForegroundColor Yellow -BackgroundColor Black " | | | | |_| | |_) | __/ | \ / | |_) | (_| | (__| <| |_| | |_) | | |__| | |_| | | | |_| |_| | " Write-Host -ForegroundColor Yellow -BackgroundColor Black " |_| |_|\__, | .__/ \___|_| \/ |____/ \__,_|\___|_|\_\\__,_| .__/ \____/ \__|_|_|_|\__|\__, | " Write-Host -ForegroundColor Yellow -BackgroundColor Black " __/ | | | | __/ | " Write-Host -ForegroundColor Yellow -BackgroundColor Black " |___/|_| Mike Galvin https://gal.vin |_| Version 21.05.30 |___/ " Write-Host -ForegroundColor Yellow -BackgroundColor Black " " Write-Host "" } ## If logging is configured, start logging. ## If the log file already exists, clear it. If ($LogPath) { $LogFile = ("Hyper-V-Backup_{0:yyyy-MM-dd_HH-mm-ss}.log" -f (Get-Date)) $Log = "$LogPath\$LogFile" $LogT = Test-Path -Path $Log If ($LogT) { Clear-Content -Path $Log } Add-Content -Path $Log -Encoding ASCII -Value "$(Get-Date -Format "yyyy-MM-dd HH:mm:ss") [INFO] Log started" } ## Function to get date in specific format. Function Get-DateFormat { Get-Date -Format "yyyy-MM-dd HH:mm:ss" } Function Get-DateShort { Get-Date -Format "yyyy-MM-dd" } Function Get-DateLong { Get-Date -Format "yyyy-MM-dd_HH-mm-ss" } ## Function for logging. Function Write-Log($Type, $Evt) { If ($Type -eq "Info") { If ($Null -ne $LogPath) { Add-Content -Path $Log -Encoding ASCII -Value "$(Get-DateFormat) [INFO] $Evt" } Write-Host "$(Get-DateFormat) [INFO] $Evt" } If ($Type -eq "Succ") { If ($Null -ne $LogPath) { Add-Content -Path $Log -Encoding ASCII -Value "$(Get-DateFormat) [SUCCESS] $Evt" } Write-Host -ForegroundColor Green "$(Get-DateFormat) [SUCCESS] $Evt" } If ($Type -eq "Err") { If ($Null -ne $LogPath) { Add-Content -Path $Log -Encoding ASCII -Value "$(Get-DateFormat) [ERROR] $Evt" } Write-Host -ForegroundColor Red -BackgroundColor Black "$(Get-DateFormat) [ERROR] $Evt" } If ($Type -eq "Conf") { If ($Null -ne $LogPath) { Add-Content -Path $Log -Encoding ASCII -Value "$Evt" } Write-Host -ForegroundColor Cyan -Object "$Evt" } } ## Function for the options post backup. Function OptionsRun { ## If the -keep switch AND the -compress switch are NOT configured. If ($Null -eq $History -And $Compress -eq $False) { Write-Log -Type Info -Evt "Removing previous backups of $Vm" ## Remove all previous backup folders, including ones from previous versions of this script. If ($ShortDate) { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*" -Directory | Remove-Item -Recurse -Force } else { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-***-*-*" -Directory | Remove-Item -Recurse -Force } ## If a working directory is configured by the user, remove all previous backup folders, including ## ones from previous versions of this script. If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupFolderT = Test-Path $Backup If ($BackupFolderT) { If ($ShortDate) { Get-ChildItem -Path $Backup -Filter "$Vm-*-*-*" -Directory | Remove-Item -Recurse -Force } else { Get-ChildItem -Path $Backup -Filter "$Vm-*-*-***-*-*" -Directory | Remove-Item -Recurse -Force } } } } ## If the -keep option IS configured AND the -compress option is NOT configured. else { If ($Compress -eq $False) { Write-Log -Type Info -Evt "Removing backup folders of $Vm older than: $History days" ## Remove previous backup folders older than the configured number of days, including ## ones from previous versions of this script. If ($ShortDate) { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*" -Directory | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Recurse -Force } else { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-***-*-*" -Directory | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Recurse -Force } ## If a working directory is configured by the user, remove previous backup folders ## older than the configured number of days remove all previous backup folders, ## including ones from previous versions of this script. If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupDirT = Test-Path $Backup If ($BackupDirT) { If ($ShortDate) { Get-ChildItem -Path $Backup -Filter "$Vm-*-*-*" -Directory | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Recurse -Force } else { Get-ChildItem -Path $Backup -Filter "$Vm-*-*-***-*-*" -Directory | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Recurse -Force } } } } } ## Check to see if the -compress switch IS configured AND if the -keep switch is NOT configured. If ($Compress) { If ($Null -eq $History) { Write-Log -Type Info -Evt "Removing previous compressed backups" ## Remove all previous compressed backups, including ones from previous versions of this script. If ($ShortDate) { If ($SzSplitF) { Remove-Item "$WorkDir\$Vm-*-*-*.*.*" -Force } else { Remove-Item "$WorkDir\$Vm-*-*-*.*" -Force } } else { If ($SzSplitF) { Remove-Item "$WorkDir\$Vm-*-*-*.*.*" -Force } else { Remove-Item "$WorkDir\$Vm-*-*-***-*-*.*" -Force } } ## If a working directory is configured by the user, remove all previous compressed backups, ## including ones from previous versions of this script. If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupFolderT = Test-Path $Backup If ($BackupFolderT) { If ($ShortDate) { If ($SzSplitF) { Remove-Item "$Backup\$Vm-*-*-*.*.*" -Force } else { Remove-Item "$Backup\$Vm-*-*-*.*" -Force } } else { If ($SzSplitF) { Remove-Item "$Backup\$Vm-*-*-***-*-*.*.*" -Force } else { Remove-Item "$Backup\$Vm-*-*-***-*-*.*" -Force } } } } } ## If the -compress switch IS configured AND if the -keep switch IS configured. else { Write-Log -Type Info -Evt "Removing compressed backups of $Vm older than: $History days" ## Remove previous compressed backups older than the configured number of days, including ## ones from previous versions of this script. If ($ShortDate) { If ($SzSplitF) { Get-ChildItem -Path "$WorkDir\$Vm-*-*-*.*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } else { Get-ChildItem -Path "$WorkDir\$Vm-*-*-*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } } else { If ($SzSplitF) { Get-ChildItem -Path "$WorkDir\$Vm-*-*-***-*-*.*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } else { Get-ChildItem -Path "$WorkDir\$Vm-*-*-***-*-*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } } ## If a working directory is configured by the user, remove previous compressed backups older ## than the configured number of days, including ones from previous versions of this script. If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupFolderT = Test-Path $Backup If ($BackupFolderT) { If ($ShortDate) { If ($SzSplitF) { Get-ChildItem -Path "$Backup\$Vm-*-*-*.*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } else{ Get-ChildItem -Path "$Backup\$Vm-*-*-*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } } else { If ($SzSplitF) { Get-ChildItem -Path "$Backup\$Vm-*-*-***-*-*.*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } else { Get-ChildItem -Path "$Backup\$Vm-*-*-***-*-*.*" | Where-Object CreationTime –lt (Get-Date).AddDays(-$History) | Remove-Item -Force } } } } } ## If the -compress switch and the -Sz switch IS configured, test for 7zip being installed. ## If it is, compress the backup folder, if it is not use Windows compression. If ($Sz -eq $True) { $7zT = Test-Path "$env:programfiles\7-Zip\7z.exe" If ($7zT -eq $True) { Write-Log -Type Info -Evt "Compressing $Vm backup using 7-Zip compression" If ($ShortDate) { $ShortDateT = Test-Path -Path ("$WorkDir\$Vm-$(Get-DateShort)") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { & "$env:programfiles\7-Zip\7z.exe" $SzThreadNo $SzCompL $SzTypeF $SzSplitF -bso0 a ("$WorkDir\$ShortDateNN") "$WorkDir\$Vm\*" } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } try { & "$env:programfiles\7-Zip\7z.exe" $SzThreadNo $SzCompL $SzTypeF $SzSplitF -bso0 a ("$WorkDir\$Vm-$(Get-DateShort)") "$WorkDir\$Vm\*" } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } else { try { & "$env:programfiles\7-Zip\7z.exe" $SzThreadNo $SzCompL $SzTypeF $SzSplitF -bso0 a ("$WorkDir\$Vm-$(Get-DateLong)") "$WorkDir\$Vm\*" } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } else { Write-Log -Type Info -Evt "Compressing $Vm backup using Windows compression" Add-Type -AssemblyName "system.io.compression.filesystem" If ($ShortDate) { $ShortDateT = Test-Path -Path ("$WorkDir\$Vm-$(Get-DateShort).zip") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { [io.compression.zipfile]::CreateFromDirectory("$WorkDir\$Vm", ("$WorkDir\$ShortDateNN")) } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } else { try { [io.compression.zipfile]::CreateFromDirectory("$WorkDir\$Vm", ("$WorkDir\$Vm-$(Get-DateLong).zip")) } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } } ## If the -compress switch IS configured and the -Sz switch is NOT configured, compress ## the backup folder using Windows compression. else { Write-Log -Type Info -Evt "Compressing $Vm backup using Windows compression" Add-Type -AssemblyName "system.io.compression.filesystem" If ($ShortDate) { $ShortDateT = Test-Path -Path ("$WorkDir\$Vm-$(Get-DateShort).zip") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { [io.compression.zipfile]::CreateFromDirectory("$WorkDir\$Vm", ("$WorkDir\$ShortDateNN")) } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } else { try { [io.compression.zipfile]::CreateFromDirectory("$WorkDir\$Vm", ("$WorkDir\$Vm-$(Get-DateShort).zip")) } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } else { try { [io.compression.zipfile]::CreateFromDirectory("$WorkDir\$Vm", ("$WorkDir\$Vm-$(Get-DateLong).zip")) } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } ## Remove the VMs export folder. Get-ChildItem -Path $WorkDir -Filter "$Vm" -Directory | Remove-Item -Recurse -Force ## If a working directory has been configured by the user, move the compressed ## backup to the backup location and rename to include the date. If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupFolderT = Test-Path $Backup If ($BackupFolderT -eq $False) { Write-Log -Type Info -Evt "Backup directory $Backup doesn't exist. Creating it." New-Item $Backup -ItemType Directory -Force | Out-Null } If ($ShortDate) { $ShortDateT = Test-Path -Path ("$Backup\$Vm-$(Get-DateShort).zip") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $Backup\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}.zip" -f $i++) $ShortDateExistT = Test-Path -Path $Backup\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*.zip" | Move-Item -Destination $Backup\$ShortDateNN } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*.zip" | Move-Item -Destination $Backup } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } else { try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*-*-*.zip" | Move-Item -Destination $Backup } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } } ## If the -compress switch is NOT configured AND if the -keep switch is configured, rename ## the export of each VM to include the date. else { If ($ShortDate) { $ShortDateT = Test-Path -Path ("$WorkDir\$Vm-$(Get-DateShort)") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $WorkDir\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { Get-ChildItem -Path $WorkDir -Filter $Vm -Directory | Rename-Item -NewName ("$WorkDir\$ShortDateNN") } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } try { Get-ChildItem -Path $WorkDir -Filter $Vm -Directory | Rename-Item -NewName ("$WorkDir\$Vm-$(Get-DateShort)") } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } else { try { Get-ChildItem -Path $WorkDir -Filter $Vm -Directory | Rename-Item -NewName ("$WorkDir\$Vm-$(Get-DateLong)") } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } If ($WorkDir -ne $Backup) { ## Make sure the backup directory exists. $BackupFolderT = Test-Path $Backup If ($BackupFolderT -eq $False) { Write-Log -Type Info -Evt "Backup directory $Backup doesn't exist. Creating it." New-Item $Backup -ItemType Directory -Force | Out-Null } If ($ShortDate) { $ShortDateT = Test-Path -Path ("$Backup\$Vm-$(Get-DateShort)") If ($ShortDateT) { Write-Log -Type Info -Evt "File $Vm-$(Get-DateShort) already exists, appending number" $i = 1 $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $Backup\$ShortDateNN If ($ShortDateExistT) { do { $ShortDateNN = ("$Vm-$(Get-DateShort)-{0:D3}" -f $i++) $ShortDateExistT = Test-Path -Path $Backup\$ShortDateNN } until ($ShortDateExistT -eq $false) } try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*" -Directory | Move-Item -Destination $Backup\$ShortDateNN -ErrorAction 'Stop' } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-*" -Directory | Move-Item -Destination ("$Backup\$Vm-$(Get-DateShort)") -ErrorAction 'Stop' } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } else { try { Get-ChildItem -Path $WorkDir -Filter "$Vm-*-*-***-*-*" -Directory | Move-Item -Destination ("$Backup\$Vm-$(Get-DateLong)") -ErrorAction 'Stop' } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } } } } ## Set a variable for computer name of the Hyper-V server. $Vs = $Env:ComputerName ## If a VM list file is configured, get the content of the file. ## If a VM list file is not configured, just get the running VMs. If ($VmList) { $Vms = Get-Content $VmList } else { $Vms = Get-VM | Where-Object {$_.State -eq 'Running'} | Select-Object -ExpandProperty Name } ## Check to see if there are any running VMs. ## If there are no VMs, then do nothing. If ($Vms.count -ne 0) { ## If the user has not configured the working directory, set it as the backup directory. If ($Null -eq $WorkDir) { $WorkDir = "$Backup" } If ($Null -eq $SzTypeF) { $SzTypeF = "-tzip" } If ($Null -eq $ShortDate) { $ShortDate = "$LongDate" } ## ## Display the current config and log if configured. ## Write-Log -Type Conf -Evt "************ Running with the following config *************." Write-Log -Type Conf -Evt "This virtual host:.......$Vs." Write-Log -Type Conf -Evt "VMs to backup:..........." ForEach ($Vm in $Vms) { Write-Log -Type Conf -Evt ".........................$Vm" } Write-Log -Type Conf -Evt "Backup directory:........$Backup." Write-Log -Type Conf -Evt "Working directory:.......$WorkDir." If ($Null -ne $History) { Write-Log -Type Conf -Evt "Backups to keep:.........$History days" } else { Write-Log -Type Conf -Evt "Backups to keep:.........No Config" } If ($Null -ne $LogPath) { Write-Log -Type Conf -Evt "Logs directory:..........$LogPath." } else { Write-Log -Type Conf -Evt "Logs directory:..........No Config" } If ($MailTo) { Write-Log -Type Conf -Evt "E-mail log to:...........$MailTo." } else { Write-Log -Type Conf -Evt "E-mail log to:...........No Config" } If ($MailFrom) { Write-Log -Type Conf -Evt "E-mail log from:.........$MailFrom." } else { Write-Log -Type Conf -Evt "E-mail log from:.........No Config" } If ($MailSubject) { Write-Log -Type Conf -Evt "E-mail subject:..........$MailSubject." } else { Write-Log -Type Conf -Evt "E-mail subject:..........Default" } If ($SmtpServer) { Write-Log -Type Conf -Evt "SMTP server:.............$SmtpServer." } else { Write-Log -Type Conf -Evt "SMTP server:.............No Config" } If ($SmtpUser) { Write-Log -Type Conf -Evt "SMTP user:...............$SmtpUser." } else { Write-Log -Type Conf -Evt "SMTP user:...............No Config" } If ($SmtpPwd) { Write-Log -Type Conf -Evt "SMTP pwd file:...........$SmtpPwd." } else { Write-Log -Type Conf -Evt "SMTP pwd file:...........No Config" } Write-Log -Type Conf -Evt "-UseSSL switch:..........$UseSsl." Write-Log -Type Conf -Evt "-NoPerms switch:.........$NoPerms." Write-Log -Type Conf -Evt "-ShortDate switch:.......$ShortDate." Write-Log -Type Conf -Evt "-Compress switch:........$Compress." Write-Log -Type Conf -Evt "-Sz switch:..............$Sz." If ($Null -eq $SzThreadNo) { Write-Log -Type Conf -Evt "7-zip threads:...........No Config." } If ($Null -eq $SzCompL) { Write-Log -Type Conf -Evt "7-zip compression:.......No Config." } Write-Log -Type Conf -Evt "7-zip archive type:......$SzTypeF." If ($Null -eq $SzSplitF) { Write-Log -Type Conf -Evt "7-zip split file size:...No Config" } Write-Log -Type Conf -Evt "************************************************************" Write-Log -Type Info -Evt "Process started." ## ## Display current config ends here. ## ## ## -NoPerms process starts here. ## ## If the -noperms switch is set, start a custom process to copy all the VM data. If ($NoPerms) { ForEach ($Vm in $Vms) { $VmInfo = Get-VM -name $Vm ## Test for the existence of a previous VM export. If it exists, delete it. $VmExportBackupT = Test-Path "$WorkDir\$Vm" If ($VmExportBackupT -eq $True) { Remove-Item "$WorkDir\$Vm" -Recurse -Force } ## Create directories for the VM export. try { New-Item "$WorkDir\$Vm" -ItemType Directory -Force | Out-Null New-Item "$WorkDir\$Vm\Virtual Machines" -ItemType Directory -Force | Out-Null New-Item "$WorkDir\$Vm\VHD" -ItemType Directory -Force | Out-Null New-Item "$WorkDir\$Vm\Snapshots" -ItemType Directory -Force | Out-Null } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } Write-Log -Type Info -Evt "Stopping VM: $Vm" Stop-VM $Vm ## ## Copy the VM config files and test for success or failure. ## try { Copy-Item "$($VmInfo.ConfigurationLocation)\Virtual Machines\$($VmInfo.id)" "$WorkDir\$Vm\Virtual Machines\" -Recurse -Force Copy-Item "$($VmInfo.ConfigurationLocation)\Virtual Machines\$($VmInfo.id).*" "$WorkDir\$Vm\Virtual Machines\" -Recurse -Force } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } ## ## End of VM config files. ## ## ## Copy the VHDs and test for success or failure. ## try { Copy-Item $VmInfo.HardDrives.Path -Destination "$WorkDir\$Vm\VHD\" -Recurse -Force } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } ## ## End of VHDs. ## ## Get the VM snapshots/checkpoints. $Snaps = Get-VMSnapshot $Vm ForEach ($Snap in $Snaps) { ## ## Copy the snapshot config files and test for success or failure. ## try { Copy-Item "$($VmInfo.ConfigurationLocation)\Snapshots\$($Snap.id)" "$WorkDir\$Vm\Snapshots\" -Recurse -Force Copy-Item "$($VmInfo.ConfigurationLocation)\Snapshots\$($Snap.id).*" "$WorkDir\$Vm\Snapshots\" -Recurse -Force } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } ## ## End of snapshot config. ## ## Copy the snapshot root VHD. try { Copy-Item $Snap.HardDrives.Path -Destination "$WorkDir\$Vm\VHD\" -Recurse -Force -ErrorAction 'Stop' } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } Start-VM $Vm Write-Log -Type Info -Evt "Starting VM: $Vm" Start-Sleep -S 60 OptionsRun } } ## ## -NoPerms process ends here. ## ## ## Standard export process starts here. ## ## If the -NoPerms switch is NOT set, for each VM check for the existence of a previous export. ## If it exists then delete it, otherwise the export will fail. else { ForEach ($Vm in $Vms) { $VmExportBackupT = Test-Path "$WorkDir\$Vm" If ($VmExportBackupT -eq $True) { Remove-Item "$WorkDir\$Vm" -Recurse -Force } If ($WorkDir -ne $Backup) { $VmExportWDT = Test-Path "$Backup\$Vm" If ($VmExportWDT -eq $True) { Remove-Item "$Backup\$Vm" -Recurse -Force } } } ## Do a regular export of the VMs. ForEach ($Vm in $Vms) { Write-Log -Type Info -Evt "Attempting to export $Vm" try { $Vm | Export-VM -Path "$WorkDir" -ErrorAction 'Stop' } catch{ $_.Exception.Message | Write-Log -Type Err -Evt $_ } } ## Run the configuration options on the above backup files and folders. ForEach ($Vm in $Vms) { OptionsRun } } } ## If there are no VMs running, then do nothing. else { Write-Log -Type Info -Evt "There are no VMs running to backup" } Write-Log -Type Info -Evt "Process finished." ## If logging is configured then finish the log file. If ($LogPath) { Add-Content -Path $Log -Encoding ASCII -Value "$(Get-Date -Format "yyyy-MM-dd HH:mm:ss") [INFO] Log finished" ## This whole block is for e-mail, if it is configured. If ($SmtpServer) { ## Default e-mail subject if none is configured. If ($Null -eq $MailSubject) { $MailSubject = "Hyper-V Backup Utility Log" } ## Setting the contents of the log to be the e-mail body. $MailBody = Get-Content -Path $Log | Out-String ## If an smtp password is configured, get the username and password together for authentication. ## If an smtp password is not provided then send the e-mail without authentication and obviously no SSL. If ($SmtpPwd) { $SmtpPwdEncrypt = Get-Content $SmtpPwd | ConvertTo-SecureString $SmtpCreds = New-Object System.Management.Automation.PSCredential -ArgumentList ($SmtpUser, $SmtpPwdEncrypt) ## If -ssl switch is used, send the email with SSL. ## If it isn't then don't use SSL, but still authenticate with the credentials. If ($UseSsl) { Send-MailMessage -To $MailTo -From $MailFrom -Subject $MailSubject -Body $MailBody -SmtpServer $SmtpServer -UseSsl -Credential $SmtpCreds } else { Send-MailMessage -To $MailTo -From $MailFrom -Subject $MailSubject -Body $MailBody -SmtpServer $SmtpServer -Credential $SmtpCreds } } else { Send-MailMessage -To $MailTo -From $MailFrom -Subject $MailSubject -Body $MailBody -SmtpServer $SmtpServer } } } ## End |