Skip to content

Document your datacenter with PowerShell.

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.

Generate your first report Browse report modules

Runs on Windows PowerShell 5.1 and PowerShell 7. MIT licensed.

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.

PowerShell
Install-Module AsBuiltReport.Core
Install-Module AsBuiltReport.Microsoft.Azure

Set it up once

Record your company details, then choose how much detail and which health checks each report includes.

PowerShell
New-AsBuiltConfig
New-AsBuiltReportConfig -Report Microsoft.Azure

Generate the report

Run it by hand or from a scheduled task. The document is rebuilt from the live system each time.

PowerShell
New-AsBuiltReport -Report Microsoft.Azure `
  -Target $TenantId -UseInteractiveAuth -Format Word

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.

Components

  • Core Module

    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.

  • Reports Module

    The report module is specific to each vendor and/or technology and is used to extract information from the specific environment. It is written to utilise PowerShell modules or RESTful APIs which the vendor/technology provides.

  • Core Module Configuration

    A JSON file which stores information relating to the author's name, company information and SMTP mail server configuration. Individual core module configuration files can be saved and specified when generating reports.

  • Reports Module Configuration

    A JSON file which stores information specific to the related report, such as the report name, version, and release status. It also provides configurable report options, health checks and granular information levels. Individual report module configuration files can be saved and specified when generating reports.

  • Styles Script

    The styles script sets the default layout, fonts, colours and sizes used within the report, and can lay out 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.

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.

Read the developer guide Join the discussion

AsBuiltReport
Licence
MIT
Built with
PowerShell and PScribo
Maintained by
Tim Carman, Jonathan Colon
Downloads
250,000+ on the PowerShell Gallery
Formats
Word, HTML, Text
Site
Made with ProperDocs