vCenter Server Appliance CLI - JSON Creator

Share on:

I am proud to announce that my first VMware Clarity Project the VCSA JSON Creator is now live! This has been something I have wanted to do for some time, and am glad to finally have the first version available for feedback. Let’s dive in and take a look.

I first want to start off that I would not have been able to do this without the awesome Cody De Arkland explaining how to get started with Clarity UI.

When I discuss with customers about using the vCenter Server Appliance CLI Tools that have been included since vSphere 6.5, they tend to not have used it before. When I have asked why, I normally hear that the JSON is too complex to figure out.

With this being said I am proud to share my first ClarityUI Project the VCSA JSON Creator 9000


I have built the VCSA JSON Creator to be used as a resource to understand how the JSON templates should be created. I currently have two wizards created and I hope to create more based on feedback.


* Installation of an Embedded VCSA 6.7
* Upgrade of an Embedded VCSA 6.5 to 6.7
* Migration of an Embedded Windows vCenter Server 6.5 to 6.7 - Added 4/25/19
* Converge of External PSC - Added 5/2/19
* Decommission of External PSC - Added 5/2/19
* Add Download of JSON Template - Added 5/7/19
* Upgrade of External PSC Appliance and External vCenter Server Appliance - Added 5/8/19


* Migration of External PSC and External vCenter Server

How does it work?

If you take a look at the tool it should look very similar to the vSphere Client. This is because its using the awesome Clarity Design Interface. When you navigate to the homescreen you will see the wizards that are currently available. At this time we can choose create a JSON for an Installation of an Embedded 6.7 VCSA or an Upgrade of a VCSA from 6.5 to 6.7.

For this example we have chosen to do an Install of an Embedded VCSA 6.7. When the wizard is launched you will be prompted for all of the standard information requested as part of the manual creation of the JSON. If you have any questions on how fields should be populated or the format, you can access the link to the documentation or select the (i) signpost to view more information about the fields. Once the first section is filled out we can proceed.

Once we have filled out the first section with the Appliance Deployment Information we can input information for configuration. To simplify this screen a few fields have built-in dropdown’s for the requested items. Proceed to fill in all available fields and then proceed to click next.

Once all our fields have been filled out, your JSON will now be created. You can review how the fields have been entered and then Copy the file to your favorite text editor and save it as a Filename.json.

A download button should hopefully be added in the next update.


Using the CLI based tools doesn’t have to be overwhelming, hopefully this tool can help you understand the process to create the JSON and maybe even save you some time. Look at the additional resources for some references on how to use the VCSA CLI Installer once you have your JSON created. Have any feedback? Leave a comment below!

Additional Resources

comments powered by Disqus

See Also