Skip to content

Commit

Permalink
Merge pull request #147 from rebelinux/dev
Browse files Browse the repository at this point in the history 
v0.8.5 enhancement
  • Loading branch information
@rebelinux
rebelinux authored Mar 15, 2024
2 parents 878aa32 + d510add commit ae9cfef
Show file tree
Hide file tree
Showing 48 changed files with 1,314 additions and 665 deletions.
43 changes: 22 additions & 21 deletions AsBuiltreport.Veeam.VBR.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,63 +10,64 @@
},
"Options": {
"BackupServerPort": 9392,
"PSDefaultAuthentication": "Default",
"EnableCharts": false,
"EnableHardwareInventory": false,
"EnableDiagrams": false
"EnableDiagrams": false,
"PSDefaultAuthentication": "Default"
},
"InfoLevel": {
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed",
"Infrastructure": {
"BackupServer": 1,
"Proxy": 1,
"Settings": 1,
"BR": 1,
"Licenses": 1,
"Proxy": 1,
"Settings": 1,
"SOBR": 1,
"WANAccel": 1,
"ServiceProvider": 1,
"SureBackup": 1
"SureBackup": 1,
"WANAccel": 1

},
"Tape": {
"Server": 1,
"Library": 1,
"MediaPool": 1,
"Vault": 1,
"NDMP": 1
"NDMP": 1,
"Server": 1,
"Vault": 1
},
"Inventory": {
"VI": 1,
"FileShare": 1,
"PHY": 1,
"FileShare": 1
"VI": 1
},
"Storage": {
"ONTAP": 1,
"ISILON": 1
"ISILON": 1,
"ONTAP": 1
},
"Replication": {
"FailoverPlan": 1,
"Replica": 1
},
"CloudConnect": {
"BackupStorage": 1,
"Certificate": 1,
"PublicIP": 1,
"CloudGateway": 1,
"GatewayPools": 1,
"Tenants": 1,
"BackupStorage": 1,
"ReplicaResources": 1
"PublicIP": 1,
"ReplicaResources": 1,
"Tenants": 1
},
"Jobs": {
"Agent": 1,
"Backup": 1,
"BackupCopy": 1,
"Tape": 1,
"Surebackup": 1,
"Agent": 1,
"FileShare": 1,
"Replication": 1
"Surebackup": 1,
"Replication": 1,
"Restores": 1,
"Tape": 1
}
},
"HealthCheck": {
Expand Down
9 changes: 8 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.8.5] - 2024-01-30
## [0.8.5] - 2024-03-15

### Added

