As-Build Report Veeam - Guide for an easy installation


Userlevel 7
Badge +5

Hi All,

I can share my As-Build Report Veeam guide for an easy installation and a good results 😁 !

 

Sources:

https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR

https://github.com/AsBuiltReport/AsBuiltReport.Core

https://www.asbuiltreport.com/user-guide/new-asbuiltreport/

https://techmyth.info/posts/homelab-veeam-vbr-doc-with-asbuiltreport/

 

Veeam Server License requirements: Community edition will not be supported.

Needed installed: Veeam Backup Console installed with same version of Veeam server

 

Installation steps from PS admin shell:

PS> Get-Module -Name Veeam.Backup.PowerShell -ListAvailable                                     

PS> Install-Module PScriboCharts

PS> Import-Module PScriboCharts                                                                 

PS> Find-Module -Name AsBuiltReport.* -Repository PSGallery

PS> Install-Module -Name 'AsBuiltReport.Core' -Repository 'PSGallery' -Scope 'CurrentUser'

PS> $env:PSModulePath

PS> $path = (Get-Module -Name AsBuiltReport.Core -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1

Verify if PS Veeam module is installed:

PS> Get-Module -Name Veeam.Backup.PowerShell -ListAvailable

PS> Install-Module -Name AsBuiltReport.Veeam.VBR

PS> Get-Module -ListAvailable -Name @(‘Veeam.Backup.PowerShell’,‘AsBuiltReport.Veeam.VBR’,‘AsBuiltReport.Core’)

Attending result:

 

Configure report options for use with -Verbose option to Allows you to set the technical parameters of the report, such as the type of data collected:

PS> New-AsBuiltReportConfig Veeam.VBR -FolderPath C:\VeeamReports

After confirm message, you can change name to CustomReportConf.json

Now you can edit custom report .json file.

 

Default configuration for Veeam server joined into domain is:

When the Veeam Server are In Workgroup need edit .json file and change with:

Now we are ready to execute Report command from Veeam Backup Console, PowerShell Console:

 

PS command line for Veeam server in Workgroup (change red text):

 

New-AsBuiltReport -Report Veeam.VBR -Target 192.168.1.2 -Username 192.168.1.2\administrator -Password P@ssw0rd -Format Html,Word -OutputFolderPath 'C:\VeeamReports' -ReportConfigFilePath C:\VeeamReports\CustomReportConf.json -Verbose

 

PS command line for Veeam server joined to AD domain (change red text):

 

New-AsBuiltReport -Report Veeam.VBR -Target veeam-vbr.contoso.local -Username contoso\veeam_admin -Password P@ssw0rd -Format Html,Word -OutputFolderPath C:\VeeamReports

 

This command line create 2 reports in Word and HTML format.

Enjoy Veeam reports !


41 comments

Userlevel 7
Badge +20

Very nice updates and additions.  Time to test this new release.  😎

Userlevel 4
Badge

 

Can you run the following commands so I can determine which cmdlet is causing the error?
 

# Connect to VBR server

Connect-VBRServer -Server veeam-backup.domain.local -User "username" -Password "password"


Get-VBRNASServer



Get-VBRUnstructuredServer



Get-VBRProtectionGroup

Hi Jonathan,

here is the actual output.


PS C:\Users\Administrator> Connect-VBRServer -Server veeam-backup -User "xxx" -Password "xxx"

PS C:\Users\Administrator> Get-VBRNASServer
WARNUNG: This cmdlet is obsolete, use Get-VBRUnstructuredServer instead.

PS C:\Users\Administrator> Get-VBRUnstructuredServer

PS C:\Users\Administrator> Get-VBRProtectionGroup
Get-VBRProtectionGroup : Current license does not allow this operation
In Zeile:1 Zeichen:1
+ Get-VBRProtectionGroup
+ ~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Get-VBRProtectionGroup], LicenseException
    + FullyQualifiedErrorId : System.ComponentModel.LicenseException,Veeam.Backup.PowerShell.Cmdlets.GetVBRProtectionGroup

 

