Skip to content

Overview

Report modules are the core of AsBuiltReport - each module provides vendor-specific or technology-specific documentation capabilities. A report module knows how to connect to a system, collect configuration data, and generate comprehensive documentation in multiple formats.

What are Report Modules?

Each report module is a PowerShell module that extends AsBuiltReport to support a specific technology or platform:

  • Vendor-Specific - VMware vSphere, Microsoft Active Directory, Veeam Backup & Replication, etc.
  • Self-Contained - Each module includes all the logic to collect and format data for its technology
  • Independently Updated - Modules are updated on their own schedule to support new product versions
  • Community-Driven - Built and maintained by the AsBuiltReport community

Getting Started with Report Modules

1. Discover Available Modules

Use PowerShell to find all available report modules:

Find all AsBuiltReport modules
# List all available modules
Find-Module -Name AsBuiltReport.* | Select-Object Name, Description

# Search for a specific vendor
Find-Module -Name AsBuiltReport.VMware.* | Select-Object Name, Description

2. Install a Module

Install a report module
# Install a report module (AsBuiltReport.Core is automatically installed)
Install-Module -Name AsBuiltReport.VMware.vSphere -Scope CurrentUser

3. Check Module Requirements

Before generating reports, check each module's GitHub README for:

  • Supported product versions - Which versions of the target system are supported
  • PowerShell version requirements - PowerShell 5.1, 7.x compatibility
  • Dependencies - Required vendor PowerShell modules (e.g., VCF.PowerCLI)
  • Minimum permissions - What access rights are needed

Module Documentation

Click on any report module name in the table below to access its GitHub repository with detailed documentation, examples, and known issues.

PowerShell Compatibility

Most report modules support:

  • Windows PowerShell 5.1 - Built into Windows 10/11 and Windows Server 2016+
  • PowerShell 7+ - Cross-platform support (Windows, Linux, macOS)

Check Module-Specific Requirements

Some modules may have specific PowerShell version requirements. Always check the module's README before installation.

Finding Modules

There are multiple ways to discover and access report modules:

Method Description
PowerShell Gallery Use Find-Module -Name AsBuiltReport.* to search
This Documentation Browse by vendor in the left sidebar
GitHub Organization View all repositories at github.com/AsBuiltReport
Activity Table See the table below for published modules with version and activity status

Quick Start by Vendor

VMware report modules require VMware PowerCLI:

Install VMware modules
# Install VCF PowerCLI
Install-Module -Name VCF.PowerCLI -Scope CurrentUser -AllowClobber -SkipPublisherCheck

# Install VMware vSphere report module
Install-Module -Name AsBuiltReport.VMware.vSphere -Scope CurrentUser

# Generate a report
New-AsBuiltReport -Report VMware.vSphere -Target vcenter.example.com -Credential (Get-Credential)

Available VMware Modules:

  • VMware vSphere - Document vCenter, clusters, hosts, VMs, networking, storage
  • VMware ESXi - Standalone ESXi host documentation
  • VMware Horizon - VDI environment documentation
  • VMware App Volumes - Application delivery documentation
  • VMware Site Recovery Manager - Disaster recovery configuration

Microsoft modules may require specific Windows features or modules:

Install Microsoft modules
# For Active Directory (requires RSAT-AD-PowerShell feature)
Install-Module -Name AsBuiltReport.Microsoft.AD -Scope CurrentUser

# For DHCP (requires RSAT-DHCP feature)
Install-Module -Name AsBuiltReport.Microsoft.DHCP -Scope CurrentUser

# For Windows Servers
Install-Module -Name AsBuiltReport.Microsoft.Windows -Scope CurrentUser

# Generate an Active Directory report
New-AsBuiltReport -Report Microsoft.AD -Target dc01.example.com -Credential (Get-Credential)

