Category: Virtual Host (Overview)#

The Virtual Host (Overview) is an aggregation category that consolidates all virtualization-related information of a hypervisor on a single page. It combines the contents of the Virtual Host, Guest Systems, and Virtual Switches categories into one comprehensive overview.

This category contains no exclusive fields of its own -- it summarizes data that is maintained in the respective subcategories. Changes are not made directly in the overview category but in the linked individual categories. The purpose is a consolidated view of the entire virtualization configuration of a host, without needing to switch between multiple categories.

Usage#

Typical use cases:

• Quick overview during incidents: During a host outage, the overview category shows at a glance: Is the server a hypervisor? Which VMs are running on it? Which virtual switches are configured? This information is crucial during an incident -- without it, the administrator would have to navigate between multiple categories and lose valuable time.
• Verifying virtualization documentation: When onboarding new hosts or during CMDB quality assurance, the overview immediately shows whether all virtualization-relevant categories are maintained. A host with Virtual host = Yes but without guest systems and without virtual switches is either not yet fully documented or an unused hypervisor -- both worth investigating.
• Maintenance planning: Before a maintenance window for a hypervisor, the overview provides all relevant information: the list of affected VMs (from Guest Systems), the administration service for live migration (from Virtual Host), and the network configuration of the VMs (from Virtual Switches).
• Audit and compliance: In regulated environments, the overview serves as a compact reference for the entire virtualization configuration of a host. Auditors can see on a single page which workloads run on which physical hardware and how network separation is configured.

Included Categories#

The overview aggregates the following categories:

Fields#

The displayed fields come from the subcategories. The following fields are displayed in the overview:

Virtual host#

Indicates whether the object functions as a hypervisor (Yes or No). Originates from the Virtual Host category.

License server#

Link to the license server object. Originates from the Virtual Host category.

Administration service#

Link to the management system (e.g. vCenter, SCVMM). Originates from the Virtual Host category.

Description#

Free text description. Originates from the Virtual Host category.

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_ROOT",
        "data": {
            "virtual_host": 1,
            "license_server": 456,
            "administration_service": 789,
            "description": "Proxmox VE 8.1, Cluster pve-prod-01"
        }
    },
    "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_ROOT"
    },
    "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_ROOT",
        "entry": 1,
        "data": {
            "virtual_host": 1,
            "description": "Upgrade auf Proxmox VE 8.2 abgeschlossen, 2026-04."
        }
    },
    "id": 3
}