Just to let you know that in version 0.8.5 the bug has been fixed and added many many new features!

## [0.8.5] - 2024-03-15

### Added

- Added Option => History section
- Improved Role & Users section
  - Added Global MFA settings
  - 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)


 

 

Userlevel 7
Badge +20

I will keep this in mind if I run into this issue but have not so far.

Userlevel 4
Badge

 

Can you run the following commands so I can determine which cmdlet is causing the error?
 

# Connect to VBR server

Connect-VBRServer -Server veeam-backup.domain.local -User "username" -Password "password"


Get-VBRNASServer



Get-VBRUnstructuredServer



Get-VBRProtectionGroup

Hi Jonathan,

here is the actual output.


PS C:\Users\Administrator> Connect-VBRServer -Server veeam-backup -User "xxx" -Password "xxx"

PS C:\Users\Administrator> Get-VBRNASServer
WARNUNG: This cmdlet is obsolete, use Get-VBRUnstructuredServer instead.

PS C:\Users\Administrator> Get-VBRUnstructuredServer

PS C:\Users\Administrator> Get-VBRProtectionGroup
Get-VBRProtectionGroup : Current license does not allow this operation
In Zeile:1 Zeichen:1
+ Get-VBRProtectionGroup
+ ~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Get-VBRProtectionGroup], LicenseException
    + FullyQualifiedErrorId : System.ComponentModel.LicenseException,Veeam.Backup.PowerShell.Cmdlets.GetVBRProtectionGroup

 

Thank you for helping us with finding the problematic powershell cmdlet.

Until I can find a solution, you can generate a ReportConfig so that the entire inventory section can be disabled.

New-AsBuiltReportConfig -Report Veeam.VBR -FolderPath <User specified folder> -Filename <Optional>

https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR?tab=readme-ov-file#pencil2-configuration

After generating the ReportConfig json file open it and set all values in the Inventory section to 0.

 

Then run the report with the -ReportConfigFilePath <Path> option.

New-AsBuiltReport -Report Veeam.VBR -Target veeam-backup -Username '.\xxxxxx' -Password 'xxxxxxxx' -Format Html,Word -OutputFolderPath 'G:\Report' -Timestamp -ReportConfigFilePath <Json Path>

Ironically the Get-VBRProtectionGroup command is not supposed to cause any issue with the report because I am running it inside a try/catch statement but like everything in IT... Murphy's law is always after us.

Have a good day!

Userlevel 7
Badge +20

Thanks.  So it seems the VBR protection group is the one causing the license message. I am sure @jcolonfzenpr will sort you out.

Userlevel 2
Badge

Your license has not expired, has it?  I would not think so but wonder if it does a check when running the report or something?  I have not studied it in depth but wondered.  Hopefully @jcolonfzenpr can answer.

Yeah, it would be good to validate that the license is not expired.

Thanks, was just a thought and maybe not relevant but I check everything.  😁

Hi Chris,

 

the license will expire in 6 month. ;-)

 

Regards

Christopher

Userlevel 2
Badge

 

Can you run the following commands so I can determine which cmdlet is causing the error?
 

# Connect to VBR server

Connect-VBRServer -Server veeam-backup.domain.local -User "username" -Password "password"


Get-VBRNASServer



Get-VBRUnstructuredServer



Get-VBRProtectionGroup

Hi Jonathan,

here is the actual output.


PS C:\Users\Administrator> Connect-VBRServer -Server veeam-backup -User "xxx" -Password "xxx"

PS C:\Users\Administrator> Get-VBRNASServer
WARNUNG: This cmdlet is obsolete, use Get-VBRUnstructuredServer instead.

PS C:\Users\Administrator> Get-VBRUnstructuredServer

PS C:\Users\Administrator> Get-VBRProtectionGroup
Get-VBRProtectionGroup : Current license does not allow this operation
In Zeile:1 Zeichen:1
+ Get-VBRProtectionGroup
+ ~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Get-VBRProtectionGroup], LicenseException
    + FullyQualifiedErrorId : System.ComponentModel.LicenseException,Veeam.Backup.PowerShell.Cmdlets.GetVBRProtectionGroup

