Hypervisor
This page describes how the Hypervisor module connects to vCenter and ESXi, what it changes there and where its limits are.
What the module does is described on the module page.
As of: November 2026, COD 3.8.6
Documentation contents
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Documentation
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Overview
| Property | Value |
|---|---|
| Purpose | Read the host network. Create, change and delete standard vSwitches and port groups. Detect differing port group names per VLAN |
| Supported systems | VMware vCenter and ESXi. Not other hypervisors such as Hyper-V or KVM |
| Interface | VMware API through the Python library pyVmomi, over HTTPS |
| Connection and direction | The cod-hypervisor service on the COD server opens the connection to vCenter or ESXi |
| Service | Always runs on the COD server, never on a module server |
| Credentials | Hostname, domain, user and password per connection. COD stores the connections per location |
| Rights on the target | Read access for the inventory. For changes, rights on the host network. You receive the minimum rights as part of the project. |
| Link to other modules | None. The module is not linked with Asset, Network or Firewall |
Requirements
On the COD server
- Package
cod-hypervisorinstalled. It is part ofcod-all. - The service runs on the same host as COD. COD only addresses it locally.
- The COD server reaches vCenter or the ESXi hosts over HTTPS.
Customers and partners receive the list of connections and firewall rules as part of the project.
In vCenter or ESXi
- A dedicated service account for COD, recommended. Changes made from COD then stay traceable in vSphere.
- Read access to datacenters, clusters, hosts and networks for the inventory.
- For changes, rights on the vSwitches and port groups of the hosts. You receive the minimum rights as part of the project.
- Each ESXi host appears under only one of the connected vCenters.
In COD
- Hypervisor module enabled for the tenant.
- A role with the permission for the Hypervisor module.
Setup
The rollout wizard does not cover the Hypervisor module. You set up the service on the COD server.
- Check on the COD server that the service is running:
systemctl status cod-hypervisor. Details under TACACS+ and Hypervisor by hand. - The manager account enables the module: “Admin Area > Tenant > Modules”. Then sign out and in again.
- Choose the location in the top bar.
- In the Hypervisor module, create a connection under “Connections”: hostname, domain, user, password.
- Check the inventory. It shows datacenters, clusters, hosts, vSwitches and port groups.
- Change port groups first under “Port Groups” with a dry run. Write to the hosts only once the result is right.
For further vCenters, create a separate connection per vCenter.
Technical details
Connection
COD talks to vCenter and ESXi through the VMware API, using the Python library pyVmomi over HTTPS. You do not enter credentials with every call. COD stores each connection with hostname, domain, user and password per location. Whoever uses the module at a location works with that location's connections.
Inventory
| Level | What COD shows |
|---|---|
| Datacenter, cluster, host | Object tree from vCenter, read only |
| vSwitch | Standard vSwitches per host, with active, standby and unused NICs and security settings |
| Port group | Name and VLAN ID |
| Physical NICs | pNICs per host |
The hypervisor tree is one of the sources of the global search.
Functions
| Function | Where | Dry run |
|---|---|---|
| Create a vSwitch, per host with chosen physical NICs as uplinks | Wizard under “Structure” | no, writes immediately |
| Create a port group | Wizard under “Structure” | no, writes immediately |
| Create, change, delete port groups | “Port Groups” | yes, on by default |
| Detect differing port group names | Inventory | not needed, read only |
VLAN IDs
| Value | Meaning |
|---|---|
| 1 to 4095 | VLAN ID when creating a port group |
| 0 in the inventory | Untagged |
| 4095 in the inventory | Trunk across all VLANs |
Several hosts
Operations accept a list of hosts. The result reports success or failure per host. After every change, check the hosts with errors one by one.
Differing names
COD reports when the same VLAN ID is carried under different port group names on identically named vSwitches across hosts. This is a common cause of failed VM migrations.
NIC teaming
COD shows the NIC assignment per vSwitch. When you create a vSwitch, you choose the physical NICs as uplinks. Load balancing and security policies are still set in vSphere.
Audit
Changes appear in the Admin Area audit, with type, data sent and returned, time and user. Dry runs and the wizard under “Structure” do not appear there.
Known limits
| Limit | What you can do |
|---|---|
| Standard vSwitches only, no distributed switches | Keep managing distributed switches in vSphere |
| No VM control, no lifecycle of VMs or hosts | Use vSphere for this |
| No link to Asset, Network or Firewall | Also keep ESXi hosts as assets if you need them there |
| An ESXi host under two vCenters breaks the synchronisation | Connect each ESXi host through one vCenter only |
| Dry run only under “Port Groups” | Use the wizard under “Structure” with care, for example in a maintenance window |
| The wizard under “Structure” does not appear in the audit | Document these changes yourself |
| No merged view across several vCenters | Work per connection |
| Load balancing and security policies not in COD | Set them in vSphere |
| Service only on the COD server | Plan the path from the COD server to vCenter and ESXi |
| Minimum rights in vCenter not documented | You receive the minimum rights as part of the project. |
Further reading
- Hypervisor module page
- What your network needs for Hypervisor
- Deployment shapes
- Troubleshooting
- Integrations
- Questions about the modules