The VMware NSX-v AsBuiltReport is a module of the parent "AsBuiltReport" project. AsBuiltReport is a PowerShell module which generates As-Built documentation for many common datacentre infrastructure systems. Reports can be generated in Text, XML, HTML and MS Word formats and can be presented with custom styling to align with your company/customer's brand.
For detailed documentation around the whole project, please refer to the README.md file in the parent AsBuiltReport repository (linked to above). This README is specific only to the VMware NSX-v repository.
Sample NSX-v As Built report using default report style.
Sample NSX-v As Built report using custom report style.
Below are the instructions on how to install, configure and generate a VMware NSX-v As Built Report
The following PowerShell modules are required for generating a VMware NSX-v As Built report.
Each of these modules can be easily downloaded and installed via the PowerShell Gallery
Open a Windows PowerShell terminal window and install each of the required modules as follows;
Install-Module VMware.PowerCLI
Install-Module PowerNSX
Install-Module AsBuiltReportTo generate a VMware NSX-v report, a user account with the administrator role or higher to the target vCenter Server and Enterprise Administrator on the target NSX Manager is required.
The VMware NSX-v As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A VMware NSX-v report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.NSXv -Path <User specified folder> -Name <Optional>Executing this command will copy the default NSX-v 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.
<Placeholder for future - there are currently no configurable options for the VMware NSX-v Report>
There is one example listed below on running the AsBuiltReport script against a vCenter Server target which will report on the NSX environment registered with the specified vCenter Server.
- The following creates a VMware NSXv As-Built report in HTML & Word formats and exports the report to the C:\scripts folder
PS C:\>New-AsBuiltReport -Report VMware.NSXv -Target vc01 -Credential (Get-Credential) -Format HTML,Word -OutputPath C:\Scripts