Userlevel 4
Badge

 

Can you run the following commands so I can determine which cmdlet is causing the error?
 

# Connect to VBR server

Connect-VBRServer -Server veeam-backup.domain.local -User "username" -Password "password"


Get-VBRNASServer



Get-VBRUnstructuredServer



Get-VBRProtectionGroup
Userlevel 7
Badge +20

Your license has not expired, has it?  I would not think so but wonder if it does a check when running the report or something?  I have not studied it in depth but wondered.  Hopefully @jcolonfzenpr can answer.

Yeah, it would be good to validate that the license is not expired.

Thanks, was just a thought and maybe not relevant but I check everything.  😁

Userlevel 4
Badge

Your license has not expired, has it?  I would not think so but wonder if it does a check when running the report or something?  I have not studied it in depth but wondered.  Hopefully @jcolonfzenpr can answer.

Yeah, it would be good to validate that the license is not expired.

Userlevel 4
Badge

 

 

Hi Christopher,

When this error appears, does the script abruptly terminate without generating the report or is it completely generated and it is just a warning message?

Have a nice day.

Hello Jonathan,

the script will terminate and no report is generated.

 

Here you can see the output on the powershell console:

----------------------------------------------
 <       As Built Report Configuration      > 
----------------------------------------------
Would you like to save the As Built Report configuration file? (y/n): n
Please wait while the Veeam VBR As Built Report is being generated.
WARNUNG: [ 14:11:19:480 ] [ Document ] - Please refer to the AsBuiltReport.Veeam.VBR github website for more detailed information about this project.
WARNUNG: [ 14:11:19:496 ] [ Document ] - Do not forget to update your report configuration file after each new version release.
WARNUNG: [ 14:11:19:496 ] [ Document ] - Documentation: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR
WARNUNG: [ 14:11:19:496 ] [ Document ] - Issues or bug reporting: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues
WARNUNG: [ 14:11:19:558 ] [ Document ] - AsBuiltReport.Veeam.VBR 0.8.4 is currently installed.
WARNUNG: [ 14:12:04:433 ] [ Document ] - Malware Detection Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.
WARNUNG: [ 14:12:04:449 ] [ Document ] - VM Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.
WARNUNG: [ 14:12:40:402 ] [ Document ] - Inventory Summary Section: Current license does not allow this operation
New-AsBuiltReport : Current license does not allow this operation
In Zeile:1 Zeichen:1
+ New-AsBuiltReport -Report Veeam.VBR -Target veeam-backup -Username '. ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,New-AsBuiltReport

Regards

Christopher

This two warning messages will be fixed in the next release

WARNUNG: [ 14:12:04:433 ] [ Document ] - Malware Detection Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.
WARNUNG: [ 14:12:04:449 ] [ Document ] - VM Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.

https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/145

 

The ErrorException is obviously a bug! I will be analyzing the code and let you know the result.

WARNUNG: [ 14:12:40:402 ] [ Document ] - Inventory Summary Section: Current license does not allow this operation

Regards

Userlevel 7
Badge +20

Your license has not expired, has it?  I would not think so but wonder if it does a check when running the report or something?  I have not studied it in depth but wondered.  Hopefully @jcolonfzenpr can answer.

Userlevel 2
Badge

Hi,

I’m using a Rental license on a Veeam Server. The license typ is Enterprise plus.

While running the report I got the following message:

“New-AsBuiltReport : Current license does not allow this operation”

Is there a way to get rid of these error?

Regards

Christopher

Which report were you trying to run and what switches?  That is odd as I use the same license type and never have this issue running the utility.

 

Hi Chris,

here you can see the report command:

New-AsBuiltReport -Report Veeam.VBR -Target veeam-backup -Username '.\xxxxxx' -Password 'xxxxxxxx' -Format Html,Word -OutputFolderPath 'G:\Report' -Timestamp

 

It’s good to here that it’s running in your environment.

 

Regards

Christopher

Userlevel 2
Badge

 

 

Hi Christopher,

When this error appears, does the script abruptly terminate without generating the report or is it completely generated and it is just a warning message?

