AsBuiltReport is an open source PowerShell framework that documents your infrastructure for you, for any platform with a PowerShell module or REST API. Choose your vendors, level of detail, health checks, styling and language, then get the report in Word, HTML or text, by email if you like.
Note
Due to time constraints and limited access to development environments and resources for current contributors, development and support for AsBuiltReport has slowed, with some report modules now falling behind on support for current vendor technology versions.
However, this is an open source project, and we encourage users to contribute to help keep it going.
Your contributions, whether through code, bug reports, or documentation, are crucial to its success!
Use the discussion board to share ideas, ask for help, or collaborate with others. Together, we can keep improving AsBuiltReport for everyone!
 Follow the Quickstart Guide to generate your first report in minutes. |
 Browse all available Report Modules by vendor and technology. |
 Generate reports in one or more document formats, including DOCX, HTML, and Text. |
 Comprehensive multilingual support allows reports to be generated in multiple languages, where available. |
 Configure the information level for each report section. You can create a summary report, a fully comprehensive report, or something in between. |
 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. |
 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. |
 Enable health checks to highlight configuration issues within a report. Toggle individual health checks on or off as required. |
 Attach and send reports via email to one or more recipients. |
 Generate point-in-time infrastructure documentation for ISO 27001, SOC 2, PCI-DSS, and other compliance frameworks. |
 Produce before-and-after documentation for change advisory board (CAB) submissions and post-change verification. |
 Accelerate onboarding and handover with comprehensive, consistent infrastructure documentation generated on demand. |
 Maintain accurate as-built records of your infrastructure to support disaster recovery planning and runbook validation. |
 The core module provides the framework for each individual report module. It provides the base commands and default style script used to generate each individual report. |
 The report module is specific to each vendor and/or technology and is used to extract information from the specific environment. The report module will be written to utilise PowerShell modules or RESTful APIs which the vendor/technology provides. |
 The core module configuration is a JSON file which stores information relating to the author’s name, company information & SMTP mail server configuration. Individual core module configuration files can be saved and specified when generating reports. |
 The reports module configuration is a JSON file which stores information specific to the related report. It holds information such as the report name, version, and release status. The report configuration can also provide functionality such as configurable report options, health checks and granular information levels. Individual report module configuration files can be saved and specified when generating reports. |
 The styles script sets the default layout, fonts, colours and sizes used within the report. Style scripts can be used to layout cover pages, table of contents and other unique tables or sections. Custom style scripts can be created to format reports to match your corporate identity. |
Select a module to open its repository and documentation.
Not every module supports the latest vendor release. Check the activity status table before you start.