As Built Report - working with it in my lab

Hi all,

This tool is most excellent.  It can produce detailed, or more detailed, or most detailed reports of your vSphere environment.

I should mention that when I use setting 2 for detail I get a Word document that is 9 pages long but when I use the default of 3, I get a report of 114 pages. But very good info and useful for a variety of reasons - such as DR, or helping with patching or VMware Tools updates. If I was still an SE for partners I would be using this script every time I finished working at a customer so I could also compare between when I finished the work and when I showed up to help troubleshoot.

The tool is call As Built Report and it comes from this site, but you can also see their VMworld session too.

Anyone is is experienced with PowerShell / PowerCLI is going to find it pretty easy.  But I am a beginner, and I have not worked with JSON before so I stumbled a bit. So I am going to share a little bit of into to help people that might stumble as well.

Install outline

install-module AsBuiltReport

And yes, this means if you do update-module it will update things. This will also install all of the modules that AsBuilt has even though I will only use the vSphere one.

Execution - first

The command below is what you need to use the first time.  And answer all the questions like your name, email and the like.

12 thoughts on “As Built Report - working with it in my lab

  1. Hi,
    Very nice guide. I have a question regarding your home lab. How many vms and hosts do you have in your lab that produces a report of 114 pages ( or 9 pages with level 2 ). Why Im asking is because I am thinking of using this is our production environment to get a full report. But the production environment contains a couple of hundred vms and a bunch of hosts so im afraid im gonna get a huge report that will crash my disk.



    1. Hi Johan,

      Yes, I suspect you will have a very large doc. I have only 4 hosts and maybe 40 or 50 VMs so you will have something pretty big, but I suspect it will still be useful. there will hot links, and you can always do ctrl F.


  2. Hi Michael,

    How to install-module AsBuiltReport in offline environment where no public network access.

    1. You can download stuff from the gallery on another machine and copy it to where you need it. I have not done that but am told that is possible. Maybe try Google. Let me know how it goes.


  3. Hello,
    I tried to used for generating report from multiple VMware vCentre. Both Vcenter are in the same doamin. I used this command:

    New-AsBuiltReport -Report VMware.vSphere -Target server1.local,server2.local -Credential (Get-Credential) -Format HTML,Word -OutputPath ‘C:\users\xxxx\desktop\reporty\’ -TimeStamp

    The result is

    Invoke-AsBuiltReport.VMware.vSphere : 21.9.2019 3:33:25 Connect-VIServer Cannot complete login due to an incorrect user name or password.
    At C:\Program Files\WindowsPowerShell\Modules\AsBuiltReport.Core\1.0.1\Src\Public\New-AsBuiltReport.ps1:307 char:13
    + & “Invoke-$($ReportModule)” -Target $Target -Credential $ …
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,Invoke-AsBuiltReport.VMware.vSphere

    Report is generated only for server1.

  4. Hello Michael,

    I am trying to use New-AsBuiltReport -Report VMware.vSphere on a VMware host that is not connected to a vceneter. Can I use the AsBuiltReport.VMware.vSphere module to run on a stand alone ESXI host or is there another module I should use to get a report ?

  5. Hello Michael,

    Thank you for sharing the link to run Inventory reports from an ESXI host. It is very similar to the RVTools windows application which can provide a lot more detail on your ESXI host and then export to a Excel spreadsheet. That’s what lead me to AsBuilt as I wanted to create a document which I could present to my customer. Could you create a module to pull a report from a standalone ESXI host. I have a system to test if you need.

    Thanks again


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.