Have a nice day.

Hello Jonathan,

the script will terminate and no report is generated.

 

Here you can see the output on the powershell console:

----------------------------------------------
 <       As Built Report Configuration      > 
----------------------------------------------
Would you like to save the As Built Report configuration file? (y/n): n
Please wait while the Veeam VBR As Built Report is being generated.
WARNUNG: [ 14:11:19:480 ] [ Document ] - Please refer to the AsBuiltReport.Veeam.VBR github website for more detailed information about this project.
WARNUNG: [ 14:11:19:496 ] [ Document ] - Do not forget to update your report configuration file after each new version release.
WARNUNG: [ 14:11:19:496 ] [ Document ] - Documentation: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR
WARNUNG: [ 14:11:19:496 ] [ Document ] - Issues or bug reporting: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues
WARNUNG: [ 14:11:19:558 ] [ Document ] - AsBuiltReport.Veeam.VBR 0.8.4 is currently installed.
WARNUNG: [ 14:12:04:433 ] [ Document ] - Malware Detection Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.
WARNUNG: [ 14:12:04:449 ] [ Document ] - VM Exclusions Section: Das Argument kann nicht an den Parameter "Rows" gebunden werden, da es sich um eine leere Auflistung handelt.
WARNUNG: [ 14:12:40:402 ] [ Document ] - Inventory Summary Section: Current license does not allow this operation
New-AsBuiltReport : Current license does not allow this operation
In Zeile:1 Zeichen:1
+ New-AsBuiltReport -Report Veeam.VBR -Target veeam-backup -Username '. ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,New-AsBuiltReport

Regards

Christopher

Userlevel 7
Badge +20

Hi,

I’m using a Rental license on a Veeam Server. The license typ is Enterprise plus.

While running the report I got the following message:

“New-AsBuiltReport : Current license does not allow this operation”

Is there a way to get rid of these error?

Regards

Christopher

Which report were you trying to run and what switches?  That is odd as I use the same license type and never have this issue running the utility.

Userlevel 4
Badge

Hi Christopher,

When this error appears, does the script abruptly terminate without generating the report or is it completely generated and it is just a warning message?

Have a nice day.

Userlevel 2
Badge

Hi,

I’m using a Rental license on a Veeam Server. The license typ is Enterprise plus.

While running the report I got the following message:

“New-AsBuiltReport : Current license does not allow this operation”

Is there a way to get rid of these error?

Regards

Christopher

Userlevel 4
Badge

Hi @Chris.Childerhose  Finally I figured it out and fixed it. It seems the offline Module from Github not working fine with me so I installed from PSGallery repo from another device (coz server that I worked on does not have internet access) and I loaded the new one and it works fine.

Thanks for you following up.

 

I'm glad you were able to resolve it and my thanks to those who helped you do so.

I have included the URL for the most recent instructions on how to run the report. In the future I will try to make the process for generating the report simpler.

https://techmyth.blog/posts/homelab-veeam-vbr-doc-with-asbuiltreport/

 

Userlevel 7
Badge +20

Hi @Chris.Childerhose  Finally I figured it out and fixed it. It seems the offline Module from Github not working fine with me so I installed from PSGallery repo from another device (coz server that I worked on does not have internet access) and I loaded the new one and it works fine.

Thanks for you following up.

Awesome that is great to hear you figured it out.  Glad to help. 👍

Userlevel 4
Badge +1

Hi @Chris.Childerhose  Finally I figured it out and fixed it. It seems the offline Module from Github not working fine with me so I installed from PSGallery repo from another device (coz server that I worked on does not have internet access) and I loaded the new one and it works fine.

Thanks for you following up.

Userlevel 7
Badge +20

I fixed the first issue it was a missing module called PScribo and I passed tthat issue but now stuck in another one which is :

New-AsBuiltReport : The 'Invoke-AsBuiltReport.Veeam.VBR' command was found in the module 'AsBuiltReport.Veeam.VBR',
but the module could not be loaded. For more information, run 'Import-Module AsBuiltReport.Veeam.VBR'.
At line:1 char:1
+ New-AsBuiltReport -Report Veeam.VBR -Target 172.17.2.180 -Username 17 ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,New-AsBuiltReport

 

