Releasing the Nutanix Documentation Script


One of the things I’ve been working on since I started at Nutanix is the Nutanix documentation script. Luckily there already is an PowerShell framework to document AD, DHCP but also XenApp, XenDesktop and PVS for instance.


And with the current release of NOS 4.1.1 and Barry Schiffer’ NetScaler Documentation script I figured it would be a good idea to do the same thing for the Nutanix solution. The Nutanix management interface (PRISM) is a very powerful tool to get all information in a general overview:



This interface will give you access to both the REST API and the PowerShell CMDlets and these PoSH cmdlets are very useful and well written so I could easily use them in the base script. I wanted to thank both authors of the framework:

  • Carl Webster: Thank you so much for creating the base script and putting so much of your own time into this scripts. It’s guys like you that make the community so much stronger.
  • Iain Brighton: The man that makes writing PoSH scripts and functions look easy and is ever so willingly to help out with all questions (Yes, even the stupid ones). Thanks for all your patience with this scripting novice.
What’s currently in the script
  • New look and feel; Utilizing native Microsoft Word tables;
  • Mandatory items for the Nutanix PRISM interface, username and password;
  • Incorporating all Get- cmdlets into the script.
  • The parameter -full will get all non-resolved alerts and events on the system.

The script is easy to use with just 3 mandatory parameters:

Nutanix_Script_v1_unsigned.ps1 -nxIP -nxUser Admin -nxPassword ****

This will give you a word document which is (by default) called ‘Nutanix Documentation Script’ in the directory where you run the script.

If you want to incorporate all non resolved alerts and events the syntax would be:

Nutanix_Script_v1_unsigned.ps1 -nxIP -nxUser Admin -nxPassword **** -full

On the machine you’d be running the script on you need:

  • Office 2013
  • PoSH 3
  • Nutanix CMDlets (from NOS4.1.1)
  • NOS4.1.1 (it will work on older versions of NOS but it won’t give all the information the script will process when on NOS4.1.1)

The script should be started from the Nutanix CMDlets as this cmdlet icon will automatically load the appropriate commands.

The Nutanix CMDlets can be installed from the PRISM interface:

Original image from:

Release notes

This version of the script will gather and format the following information:

  • Cluster Overview
  • Licensing
  • Node Information
  • Storage Pool(s)
  • Containers
  • vDisks
  • VMs
  • Protection Domain(s)
Next enhancements

For the next versions of the script I’m looking at the following enhancements:

  • Support for Hyper-V
  • Support for older versions of NOS

The Nutanix documentation script version 1 can be downloaded here:

If you have any questions about the scripts or possible feature requests/improvements please don’t hesitate to leave a comment!



As requested some screenshots from the output of the script from my lab environment:

The following two tabs change content below.

Kees Baggerman

Kees Baggerman is a Staff Solutions Architect for End User Computing at Nutanix. Kees has driven numerous Microsoft and Citrix, and RES infrastructures functional/technical designs, migrations, implementations engagements over the years.


  1. Marco says:

    Hi Kees! Great script, can you post a documentation example? Kind regards, Marco

  2. k.baggerman says:

    The example files I’ve created so far are from my demo environment, when I’ve got some spare time I’ll clean them up or post parts of it as an update to this blog.

  3. aakashjacob says:

    Hi Kees, Can the two screenshots to the next available big size…

  4. […] Releasing the Nutanix Documentation Script This looks pretty cool.  A script that will document your Nutanix configuration.  No way to test it of course – but one day I would like very much to play with Nutanix. But I know some of my readers that have and support Nutanix and I suspect you know of this already but just in case here it is. […]

  5. […] Leibovici‘s « Nutanix 4.0 PowerShell goes GA » or Kees Baggerman‘s excellent « Releasing the Nutanix Documentation Script », but I felt there wasn’t any good blog that took you through the process step by step and […]

Leave a Reply

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