Expand All @@ -15,16 +15,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Added Auto logoff on inactivity setting
- Added Four-eye Authorization setting
- Added HealthCheck conditions
- Added Backup Time Duration table to the Jobs Summary. Close [#144](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/144)
- Added Restore point reporting. Close [#143](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/143)
- Added Automatically disable Windows Firewall option to the SureBackup verification section

### Changed

- Removed Graphviz install check code. (No need to manually install Graphviz)
- Code Cleanup
- Increased Veeam.Diagrammer module requirement to v0.5.9

### Fixed

- Improved error handling on the Diagram section.
- Fixed issue with the Veeam.Diagrammer module.
- Resolved issue that prevented SureBackup Virtual Lab information to be collected. Fix [#142](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/142)
- Resolved issue in the Malware Global Exclusions section. Fix [#145](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/145)
- Resolved an issue related to Protection Group licensing. Fix [#146](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/146)

## [0.8.4] - 2024-01-16

Expand Down
143 changes: 72 additions & 71 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The Veeam VBR As Built Report supports the following Veeam Backup & Replication

## :no_entry_sign: Unsupported Versions

The versions 10 and 11 are no longer supported by Veeam. So I will not be performing compatibility tests with those versions. The report may work on previous versions but I do not guarantee and will not address issues related to pre-v12.
The versions 10 and 11 are no longer supported by Veeam. So I will not be performing compatibility tests with those versions. The report may work on previous versions but I do not guarantee and will not address issues related to pre-v12.

[Veeam Product Lifecycle Policy](https://www.veeam.com/product-lifecycle.html)

Expand All @@ -65,9 +65,9 @@ The versions 10 and 11 are no longer supported by Veeam. So I will not be perfor
This report is compatible with the following PowerShell versions;

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

## :wrench: System Requirements

Expand Down Expand Up @@ -127,27 +127,27 @@ The following provides information of how to configure each schema within the re

The **Report** schema provides configuration of the Veeam VBR report information.

| Sub-Schema | Setting | Default | Description |
|---------------------|--------------|--------------------------------|--------------------------------------------------------------|
| Sub-Schema | Setting | Default | Description |
| ------------------- | ------------ | ------------------------- | ------------------------------------------------------------ |
| Name | User defined | Veeam VBR As Built Report | The name of the As Built Report |
| Version | User defined | 1.0 | The report version |
| Status | User defined | Released | The report release status |
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
| Version | User defined | 1.0 | The report version |
| Status | User defined | Released | The report release status |
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |

### Options

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

| 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|
| 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

Expand All @@ -157,82 +157,83 @@ The **InfoLevel** schema allows configuration of each section of the report at a

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 |
|----------------|:---------------:|:---------------:|
| BackupServe | 1 | 3 |
| Proxy | 1 | 3 |
| Settings | 1 | 2 |
| BR | 1 | 2 |
| Licenses | 1 | 1 |
| SOBR | 1 | 2 |
| WANAccel | 1 | 1 |
| ServiceProvider| 1 | 2 |
| SureBackup | 1 | 2 |
| Sub-Schema | Default Setting | Maximum Setting |
| --------------- | :-------------: | :-------------: |
| BackupServe | 1 | 3 |
| Proxy | 1 | 3 |
| Settings | 1 | 2 |
| BR | 1 | 2 |
| Licenses | 1 | 1 |
| SOBR | 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 |
| Sub-Schema | Default Setting | Maximum Setting |
| ---------- | :-------------: | :-------------: |
| Server | 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 |
| PHY | 1 | 2 |
| FileShare | 1 | 1 |
| Sub-Schema | Default Setting | Maximum Setting |
| ---------- | :-------------: | :-------------: |
| VI | 1 | 1 |
| PHY | 1 | 2 |
| 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 |
| Sub-Schema | Default Setting | Maximum Setting |
| ---------- | :-------------: | :-------------: |
| 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 |
| 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 |
| Restores | 1 | 1 |

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 |

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
3 changes: 3 additions & 0 deletions Src/Private/Get-AbrVbrAgentBackupjobConf.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ function Get-AbrVbrAgentBackupjobConf {
Text "Best Practice:" -Bold
Text "It is a general rule of good practice to establish well-defined descriptions. This helps to speed up the fault identification process, as well as enabling better documentation of the environment."
}
BlankLine
}
}
} catch {
Expand Down Expand Up @@ -481,6 +482,7 @@ function Get-AbrVbrAgentBackupjobConf {
Text "Best Practice:" -Bold
Text "It is recommended to use storage-level corruption guard for any backup job with no active full backups scheduled. Synthetic full backups are still 'incremental forever' and may suffer from corruption over time. Storage-level corruption guard was introduced to provide a greater level of confidence in integrity of the backups."
}
BlankLine
}
}
} catch {
Expand Down Expand Up @@ -526,6 +528,7 @@ function Get-AbrVbrAgentBackupjobConf {
Text "Best Practice:" -Bold
Text "Backup and replica data is a high potential source of vulnerability. To secure data stored in backups and replicas, use Veeam Backup & Replication inbuilt encryption to protect data in backups"
}
BlankLine
}
}
}
Expand Down
Loading

0 comments on commit ae9cfef

Please sign in to comment.