Controlling vSphere & NSX-V With Python

Share on:

My former colleagues had made me aware of pyVmomi an open source library which VMware provide and mostly maintain for managing vSphere, so its here I shall start. Since then NSX for vSphere has also an open source library NSX RAML Client provided by VMware so I’ll then move to that.

I am performing this learning exercise in my home lab using is vSphere 6.5, vSAN 6.5, NSX6.3, with Python 2.7.10, although this should work the same with other versions.

Install pyVmomi and open vCenter connection and then initiate an interactive python environment

git clone
sudo pip install -r ~/pyvmomi/requirements.txt

Import the pyVim, pyVmomi & SSL libraries we are using,

import ssl
from pyVim import connect
from pyVmomi import vim, vmodl

Open connection to vCenter then gather contents as an object

vcenter = connect.SmartConnect(
content = vcenter.RetrieveContent()

Basic get of information

Once we have vCenter Object Model as content object we can output any part of this data

'VMware vCenter Server 6.5.0 build-5178943'

We can also explore the Object Model which is well descrived here in the vSphere SDK API Docs and when we know what we want to look for we can search and display anything we like, for example the list of virtual machines.

objView = content.viewManager.CreateContainerView(content.rootFolder,[vim.VirtualMachine],True)
vmList = objView.view
for  vm in vmList:

Basic put of configuration information

As well as getting information from the Object Model we can just as easily apply configuration to items within (assuming the account we connect with has sufficient rights), for example if we gather the list of hosts and set a advanced option on all of them.

objView = content.viewManager.CreateContainerView(content.rootFolder,[vim.HostSystem],True)
hostList = objView.view
for host in hostList:
    optionManager = host.configManager.advancedOption
    option = vim.option.OptionValue(key='VSAN.ClomRepairDelay', value=long(120))

NSX for vSphere

So we have the pyVmomi library for vSphere, in addition to this VMware have provided open source library for NSX for vSphere.

We’ll first make sure the packages are installed along with the additional packages for managing NSX.

sudo pip install nsxramlclient pyvim pyvmomi lxml requests

The NSX for vSphere REST API changes with each version, so in order to use the nsxramlclient library we will need a RAML file specific to version of NSX-V we are connecting to. The RAML file also produces nice dynamic documentation of the NSX APIs.

git clone
cd nsxraml
git checkout 6.3

So now we can try and connect and get some information about anything described in the API document, like NSX Controllers.

from nsxramlclient.client import NsxClient
nsx_manager = ""
nsx_username = "admin"
nsx_password = "VMware1!VMware1!"
nsxraml_file = 'nsxvapi.raml'
nsx_manager_session = NsxClient(nsxraml_file, nsx_manager, nsx_username, nsx_password)
nsx_controllers ='nsxControllers', 'read')

When it comes to putting and posting information getting the formatting right can be a challenge. To this end with the library it is possible to create a template python dictionary using extract_resource_body_example. Once we have this we can display the output structure but more usefully we can also substitute values into the template.

new_ls = nsx_manager_session.extract_resource_body_example('logicalSwitches', 'create')
new_ls['virtualWireCreateSpec']['name'] = 'TestLogicalSwitch1'
new_ls['virtualWireCreateSpec']['description'] = 'TestLogicalSwitch1'
new_ls['virtualWireCreateSpec']['tenantId'] = 'Tenant1'
new_ls['virtualWireCreateSpec']['controlPlaneMode'] = 'UNICAST_MODE'

Once we have out body template correctly describing what we want we can post this and if all goes to plan create a new Logical Switch. In this example I am passing in the scopeId (transport zone) manually to keep it a simple example.

new_ls_response = nsx_manager_session.create('logicalSwitches', uri_parameters={'scopeId': 'vdnscope-1'}, request_body_dict=new_ls)


It looks like with our new found friend the VMware Python libraries we can easily create and deploy a VMware configuration ‘infrastructure as code’.