Skip to content

Commit

Permalink
Merge pull request #127 from AsBuiltReport/dev
Browse files Browse the repository at this point in the history 
v0.8.3 public release
  • Loading branch information
@rebelinux
rebelinux authored Dec 30, 2023
2 parents 5cc2e0e + 94a5605 commit 2c3f30b
Show file tree
Hide file tree
Showing 45 changed files with 2,702 additions and 9,680 deletions.
8 changes: 6 additions & 2 deletions AsBuiltReport.Veeam.VBR.psd1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = 'AsBuiltReport.Veeam.VBR.psm1'

# Version number of this module.
ModuleVersion = '0.8.2'
ModuleVersion = '0.8.3'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand All @@ -27,7 +27,7 @@ Author = 'Jonathan Colon'
#CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2023 Jonathan Colon. All rights reserved.'
Copyright = '(c) 2024 Jonathan Colon. All rights reserved.'

# Description of the functionality provided by this module
Description = 'A PowerShell module to generate an as built report on the configuration of Veeam VBR.'
Expand Down Expand Up @@ -61,6 +61,10 @@ RequiredModules = @(
ModuleName = 'PScriboCharts';
ModuleVersion = '0.9.0'
}
@{
ModuleName = 'Veeam.Diagrammer';
ModuleVersion = '0.5.4'
}
)

