Differences

This shows you the differences between two versions of the page.

--- backupmanagement [2024/12/30 23:44] – Darren
+++ backupmanagement [2024/12/30 23:47] (current) – old revision restored (2024/12/25 10:57) Darren
@@ Line 1: / Line 1: @@
-====== VM Backup and Snapshot Retention Script ======
+====== User Guide for VM Backup and Snapshot Retention Script ======
-=== Purpose ===\\
+=== Overview ===
-This PowerShell script automates the process of:\\
+This script automates the process of backing up virtual machines (VMs) and managing snapshot retention. It reads configurations from an external INI file, allowing for customizable settings without modifying the script directly. The script uses PowerShell cmdlets and RoboCopy for backup operations and manages snapshots for virtual machines.
-* Backing up Hyper-V virtual machines (VMs).\\
-* Retaining snapshots for a configurable period.\\
-* Logging the entire process for audit and troubleshooting purposes.\\
-* Sending email notifications upon success or failure.\\
-* Providing a Windows-like progress box for user feedback.
-=== Features ===\\
+==== Features ====
-* **INI-Based Configuration**: All settings, including email and paths, are configured via an easy-to-edit `.ini` file.\\
+  * Automated VM snapshot creation.
-* **Snapshot Retention**: Removes old snapshots based on the retention period defined in the `.ini` file.\\
+  * Retention management for old snapshots.
-* **Automated Backup**: Uses `RoboCopy` to back up VM files to a remote or local destination.\\
+  * Configurable backup paths and options.
-* **Email Notifications**: Notifies the user of the script's success or failure.\\
+  * Dynamic inclusion of VMs via the INI file.
-* **Progress Box**: Displays a Windows-like GUI progress bar during the backup process.
+  * Detailed logging of operations.
+  * Fully customizable through an easy-to-use configuration file.
 ----
-=== Prerequisites ===\\
+=== Prerequisites ===
-- **PowerShell Version**: Ensure PowerShell 5.1 or later is installed.\\
+  - **System Requirements:**
-- **Hyper-V Module**: The script uses `Checkpoint-VM`, `Get-VMSnapshot`, and `Remove-VMSnapshot`. The Hyper-V PowerShell module must be installed.\\
+    * Windows Server or Windows 10/11 with Hyper-V installed.
-- **INI File Configuration**: The script relies on an `.ini` file for settings.\\
+    * PowerShell 5.0 or later.
-- **Windows Forms Assembly**: The script uses `System.Windows.Forms` for the progress box. This is included by default on Windows.
+  - **Required Permissions:**
+    * Administrative privileges to manage VMs and access file paths.
+  - **Dependencies:**
+    * ''RoboCopy'' (built into Windows).
+  - **Configuration File:**
+    * A properly formatted INI file must be created and configured.
 ----
