Category: Virtual Host#

The Virtual host marks an object as a hypervisor and documents the associated management infrastructure. It is a single-value category — exactly one entry exists per object, since a server is either configured as a hypervisor or not.

The central field Virtual host is a Yes/No switch: When set to Yes, the object is marked as a hypervisor and becomes available as a host in the category Virtual machine of other objects. Additionally, a license server and an administration service (e.g. vCenter, SCVMM) can be linked.

Usage#

Typical use cases:

• Hypervisor designation: Mark physical servers as virtualization hosts so that they are available as hosts in the object browser of the category Virtual machine. Without this designation, a server cannot be selected as a hypervisor for VMs — setting the Virtual host field to Yes is therefore the necessary first step when documenting a virtualization environment.
• Assign administration service: The field Administration service links the hypervisor with its central management system — e.g. a vCenter Server for VMware, a System Center Virtual Machine Manager (SCVMM) for Hyper-V, or a Proxmox VE instance. This allows you to evaluate via reports which hosts are managed by which management system — important for migrations and license assessments.
• License server assignment: For VMware environments, the vSphere license server is referenced here. This allows you to trace which hosts use which license — crucial for license audits and when switching from per-socket to per-core licensing.
• Virtualization inventory: Using the Report Manager, you can evaluate which servers are configured as virtual hosts. A report "all objects with Virtual host = Yes" provides the entire hypervisor inventory — the basis for capacity planning, lifecycle management, and licensing.
• Cluster assignment: In combination with the category Cluster membership, you can document which hypervisors belong to which cluster. The administration service then links the cluster with its management layer.

Fields#

Virtual host#

Indicates whether the object functions as a hypervisor (Yes or No). This field is the central switch: Only when it is set to Yes is the object shown as a possible host in the category Virtual machine of other objects. Set this field to Yes for every physical server on which a hypervisor (ESXi, KVM, Hyper-V, Proxmox VE) runs.

License server#

Link to the license server object that manages the virtualization licenses for this host. In VMware environments, this is typically the vSphere license server or the vCenter that assigns the licenses. In KVM or Hyper-V environments without a dedicated license server, this field can be left empty.

Administration service#

Link to the management system that manages this hypervisor — e.g. a vCenter Server, a SCVMM, a Proxmox VE instance, or an oVirt Engine object. This field establishes the relationship to the central management layer and enables reports such as "all hosts managed by vCenter X".

Description#

Free text for additional details: hypervisor version (e.g. "ESXi 8.0 Update 2"), configuration special features (e.g. "GPU passthrough enabled"), notes on licensing or the planned lifecycle.

Technical Reference#

Fields (API Reference)#

API Examples#

Create Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATG__VIRTUAL_HOST",
        "data": {
            "virtual_host": 1,
            "license_server": 456,
            "administration_service": 789,
            "description": "ESXi 8.0 Update 2, License: vSphere Enterprise Plus"
        }
    },
    "id": 1
}

Read Entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATG__VIRTUAL_HOST"
    },
    "id": 2
}

Update Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATG__VIRTUAL_HOST",
        "entry": 1,
        "data": {
            "administration_service": 790,
            "description": "Migration to new vCenter Server (ID 790) completed, 2026-04."
        }
    },
    "id": 3
}