Below are the instructions on how to install, configure and generate a VMware NSX-T As Built report.
The VMware NSX-T As Built Report supports the following NSX-T versions;
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell Core | PowerShell 7 |
|---|---|---|
The following PowerShell modules are required for generating a VMware NSX-T As Built report.
Each of these modules can be easily downloaded and installed via the PowerShell Gallery
The following role assigned privileges are required to generate a VMware NSX-T As Built Report.
The VMware NSX-T As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A VMware NSX-T report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.NSX-T -FolderPath <User specified folder> -Filename <Optional> Executing this command will copy the default VMware NSX-T 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 NSX-T report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | VMware NSX-T 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 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 / Summary | Provides summarised information for a collection of objects |
| 2 | Detailed | Provides detailed information for individual objects |
| 3 | Comprehensive | Provides comprehensive information for individual objects, such as advanced configuration settings |
The Healthcheck schema is used to toggle health checks on or off.