When I checked and did an import command it says that PSGraph issue as below :

PS C:\Users\Administrator> Import-Module AsBuiltReport.Veeam.VBR
Import-Module : The required module 'PSGraph' is not loaded. Load the module or remove the module from
'RequiredModules' in the file
'C:\Users\Administrator\Documents\WindowsPowerShell\Modules\Veeam.Diagrammer\Veeam.Diagrammer.psd1'.
At line:1 char:1
+ Import-Module AsBuiltReport.Veeam.VBR
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceUnavailable: (C:\Users\Admini...Diagrammer.psd1:String) [Import-Module], Missing
   MemberException
    + FullyQualifiedErrorId : Modules_InvalidManifest,Microsoft.PowerShell.Commands.ImportModuleCommand

The module is exist but am not sure where is the problem exactly now as the diagrammer also there too

 

Any help in here coz my mind will blow :(

I would suggest you go through the website and install all the pre-requisites needed for this to run properly. Sounds like something is still missing based on the errors.

Userlevel 4
Badge +1

I fixed the first issue it was a missing module called PScribo and I passed tthat issue but now stuck in another one which is :

New-AsBuiltReport : The 'Invoke-AsBuiltReport.Veeam.VBR' command was found in the module 'AsBuiltReport.Veeam.VBR',
but the module could not be loaded. For more information, run 'Import-Module AsBuiltReport.Veeam.VBR'.
At line:1 char:1
+ New-AsBuiltReport -Report Veeam.VBR -Target 172.17.2.180 -Username 17 ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,New-AsBuiltReport

 

When I checked and did an import command it says that PSGraph issue as below :

PS C:\Users\Administrator> Import-Module AsBuiltReport.Veeam.VBR
Import-Module : The required module 'PSGraph' is not loaded. Load the module or remove the module from
'RequiredModules' in the file
'C:\Users\Administrator\Documents\WindowsPowerShell\Modules\Veeam.Diagrammer\Veeam.Diagrammer.psd1'.
At line:1 char:1
+ Import-Module AsBuiltReport.Veeam.VBR
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceUnavailable: (C:\Users\Admini...Diagrammer.psd1:String) [Import-Module], Missing
   MemberException
    + FullyQualifiedErrorId : Modules_InvalidManifest,Microsoft.PowerShell.Commands.ImportModuleCommand

The module is exist but am not sure where is the problem exactly now as the diagrammer also there too

 

Any help in here coz my mind will blow :(

Userlevel 7
Badge +20

As I told you I copied the example command and changed only the red parts thats why I am sure that it is the same. I spent more than 3 hours to figure it out but with no luck even I restarted the process from the beginning step by step also without luck.  

Sounds good.  Hopefully the OP will reply when he has time.

Userlevel 4
Badge +1

As I told you I copied the example command and changed only the red parts thats why I am sure that it is the same. I spent more than 3 hours to figure it out but with no luck even I restarted the process from the beginning step by step also without luck.  

Userlevel 7
Badge +20

This is the command that I used and I double check with the article 

 

New-AsBuiltReport -Report Veeam.VBR -Target 172.17.2.180 -Username 172.17.2.180\administrator -Password P@ssw0rd -Format Html,Word -OutputFolderPath ‘C:\VeeamReports’ -ReportConfigFilePath C:\VeeamReports\CustomReportConf.json -Verbose

 

Could you please chek?

Based on this it looks correct from the example above.  Is there a space with the dash and password command?  I know web formatting is funky some times LOL

Example -

New-AsBuiltReport -Report Veeam.VBR -Target 192.168.1.2 -Username 192.168.1.2\administrator -Password P@ssw0rd -Format Html,Word -OutputFolderPath 'C:\VeeamReports' -ReportConfigFilePath C:\VeeamReports\CustomReportConf.json -Verbose

Based on this everything looks right even the single quotes.  Maybe @jcolonfzenpr can address this.

Comment