Document your vSphere environment? Yes you can!

I heard from Ariel Sanchez that he needed something tested.  It was vDocumentation and him and Edgar Sanchez had something very cool.  I want to share it with you as I think it very handy.  It produces very nice reports on your vSphere environment.  Lets see how to get it working and produce some reports.

The home of this project is in this GitHub location. But all the info you need is right here in this article.


  • Have PowerCLI installed – preferably 6.5.2, and be in PowerCLI and execute these commands:

Install-Module ImportExcel -scope CurrentUser

Install-Module vDocumentation -scope CurrentUser

  • If you have errors when executing those commands you can add -force at the end of the line.
  • If you have installed this cool stuff a few weeks ago you should do:

Update-Module vDocumentation

  • If you want to learn what version you have, you can use the following command:

Get-Module vDocumentation -ListAvailable | Format-List


Now connect to your vCenter (Connect-VIserver vcName) and execute the following commands:

Get-ESXInventory -ExportExcel

Get-ESXIODevice -ExportExcel

Get-ESXNetworking -ExportExcel

Get-ESXStorage -ExportExcel

Note that there may be some red errors on the Get-ESXStorage but I can tell you they  know and are working on it – confirmed that the red with the storage still occurs in my lab.

Once the four reports are done, and you look in the location where they are written too – by default of v1 – c:\windows\system32 and default of v2 – c:\users\your_name.


Below is screenshots of each report.  But only the first part, with each one you could scroll down and right in Excel.  They are very detailed reports.


IO Device



There you have it.  With very little work, and very little config, you end up with four very detailed Excel spreadsheets on your vSphere environment.  Very handy stuff and I sure like how easy it is to install and update!


  • 10/18/17 – I did the Update-Module vDocumentation and there was an update.  Came down fine.  Here is the readme from GitHub. One thing I see I really like is that the default path is much easier and logical now – c:\users\your_user_name. I have also used this with PowerCLI 6.5.3 with no issue.  If your Get-Module shows you multiple vDocumentation, then use uninstall-module vDocumentation once for each installed version, then install again and you will only have the latest.  No matter how many versions you have installed, you will only execute the latest.


=== END ===

Tagged with: ,
Posted in Home Lab, How To
5 comments on “Document your vSphere environment? Yes you can!
  1. Angelo says:

    Hi Michael, you can check this free tool give you quite good reporting on your environment.

    • Hi Angelo,

      Thanks for reaching out. Yes, I do quite like RVtools and it is in my images. But I also like choices, and the script based ways to get documentation is pretty cool tool. I think it is very nice people like us have two ways to get reports!


  2. Tony says:

    This is phenomenal, thanks for sharing!

  3. Dave Watkins says:

    The Storage report errors if there is no local storage in an ESX server. In our case booting from Dell Dual SD cards and all datastores are SAN based. Other than that thought, these are very cool

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 )

Twitter picture

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

Facebook photo

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

Google+ photo

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

Connecting to %s

%d bloggers like this: