Skip to content

Commit 3fef6b2

Browse files
authored
Merge pull request #51 from AsBuiltReport/dev
v0.3.9 public release
2 parents fb5ab83 + 69a6349 commit 3fef6b2

12 files changed

+302
-237
lines changed

.github/workflows/Release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
needs: publish-to-gallery
5454
runs-on: ubuntu-latest
5555
steps:
56-
- uses: zentered/bluesky-post-action@v0.1.0
56+
- uses: zentered/bluesky-post-action@v0.2.0
5757
with:
5858
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Veeam #AsBuiltReport #PowerShell #VeeamVanguard #VeeamLegend"
5959
env:

AsBuiltReport.Veeam.VB365.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
"ExportDiagramsFormat": ["png"],
2020
"EnableDiagramSignature": false,
2121
"SignatureAuthorName": "",
22-
"SignatureCompanyName": ""
22+
"SignatureCompanyName": "",
23+
"RoundUnits": 1
2324
},
2425
"InfoLevel": {
2526
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",

AsBuiltReport.Veeam.VB365.psd1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'AsBuiltReport.Veeam.VB365.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.3.8'
15+
ModuleVersion = '0.3.9'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -27,7 +27,7 @@
2727
# CompanyName = 'Unknown'
2828

2929
# Copyright statement for this module
30-
Copyright = '(c) 2024 Jonathan Colon. All rights reserved.'
30+
Copyright = '(c) 2025 Jonathan Colon. All rights reserved.'
3131

3232
# Description of the functionality provided by this module
3333
Description = 'A PowerShell module to generate an as built report on the configuration of Veeam Backup for Microsoft 365.'
@@ -55,15 +55,15 @@
5555
RequiredModules = @(
5656
@{
5757
ModuleName = 'AsBuiltReport.Core';
58-
ModuleVersion = '1.4.0'
58+
ModuleVersion = '1.4.2.1'
5959
},
6060
@{
6161
ModuleName = 'PScriboCharts';
6262
ModuleVersion = '0.9.0'
6363
},
6464
@{
6565
ModuleName = 'Diagrammer.Core';
66-
ModuleVersion = '0.2.12'
66+
ModuleVersion = '0.2.19'
6767
}
6868
)
6969

CHANGELOG.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
##### This project is community maintained and has no sponsorship from Veeam, its employees or any of its affiliates.
99

10+
## [0.3.9] - 2025-03-04
11+
12+
### Added
13+
14+
- Improve disk space information
15+
- Improve RESTful API section details
16+
17+
### Changed
18+
19+
- Update GitHub release workflow for Bluesky integration
20+
- Update sample report and diagram files
21+
- Increase dependencies to latest versions
22+
23+
### Fixed
24+
25+
- Resolve issue with diagram watermark text generation
26+
1027
## [0.3.8] - 2024-11-12
1128

1229
### Added
@@ -24,7 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2441
## [0.3.7] - 2024-10-12
2542

2643
### Changed
27-
44+
Increase Diagrammer.Core to v0.2.12
2845
- Improve infrastructure diagram
2946
- Increase Diagrammer.Core to v0.2.9
3047
- Update Sample Diagram

README.md

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- ********** DO NOT EDIT THESE LINKS ********** -->
22
<p align="center">
33
<a href="https://www.asbuiltreport.com/" alt="AsBuiltReport"></a>
4-
<img src='https://avatars.githubusercontent.com/u/42958564' width="8%" height="8%" /></a>
4+
<img src='https://avatars.githubusercontent.com/u/42958564' width="8%" height="8%" /></a>
55
</p>
66
<p align="center">
77
<a href="https://www.powershellgallery.com/packages/AsBuiltReport.Veeam.VB365/" alt="PowerShell Gallery Version">
@@ -21,15 +21,20 @@
2121
</p>
2222
<p align="center">
2323
<a href="https://twitter.com/AsBuiltReport" alt="Twitter">
24-
<img src="https://img.shields.io/twitter/follow/AsBuiltReport.svg?style=social"/></a>
24+
<img src="https://img.shields.io/twitter/follow/AsBuiltReport.svg?style=social"/></a>
2525
</p>
2626
<!-- ********** DO NOT EDIT THESE LINKS ********** -->
2727

28+
> [!WARNING]
29+
> I recently decided not to apply to the Veeam Vanguard program, which was one of the main reasons for developing and maintaining this project. Therefore, I will not be maintaining or updating this report. Until someone is identified to maintain the project, this report will be frozen in terms of new capabilities.
30+
31+
#### This project is community maintained and has no sponsorship from Veeam, its employees, or any of its affiliates.
32+
2833
# Veeam VB365 As Built Report
2934

30-
Veeam VB365 As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core).
35+
Veeam VB365 As Built Report is a PowerShell module that works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core).
3136

32-
[AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
37+
[AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-source community project that utilizes PowerShell to produce as-built documentation in multiple document formats for various vendors and technologies.
3338

3439
Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for more detailed information about this project.
3540

@@ -46,24 +51,26 @@ Sample Veeam VB365 As Built report diagram file: [Sample Veeam VB365 As Built Re
4651
![Sample Diagram](Samples/AsBuiltReport.Veeam.VB365.png)
4752

4853
# :beginner: Getting Started
49-
Below are the instructions on how to install, configure and generate a Veeam VB365 As Built report.
54+
55+
Below are the instructions on how to install, configure, and generate a Veeam VB365 As Built report.
5056

5157
## :floppy_disk: Supported Versions
52-
<!-- ********** Update supported VB365 versions ********** -->
53-
The Veeam VB365 As Built Report supports the following Veeam Backup for Microsoft 365 version;
58+
59+
The Veeam VB365 As Built Report supports the following Veeam Backup for Microsoft 365 version:
5460

5561
- Veeam Backup for Microsoft 365 v6+
5662

5763
### PowerShell
58-
This report is compatible with the following PowerShell versions;
5964

60-
<!-- ********** Update supported PowerShell versions ********** -->
65+
This report is compatible with the following PowerShell versions:
66+
6167
| Windows PowerShell 5.1 | PowerShell 7 |
6268
| :--------------------: | :----------: |
6369
| :white_check_mark: | :x: |
70+
6471
## :wrench: System Requirements
65-
<!-- ********** Update system requirements ********** -->
66-
PowerShell 5.1, and the following PowerShell modules are required for generating a Veeam VB365 As Built Report.
72+
73+
PowerShell 5.1 and the following PowerShell modules are required for generating a Veeam VB365 As Built Report:
6774

6875
- [Veeam.Archiver.PowerShell Module](https://helpcenter.veeam.com/docs/vbo365/powershell/getting_started.html?ver=70)
6976
- [PScriboCharts Module](https://github.com/iainbrighton/PScriboCharts)
@@ -72,50 +79,52 @@ PowerShell 5.1, and the following PowerShell modules are required for generating
7279
- [AsBuiltReport.Veeam.VB365 Module](https://www.powershellgallery.com/packages/AsBuiltReport.Veeam.VB365/)
7380

7481
### :closed_lock_with_key: Required Privileges
75-
<!-- ********** Define required privileges ********** -->
76-
<!-- ********** Try to follow best practices to define least privileges ********** -->
77-
Only users with Local Administrator group permissions can generate a Veeam VB365 As Built Report.
7882

83+
Only users with Local Administrator group permissions can generate a Veeam VB365 As Built Report.
7984

8085
## :package: Module Installation
8186

8287
### PowerShell
83-
<!-- ********** Add installation for any additional PowerShell module(s) ********** -->
88+
8489
```powershell
85-
install-module AsBuiltReport.Veeam.VB365
90+
Install-Module AsBuiltReport.Veeam.VB365
8691
```
8792

8893
### GitHub
94+
8995
If you are unable to use the PowerShell Gallery, you can still install the module manually. Ensure you repeat the following steps for the [system requirements](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VB365#wrench-system-requirements) also.
9096

91-
1. Download the code package / [latest release](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VB365/releases/latest) zip from GitHub
92-
2. Extract the zip file
97+
1. Download the code package / [latest release](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VB365/releases/latest) zip from GitHub.
98+
2. Extract the zip file.
9399
3. Copy the folder `AsBuiltReport.Veeam.VB365` to a path that is set in `$env:PSModulePath`.
94-
4. Open a PowerShell terminal window and unblock the downloaded files with
100+
4. Open a PowerShell terminal window and unblock the downloaded files with:
95101
```powershell
96102
$path = (Get-Module -Name AsBuiltReport.Veeam.VB365 -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1
97103
```
98104
5. Close and reopen the PowerShell terminal window.
99105
100-
_Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path._
106+
_Note: You are not limited to installing the module to those example paths; you can add a new entry to the environment variable PSModulePath if you want to use another path._
101107
102108
## :pencil2: Configuration
103109
104-
The Veeam VB365 As Built Report utilizes a JSON file to allow configuration of report information, options, detail and healthchecks.
110+
The Veeam VB365 As Built Report utilizes a JSON file to allow configuration of report information, options, detail, and health checks.
111+
112+
A Veeam VB365 report configuration file can be generated by executing the following command:
105113
106-
A Veeam VB365 report configuration file can be generated by executing the following command;
107114
```powershell
108115
New-AsBuiltReportConfig -Report Veeam.VB365 -FolderPath <User specified folder> -Filename <Optional>
109116
```
110117

111-
Executing this command will copy the default Veeam VB365 report JSON configuration to a user specified folder.
118+
Executing this command will copy the default Veeam VB365 report JSON configuration to a user-specified folder.
112119

113120
All report settings can then be configured via the JSON file.
114121

115-
The following provides information of how to configure each schema within the report's JSON file.
122+
The following provides information on how to configure each schema within the report's JSON file.
116123

117124
<!-- ********** DO NOT CHANGE THE REPORT SCHEMA SETTINGS ********** -->
125+
118126
### Report
127+
119128
The **Report** schema provides configuration of the Veeam VB365 report information.
120129

121130
| Sub-Schema | Setting | Default | Description |
@@ -132,25 +141,26 @@ The **Report** schema provides configuration of the Veeam VB365 report informati
132141

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

135-
| Sub-Schema | Setting | Default | Description |
136-
| ---------------------- | ------------------- | ------- | ------------------------------------------------------------------------------ |
137-
| BackupServerPort | TCP Port | 9191 | Used to specify the backup service's custom port. |
138-
| ReportStyle | Veeam/AsBuiltReport | Veeam | Allow to set report style template. |
139-
| EnableDiagrams | true/false | true | Toggle to enable/disable the creation of infrastructure diagram. |
140-
| EnableDiagramsDebug | true/false | false | Toggle to enable/disable diagram debug option. |
141-
| DiagramWaterMark | string | empty | Used to set the diagram waterMark. |
142-
| DiagramTheme | string | White | Used to set the diagram theme. (Black/White/Neon) |
143-
| ExportDiagrams | true/false | false | Toggle to enable/disable diagram export option. |
144-
| ExportDiagramsFormat | string array | png | Set the format used to export the infrastructure diagram. (dot, png, pdf, svg) |
145-
| EnableDiagramSignature | true/false | false | Toggle to enable/disable diagram signature (button right corner) |
146-
| SignatureAuthorName | string | empty | Toggle to set signature author name. |
147-
| SignatureCompanyName | string | empty | Toggle to set signature company name. |
148-
149-
<!-- ********** Add/Remove the number of InfoLevels as required ********** -->
144+
| Sub-Schema | Setting | Default | Description |
145+
| ---------------------- | ------------------- | ------- | -------------------------------------------------------------------------------------------- |
146+
| BackupServerPort | TCP Port | 9191 | Specifies the custom port for the backup service. |
147+
| ReportStyle | Veeam/AsBuiltReport | Veeam | Sets the report style template. |
148+
| EnableDiagrams | true/false | true | Enables or disables the creation of infrastructure diagrams. |
149+
| EnableDiagramsDebug | true/false | false | Enables or disables the diagram debug option. |
150+
| DiagramWaterMark | string | empty | Sets the watermark for the diagram. |
151+
| DiagramTheme | string | White | Sets the diagram theme. Options are Black, White, or Neon. |
152+
| ExportDiagrams | true/false | false | Enables or disables the option to export diagrams. |
153+
| ExportDiagramsFormat | string array | png | Sets the format for exporting the infrastructure diagram. Options are dot, png, pdf, or svg. |
154+
| EnableDiagramSignature | true/false | false | Enables or disables the diagram signature in the bottom right corner. |
155+
| SignatureAuthorName | string | empty | Sets the author name for the diagram signature. |
156+
| SignatureCompanyName | string | empty | Sets the company name for the diagram signature. |
157+
| RoundUnits | int | 1 | Sets the rounding units for data values. |
158+
150159
### InfoLevel
160+
151161
The **InfoLevel** schema allows configuration of each section of the report at a granular level. The following sections can be set.
152162

153-
There are 3 levels (0-2) of detail granularity for each section as follows;
163+
There are 3 levels (0-2) of detail granularity for each section as follows:
154164

155165
| Setting | InfoLevel | Description |
156166
| :-----: | ----------------- | -------------------------------------------------------------------- |
@@ -185,6 +195,7 @@ The table below outlines the default and maximum **InfoLevel** settings for each
185195
| RestorePoint | 1 | 1 |
186196

187197
### Healthcheck
198+
188199
The **Healthcheck** schema is used to toggle health checks on or off.
189200

190201
## :computer: Examples
@@ -204,11 +215,10 @@ PS C:\> New-AsBuiltReport -Report Veeam.VB365 -Target veeam-vbr365.pharmax.local
204215
205216
# Generate a Veeam VB365 As Built Report for Backup Server veeam-vbr365.pharmax.local using stored credentials. Export report to HTML & DOCX formats. Use default report style. Reports are saved to the user profile folder by default. Attach and send reports via e-mail.
206217
PS C:\> New-AsBuiltReport -Report Veeam.VB365 -Target veeam-vbr365.pharmax.local -Username 'Domain\veeam_admin' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -SendEmail
207-
208218
```
209219

210220
## :x: Known Issues
211221

212222
- Error when generating a report in Word format.
213223
- Error Message: New-AsBuiltReport : The variable '$Images' cannot be retrieved because it has not been set
214-
- Fix: Disable the generation of the cover page image. Set ShowCoverPageImage to false
224+
- Fix: Disable the generation of the cover page image. Set ShowCoverPageImage to false
72.6 KB
Loading

0 commit comments

Comments
 (0)