AsBuiltReport.Diagram

AsBuiltReport.Diagram is a PowerShell module that provides a foundational framework for creating as-built diagrams of various datacenter systems. It serves as a required dependency for individual diagrammer modules, which generate diagrams tailored to specific products or technologies.

🔰 Getting Started

The following simple list of instructions will get you started with the AsBuiltReport.Diagram module.

💾 Supported Versions

PowerShell

This module is compatible with the following PowerShell versions;

Windows PowerShell 5.1	Windows/Linux/MacOs PowerShell 7
✅	✅

🔧 System Requirements

PowerShell 5.1/7, and the following PowerShell modules are required for generating a AsBuiltReport.Diagram diagram.

• PSGraph Module

📦 Module Installation

PowerShell

Online Installation

For an online installation, install the AsBuiltReport.Diagram module using the PowerShell Gallery;

# Install AsBuiltReport.Diagram module
Install-Module -Name 'AsBuiltReport.Diagram' -Repository 'PSGallery' -Scope 'CurrentUser'

Offline Installation

For an offline installation, perform the following steps from a machine with internet connectivity;

Save the required AsBuiltReport.Diagram module to a specified folder.

# Save AsBuiltReport.Diagram module
Save-Module -Name 'AsBuiltReport.Diagram' -Repository 'PSGallery' -Path '<Folder Path>'

Copy the downloaded AsBuiltReport.Diagram module folder to a location that can be made accessible to the offline system. e.g. USB Flash Drive, Internal File Share etc.

On the offline system, open a PowerShell console window and run the following command to determine the PowerShell module path.

Windows

$env:PSModulePath -Split ';'

Copy the downloaded AsBuiltReport.Diagram module folder to a folder specified in the $env:PSModulePath output.

Graphviz Linux/MacOS Installation

Linux & MacOs require the installation of Graphviz to be able to generate the diagram:

Linux

"Debian*, Ubuntu*"

sudo apt install graphviz

"Fedora project*, Rocky Linux, Redhat Enterprise Linux, or CentOS*"

sudo dnf install graphviz

MacOs

"MacPorts* provides both stable and development versions of Graphviz and the Mac GUI Graphviz.app. These can be obtained via the ports graphviz, graphviz-devel, graphviz-gui and graphviz-gui-devel."

sudo port install graphviz

"Homebrew* has a Graphviz port."

brew install graphviz

📚 Documentation

The documentation for the AsBuiltReport.Diagram module can be found in the Docs.

📘 Example Index

All examples in the latest release of AsBuiltReport.Diagram can be found in the table below, each with a link to their documentation page.

Name	Description	Module
Example1	Node cmdlet	PSGraph
Example2	Edge cmdlet	PSGraph
Example3	Edge minlen attribute	PSGraph
Example4	SubGraph cmdlet	PSGraph
Example5	Add-NodeIcon cmdlet	AsBuiltReport.Diagram
Example6	DraftMode feature	AsBuiltReport.Diagram
Example7	Rank cmdlet	PSGraph
Example8	Add-HtmlNodeTable cmdlet	AsBuiltReport.Diagram
Example9	Add-HtmlNodeTable MultiIcon feature	AsBuiltReport.Diagram
Example10	Add-NodeImage cmdlet	AsBuiltReport.Diagram
Example11	Add-HtmlTable cmdlet	AsBuiltReport.Diagram
Example12	WaterMark feature	AsBuiltReport.Diagram
Example13	Signature feature	AsBuiltReport.Diagram
Example14	Add-NodeShape cmdlet	AsBuiltReport.Diagram
Example15	Add-NodeSpacer cmdlet	AsBuiltReport.Diagram
Example16	Add-NodeEdge cmdlet	AsBuiltReport.Diagram
Example17	ShapeLine cmdlet	AsBuiltReport.Diagram
AdvancedExample1	Add-HtmlSubGraph cmdlet	AsBuiltReport.Diagram
AdvancedExample2	Add-NodeText cmdlet	AsBuiltReport.Diagram

❌ Known Issues