-=== Configuration ===
+=== Configurable Options ===
+All configurations are stored in the ''options.ini'' file.
-== INI File ==\\
+==== Example INI File ====
-The script uses an `.ini` file located at:\\
+<code ini>
-* **`C:\Program Files\SyncVM\options.ini`**
+[Settings]
+RetentionDays = 7
+LocalPath = C:\VMBackups
+RemotePath = \\BackupServer\VMs
+LogPath = C:\VMLogs
+RoboOpts = /MIR /e /FFT /Z /XA:H /W:5 /compress
-Below is an example `.ini` file with all available settings:
+[VMs]
+VM1 = MyVirtualMachine1
+VM2 = MyVirtualMachine2
+VM3 = MyVirtualMachine3
+</code>
+==== Sections and Parameters ====
+  - **[Settings]**
+    - **RetentionDays**: Number of days to retain snapshots before deletion. Older snapshots will be automatically removed.
+      - **Default:** ''7''
+      - **Example:** ''RetentionDays = 14''
+    - **LocalPath**: Local directory where the VM files are stored.
+      - **Example:** ''LocalPath = C:\VMBackups''
+    - **RemotePath**: Remote destination directory for backups. Use UNC paths for network locations.
+      - **Example:** ''RemotePath = \\BackupServer\VMs''
+    - **LogPath**: Directory where log files will be saved.
+      - **Example:** ''LogPath = C:\VMLogs''
+    - **RoboOpts**: Customizable options for RoboCopy. These should be formatted as a single string of space-separated options.
+      - **Default:** ''/MIR /e /FFT /Z /XA:H /W:5 /compress''
+      - **Example:** ''RoboOpts = /S /ZB /R:3''
+  - **[VMs]**
+    - List of VMs to be backed up. Each entry should be in the format ''VMx = VMName'', where ''x'' is a unique identifier and ''VMName'' is the name of the virtual machine.
+      - **Example:**
+<code ini>
+[VMs]
+VM1 = MyVirtualMachine1
+VM2 = MyVirtualMachine2
+VM3 = MyVirtualMachine3
+</code>
+----
+=== Script Functionality ===
+==== Key Components ====
+  - **Snapshot Management**
+    - The script creates a snapshot for each VM listed in the INI file.
+    - Old snapshots are removed based on the retention period defined in the ''RetentionDays'' parameter.
+  - **Backup Process**
+    - The script uses RoboCopy to transfer VM files from the ''LocalPath'' to the ''RemotePath''.
+    - Configurable options for RoboCopy allow fine-tuning of backup behavior.
+  - **Logging**
+    - All operations are logged in a file created in the directory specified by ''LogPath''.
+    - Log entries include timestamps and descriptions of actions performed.
+----
+=== How to Use ===
+==== Step 1: Configure the INI File ====
+. Open the ''options.ini'' file in a text editor.
+. Modify the parameters in the ''[Settings]'' and ''[VMs]'' sections as needed.
+. Save the file.
+==== Step 2: Run the Script ====
+. Open a PowerShell window with administrative privileges.
+. Navigate to the directory containing the script.
+. Execute the script:
+<code powershell>
+.\BackupScript.ps1
+</code>
+. The script will automatically read the ''options.ini'' file, process VMs, and log the operations.
+==== Step 3: Review Logs ====
+  * Check the log files in the directory specified by ''LogPath'' for details of the backup process.
+----
+=== Troubleshooting ===
+==== Common Errors and Solutions ====
+  - **Error:** "Invalid Parameter #3"
+    - **Cause:** RoboCopy options are not split correctly.
+    - **Solution:** Ensure ''RoboOpts'' in the INI file is a valid string of space-separated options.
+  - **Error:** "Access Denied"
+    - **Cause:** Insufficient permissions to access VM files or remote path.
+    - **Solution:** Run PowerShell as an administrator and verify permissions for the specified directories.
+  - **Error:** "VM not found"
+    - **Cause:** VM name in the INI file does not match an existing VM.
+    - **Solution:** Verify the VM names in the ''[VMs]'' section of the INI file.
+----
+=== Advanced Usage ===
+==== Customizing RoboCopy Options ====
+  - The ''RoboOpts'' parameter allows you to customize the behavior of RoboCopy.
+  - Example Options:
+    - ''/MIR'': Mirrors the directory structure.
+    - ''/Z'': Enables restartable mode for interrupted transfers.
+    - ''/XA:H'': Excludes hidden files.
+    - ''/R:N'': Specifies the number of retry attempts.
+==== Adding or Removing VMs ====
+  - **To add a VM:**
+. Add a new entry in the ''[VMs]'' section of the INI file.
+       - Example: ''VM4 = MyVirtualMachine4''
+. Save the INI file.
+  - **To remove a VM:**
+. Delete the corresponding entry in the ''[VMs]'' section.
+. Save the INI file.
+----
+=== Maintenance and Updates ===
+  - **Log Management:** Periodically clean up old logs in the ''LogPath'' directory to save space.
+  - **INI File Updates:** Review and update the INI file as necessary to reflect changes in the VM environment.
+  - **Script Updates:** Check for script updates to ensure compatibility with the latest systems and features.
+----
-```ini\\
+=== Contact and Support ===
-[Settings]\\
+For questions or issues, please contact the script author or system administrator.
-RetentionDays = 7                    ; Number of days to retain snapshots\\
-LocalPath = C:\HyperV\VMs            ; Local directory where VM files are stored\\
-RemotePath = \\BackupServer\Backups  ; Remote directory for storing backups\\
-LogPath = C:\HyperV\Logs             ; Path to save log files\\
-RoboOpts = /MIR /E /FFT /Z /XA:H /W:5 /compress ; Options for RoboCopy
-[VMs]\\
-VM1 = TestVM1\\
-VM2 = TestVM2\\
-VM3 = TestVM3
-[Email]\\
-To = admin@example.com               ; Email address to send notifications to\\
-From = backup@example.com            ; Email address to send notifications from\\
-SMTPServer = smtp.example.com        ; SMTP server for sending email\\
-SMTPPort = 587                       ; SMTP port (e.g., 587 for TLS, 25 for standard)\\
-SMTPUsername = username@example.com  ; Username for SMTP authentication\\
-SMTPPassword = yourpassword          ; Password for SMTP authentication\\
-SubjectPrefix = [VM Backup]          ; Prefix for email subject lines