Tooling for documenting Cisco UCS Manager domains:

The community "UCS Health Check" HTML dashboard script that earlier versions of this toolkit bundled is no longer included: its upstream reuse terms could not be established, so it is not redistributed here.

The module depends on Cisco UCS PowerTool (Cisco.UCSManager), which is built on .NET Framework 4.5. It does not load on macOS/Linux PowerShell (which runs on .NET Core) — the Cisco.Ucs.Common.Cmdlets assembly fails to load there. Run everything on Windows: Windows PowerShell 5.1 (built in) or PowerShell 7 on Windows.

Requirements:

• A Windows host that can reach the UCS Manager cluster VIP on TCP 443
• A UCS Manager account — read-only is sufficient; you do not need admin
• Internet access on the host (to install modules)

Windows PowerShell 5.1 ships with Windows and works for everything here. To also get PowerShell 7 (recommended):

# Option A: winget (Windows 10/11)
winget install --id Microsoft.PowerShell --accept-package-agreements --accept-source-agreements

# Option B: Microsoft's install script (any Windows)
iex "& { $(irm https://aka.ms/install-powershell.ps1) } -UseMSI -Quiet"

Check your version:

$PSVersionTable.PSVersion

Run in an Administrator PowerShell window.

Windows PowerShell 5.1 note: if -AcceptLicense errors with "parameter cannot be found," update the package manager first, then open a new window:

[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
Install-Module PowerShellGet -Force -AllowClobber -Scope CurrentUser

PowerShell 7 does not need this.

Install the framework and UCS PowerTool from the PowerShell Gallery:

Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
Install-Module AsBuiltReport.Core -Scope CurrentUser -AllowClobber -Force
Install-Module Cisco.UCSManager   -Scope CurrentUser -AllowClobber -AcceptLicense -Force

Install the As-Built module from this repo (it is not on the Gallery). From the cisco/ folder:

# PowerShell 7 module path (use \WindowsPowerShell\ for PS 5.1)
Copy-Item -Recurse -Force .\AsBuiltReport.Cisco.UcsManager "$HOME\Documents\PowerShell\Modules\"
Import-Module AsBuiltReport.Cisco.UcsManager -Force
(Get-Module AsBuiltReport.Cisco.UcsManager).Version   # confirm it loaded

Verify everything is present:

Get-Module -ListAvailable AsBuiltReport.*, Cisco.UCSManager | Select-Object Name, Version

$cred = Get-Credential            # read-only UCSM account
New-Item -ItemType Directory C:\AsBuiltReports -Force
New-AsBuiltReport -Report Cisco.UcsManager `
  -Target <FI-CLUSTER-VIP> `
  -Credential $cred `
  -Format Word,Html `
  -OutputFolderPath C:\AsBuiltReports `
  -Verbose

• -Target is the UCS Manager cluster VIP, not an individual fabric interconnect.
• The output folder must exist first (New-Item above).
• PDF: open the generated .docx in Word and Save As → PDF. (Neither tool emits PDF directly.)
• Company logo / branding: paste your logo's Base64 into $e360LogoBase64 in AsBuiltReport.Cisco.UcsManager\AsBuiltReport.Cisco.UcsManager.Style.ps1. It embeds on Windows.
• First run against a newer UCSM may print a few property-mismatch warnings — harmless; the report still generates.

• As-Built module — originally by Tim Carman (@tpcarman), part of the AsBuiltReport project. Revived and modernized for PowerShell 7 / current AsBuiltReport framework for e360 by HumbledGeeks.
• UCS Health Check — a community script from the datacenter/ucs-browser project was bundled in earlier versions; it was removed because no license could be established for it. It is not part of this repository.

The vendored As-Built module retains its upstream MIT license — see AsBuiltReport.Cisco.UcsManager/LICENSE.

Consolidated from previous local automation repositories during the 2026 LabOps repository cleanup. This repository starts with a fresh history; earlier history is retained locally only.

Repository content authored for this toolkit is licensed under the MIT License (see LICENSE). Third-party components retain their own license notices: the included AsBuiltReport.Cisco.UcsManager module keeps its upstream MIT license and attribution in AsBuiltReport.Cisco.UcsManager/LICENSE; no ownership of third-party code is claimed.