Three commands to a finished report
Everything installs from the PowerShell Gallery. Configuration lives in JSON files you can keep in source control and reuse on a schedule. The Quickstart Guide covers each step in detail.
Install the framework
The core module, plus a report module for each product you want to document.
Set it up once
Record your company details, then choose how much detail and which health checks each report includes.
Features
-
Multiple Document Formats
Generate reports in one or more document formats, including DOCX, HTML, and Text.
-
Granular Information Level
Configure the information level for each report section. You can create a summary report, a fully comprehensive report, or something in between.
-
Health Checks
Enable health checks to highlight configuration issues within a report. Toggle individual health checks on or off as required.
-
Customised Styling
Use the default style or create your own to match your corporate identity. Set page orientation, text and table formatting with fonts, colours, borders and highlighted cells and rows.
-
Multilingual Support
Comprehensive multilingual support allows reports to be generated in multiple languages, where available.
-
Modular Architecture
The modular architecture and core framework enables users to use the same in-built commands to generate as-built configuration reports from a library of technology vendors.
-
Email Reports
Attach and send reports via email to one or more recipients.
Use Cases
-
Compliance Audits
Generate point-in-time infrastructure documentation for ISO 27001, SOC 2, PCI-DSS, and other compliance frameworks.
-
Change Management
Produce before-and-after documentation for change advisory board (CAB) submissions and post-change verification.
-
Environment Handover
Accelerate onboarding and handover with comprehensive, consistent infrastructure documentation generated on demand.
-
Disaster Recovery
Maintain accurate as-built records of your infrastructure to support disaster recovery planning and runbook validation.
Report Modules
Each module documents one product and is maintained by people who run it. See the report module overview for compatibility and documentation.
-
Aruba
-
Dell EMC
-
Fortinet
-
Microsoft
Microsoft.AD Microsoft.Azure Microsoft.DHCP Microsoft.SCVMM Microsoft.Windows
-
NetApp
-
Nutanix
-
Veeam
-
VMware
How the pieces fit
Each report starts on the live system and ends as a finished document. Your settings travel with it as JSON files and a style script, so the same command gives the same report every time.
Your platform
The system you want to document, such as a vCenter Server, an Azure tenant or a Veeam backup server.
Report module
Collects the configuration through the vendor's PowerShell module or REST API. There is one module for each product.
AsBuiltReport.Microsoft. Azure.json
Information levels, health checks and report options. Create it with New-AsBuiltReportConfig.
Core module
Provides the base commands and builds the document with PScribo.
AsBuiltReport.json
Author, company and email settings. Create it with New-AsBuiltConfig.- Style script
Fonts, colours, cover page and table styles. Use the default or create your own.
Your report
Saved as Word, HTML or text, and sent by email if you choose.
Document the kit you run
AsBuiltReport is written by the people who use it. If your platform is missing, the developer guide shows how to build a report module for it.