# Assemblies that must be loaded prior to importing this module
Expand Down
3 changes: 2 additions & 1 deletion AsBuiltreport.Veeam.VBR.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"BackupServerPort": 9392,
"PSDefaultAuthentication": "Default",
"EnableCharts": false,
"EnableHardwareInventory": false
"EnableHardwareInventory": false,
"EnableDiagrams": false
},
"InfoLevel": {
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
Expand Down
28 changes: 27 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,37 @@
# :arrows_clockwise: Veeam VBR As Built Report Changelog

## [0.8.3] - 2023-12-29

### Added

- Initial diagramming support
- v12.1 support:
- File Backup Advanced Setting (ACL Handling) collection
- Object Storage Backup Jobs
- Object Storage data source (Unstructured Data) collection
- Global Exclusions information
- Malware Detection information
- SureBackup Job content analisys (Malware Detection)
- Event Forwarding (Syslog)
- Linux host authentication setting

### Fixed

- Close [#114](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/114)
- Close [#115](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/115)
- Close [#116](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/116)
- Close [#117](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/117)
- Close [#118](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/118)
- Close [#119](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/119)
- Close [#120](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/120)
- Fix [#121](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/121) @carceneaux

## [0.8.2] - 2023-10-12

### Fixed

- Fixed misspelled module name in file /Src/Public/Invoke-AsBuiltReport.Veeam.VBR.ps1. Fix #110

## [0.8.1] - 2023-10-03

### Removed
Expand Down
105 changes: 55 additions & 50 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Below are the instructions on how to install, configure and generate a Veeam VBR
<!-- ********** Update supported Veeam versions ********** -->
The Veeam VBR As Built Report supports the following Veeam Backup & Replication version;

- Veeam Backup & Replication V11 (Standard, Enterprise & Enterprise Plus Edition)
- Veeam Backup & Replication V12 (Standard, Enterprise & Enterprise Plus Edition)
- Veeam Backup & Replication v11 (Standard, Enterprise & Enterprise Plus Edition)
- Veeam Backup & Replication v12+ (Standard, Enterprise & Enterprise Plus Edition)

:exclamation:Community Edition is not supported:exclamation:

Expand All @@ -60,9 +60,9 @@ The Veeam VBR As Built Report supports the following Veeam Backup & Replication
This report is compatible with the following PowerShell versions;

<!-- ********** Update supported PowerShell versions ********** -->
| Windows PowerShell 5.1 | PowerShell 7 |
| Windows PowerShell 5.1 | PowerShell 7 |
|:----------------------:|:--------------------:|
| :white_check_mark: | :x: |
| :white_check_mark: | :x: |

## :wrench: System Requirements

Expand All @@ -71,6 +71,7 @@ PowerShell 5.1 and the following PowerShell modules are required for generating
- [Veeam.Backup.PowerShell Module](https://helpcenter.veeam.com/docs/backup/powershell/getting_started.html?ver=110)
- [PScriboCharts Module](https://github.com/iainbrighton/PScriboCharts)
- [AsBuiltReport.Core Module](https://github.com/AsBuiltReport/AsBuiltReport.Core)
- [Veeam.Diagrammer Module](https://github.com/rebelinux/Veeam.Diagrammer)

### :closed_lock_with_key: Required Privileges

Expand Down Expand Up @@ -135,95 +136,98 @@ The **Report** schema provides configuration of the Veeam VBR report information

The **Options** schema allows certain options within the report to be toggled on or off.

| Sub-Schema | Setting | Default | Description |
|-----------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| BackupServerPort | TCP Port | 9392 | Used to specify the backup service's custom port.
| PSDefaultAuthentication | Negotiate/Kerberos | Default | Allow to set the value of the PSRemoting authentication method. For Workgroup authentication Negotiate value is required.
| EnableCharts | true/false | false | Used to manipulate the creation of charts.
| EnableHardwareInventory | true/false | false | Enable the extraction of Hardware information from the Backup Server/Proxy servers (Windows OS only).
| Sub-Schema | Setting | Default | Description |
|-------------------------|--------------------|--------------------------------|----------------------------------------------------|
| BackupServerPort | TCP Port | 9392 | Set the backup server service's custom port. |
| PSDefaultAuthentication | Negotiate/Kerberos | Default | Set the PSRemoting authentication method |
| EnableCharts | true/false | false | Toggle to enable/disable creation of charts. |
| EnableHardwareInventory | true / false | false | Toggle to enable/disable of Hardware information |
| EnableDiagrams | true / false | false | Toggle to enable/disable of Infrastructure Diagrams|

###### * Note: In order to generate the infrastructure diagram, the Veeam.Diagrammer module requires the following windows application [Graphviz](https://graphviz.org/download/#windows) >= v9.0

### InfoLevel

The **InfoLevel** schema allows configuration of each section of the report at a granular level. The following sections can be set.

There are 4 levels (0-3) of detail granularity for each section as follows;

| Setting | InfoLevel | Description |
|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| 0 | Disabled | Does not collect or display any information |
| 1 | Enabled | Provides summarised information for a collection of objects |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
| 3 | Detailed | Provides detailed information for individual objects |
| Setting | InfoLevel | Description |
|:-------:|-------------------|-------------------------------------------------------------------------------------------------------|
| 0 | Disabled | Does not collect or display any information |
| 1 | Enabled | Provides summarised information for a collection of objects |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
| 3 | Detailed | Provides detailed information for individual objects |

The table below outlines the default and maximum **InfoLevel** settings for each Backup Infrastructure section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| BackupServer | 1 | 3 |
| Sub-Schema | Default Setting | Maximum Setting |
|----------------|:---------------:|:---------------:|
| BackupServe | 1 | 3 |
| Proxy | 1 | 3 |
| Settings | 1 | 2 |
| BR | 1 | 2 |
| Licenses | 1 | 1 |
| Settings | 1 | 2 |
| BR | 1 | 2 |
| Licenses | 1 | 1 |
| SOBR | 1 | 2 |
| WANAccel | 1 | 1 |
| ServiceProvider | 1 | 2 |
| SureBackup | 1 | 2 |
| WANAccel | 1 | 1 |
| ServiceProvider| 1 | 2 |
| SureBackup | 1 | 2 |

The table below outlines the default and maximum **InfoLevel** settings for each Tape Infrastructure section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| Server | 1 | 1 |
| Library | 1 | 2 |
| MediaPool | 1 | 2 |
| Vault | 1 | 1 |
| NDMP | 1 | 1 |
| Library | 1 | 2 |
| MediaPool | 1 | 2 |
| Vault | 1 | 1 |
| NDMP | 1 | 1 |

The table below outlines the default and maximum **InfoLevel** settings for each Inventory section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| VI | 1 | 1 |
| VI | 1 | 1 |
| PHY | 1 | 2 |
| FileShare | 1 | 1 |
| FileShare | 1 | 1 |

The table below outlines the default and maximum **InfoLevel** settings for each Storage Infrastructure section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| ONTAP | 1 | 2 |
| ISILON | 1 | 2 |
| ONTAP | 1 | 2 |
| ISILON | 1 | 2 |

The table below outlines the default and maximum **InfoLevel** settings for each Backup Jobs section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| Backup | 1 | 2 |
| BackupCopy | 1 | 2 |
| Tape | 1 | 2 |
| Surebackup | 1 | 2 |
| Agent | 1 | 2 |
| FileShare | 1 | 2 |
| Replication | 1 | 2 |
| BackupCopy | 1 | 2 |
| Tape | 1 | 2 |
| Surebackup | 1 | 2 |
| Agent | 1 | 2 |
| FileShare | 1 | 2 |
| Replication | 1 | 2 |

The table below outlines the default and maximum **InfoLevel** settings for each Replication section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| Replica | 1 | 2 |
| FailoverPlan | 1 | 1 |
| Replica | 1 | 2 |
| FailoverPlan | 1 | 1 |

The table below outlines the default and maximum **InfoLevel** settings for each Cloud Connect section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| Certificate | 1 | 1 |
| PublicIP | 1 | 1 |
| CloudGateway | 1 | 2 |
| GatewayPools | 1 | 1 |
| Tenants | 1 | 2 |
| BackupStorage | 1 | 1 |
| ReplicaResources | 1 | 2 |
| Sub-Schema | Default Setting | Maximum Setting |
|-----------------|:---------------:|:---------------:|
| Certificate | 1 | 1 |
| PublicIP | 1 | 1 |
| CloudGateway | 1 | 2 |
| GatewayPools | 1 | 1 |
| Tenants | 1 | 2 |
| BackupStorage | 1 | 1 |
| ReplicaResources| 1 | 2 |

### Healthcheck

Expand Down Expand Up @@ -253,3 +257,4 @@ PS C:\> New-AsBuiltReport -Report Veeam.VBR -Target veeam-vbr.pharmax.local -Use

- Since many of Veeam's features depend on the Standard+ license, the Community edition is not supported.
- If the Veeam Backup Server is not joined to an Active Directory domain (WorkGroup Auth), the PSDefaultAuthentication option must be set to Negotiate. If it is not, some of the report sections will be missing.
- In order to generate the infrastructure diagram it is required to install [Graphviz](https://graphviz.org/download/) on the machine where the report is generated.
Binary file removed Samples/Sample Veeam Backup & Replication As Built Report.docx
View file
Binary file not shown.
3,957 changes: 1,687 additions & 2,270 deletions Samples/Sample Veeam Backup & Replication As Built Report.html
View file

Large diffs are not rendered by default.

Binary file modified Samples/Sample Veeam Backup & Replication As Built Report.pdf
View file
Binary file not shown.
Loading

0 comments on commit 2c3f30b

Please sign in to comment.