Available Microsoft Modules:

  • Active Directory - Domain controllers, forest, domains, sites, replication
  • DHCP - DHCP server configuration and scope documentation
  • Windows - Windows Server configuration and roles
  • Azure - Azure subscription and resource documentation
  • SCVMM - System Center Virtual Machine Manager

Veeam modules require Veeam PowerShell snapins:

Install Veeam modules
# Install Veeam Backup & Replication module
Install-Module -Name AsBuiltReport.Veeam.VBR -Scope CurrentUser

# Install Veeam Backup for Microsoft 365 module
Install-Module -Name AsBuiltReport.Veeam.VB365 -Scope CurrentUser

# Generate a VBR report
New-AsBuiltReport -Report Veeam.VBR -Target veeam-server.example.com -Credential (Get-Credential)

Available Veeam Modules:

  • Veeam VBR - Backup & Replication infrastructure and jobs
  • Veeam VB365 - Backup for Microsoft 365 configuration

Storage vendor modules:

Install storage modules
# NetApp ONTAP
Install-Module -Name AsBuiltReport.NetApp.ONTAP -Scope CurrentUser

# Pure Storage FlashArray
Install-Module -Name AsBuiltReport.PureStorage.FlashArray -Scope CurrentUser

# Dell EMC VxRail
Install-Module -Name AsBuiltReport.DellEMC.VxRail -Scope CurrentUser

Available Storage Modules:

  • NetApp ONTAP - Storage system configuration
  • Pure Storage FlashArray - FlashArray configuration
  • Dell EMC VxRail - Hyperconverged infrastructure

Networking vendor modules:

Install networking modules
# Fortinet FortiGate
Install-Module -Name AsBuiltReport.Fortinet.FortiGate -Scope CurrentUser

# Aruba ClearPass
Install-Module -Name AsBuiltReport.Aruba.ClearPass -Scope CurrentUser

Available Networking Modules:

  • Fortinet FortiGate - Firewall configuration
  • Aruba ClearPass - Network access control

Additional infrastructure modules:

Install other modules
# Nutanix Prism Element
Install-Module -Name AsBuiltReport.Nutanix.PrismElement -Scope CurrentUser

# Rubrik CDM
Install-Module -Name AsBuiltReport.Rubrik.CDM -Scope CurrentUser

# System Resources
Install-Module -Name AsBuiltReport.System.Resources -Scope CurrentUser

Available Modules:

  • Nutanix Prism Element - Hyperconverged infrastructure
  • Rubrik CDM - Cloud Data Management
  • System Resources - General system resource documentation

Activity Status

The table below provides the status of report modules currently published to the PowerShell Gallery.

For a complete list of report modules, including those still in development, please refer to the AsBuiltReport GitHub Organization.

To check the status of a report module, click on the module's last updated or contributors links and reach out to the module's maintainers.

Aruba

Report Last Updated Version Release Date Contributors
Aruba ClearPass

Dell EMC

Report Last Updated Version Release Date Contributors
Dell EMC VxRail

Fortinet

Report Last Updated Version Release Date Contributors
Fortinet FortiGate

Microsoft

Report Last Updated Version Release Date Contributors
Microsoft Active Directory
Microsoft Azure
Microsoft DHCP
Microsoft SCVMM
Microsoft Windows

NetApp

Report Last Updated Version Release Date Contributors
NetApp ONTAP

Nutanix

Report Last Updated Version Release Date Contributors
Nutanix Prism Element

Pure Storage

Report Last Updated Version Release Date Contributors
Pure Storage FlashArray

Rubrik

Report Last Updated Version Release Date Contributors
Rubrik CDM

System

Report Last Updated Version Release Date Contributors
System Resources

Veeam

Report Last Updated Version Release Date Contributors
Veeam VB365
Veeam VBR

VMware

Report Last Updated Version Release Date Contributors
VMware App Volumes
VMware ESXi
VMware Horizon
VMware Site Recovery Manager
VMware vSphere

Next Steps