VMware Cloud Foundation As Built Report is a PowerShell module which works in conjunction with AsBuiltReport.Core.
AsBuiltReport is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
Below are the instructions on how to install, configure and generate a VMware Cloud Foundation As Built report.
The VMware Cloud Foundation As Built Report supports the following Cloud Foundation versions;
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a VMware Cloud Foundation As Built Report.
- .NET Core is required for cover page image support on Linux and macOS operating systems.
❗ If you are unable to install .NET Core, you must set ShowCoverPageImage to False in the report JSON configuration file.
install-module AsBuiltReport.VMware.CloudFoundationIf 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 also.
- Download the code package / latest release zip from GitHub
- Extract the zip file
- Copy the folder
AsBuiltReport.VMware.CloudFoundationto a path that is set in$env:PSModulePath. - Open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name AsBuiltReport.VMware.CloudFoundation -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1
- Close and reopen the PowerShell terminal window.
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.
The VMware Cloud Foundation As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A VMware Cloud Foundation report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.CloudFoundation -FolderPath <User specified folder> -Filename <Optional>Executing this command will copy the default VMware Cloud Foundation report JSON configuration to a user specified folder.
All report settings can then be configured via the JSON file.
The following provides information of how to configure each schema within the report's JSON file.
The Report schema provides configuration of the VMware Cloud Foundation report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | VMware Cloud Foundation 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 |
The Options schema allows certain options within the report to be toggled on or off.
The InfoLevel schema allows configuration of each section of the report at a granular level. The following sections can be set.
There are 6 levels (0-5) of detail granularity for each section as follows;
| Setting | InfoLevel | Description |
|---|---|---|
| 0 | Disabled | Does not collect or display any information |
| 1 | Enabled / Summary | 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 |
| 4 | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects |
| 5 | Comprehensive | Provides comprehensive information for individual objects, such as advanced configuration settings |
The Healthcheck schema is used to toggle health checks on or off.