Schemas of the native REST API whose name starts with H.
Host
A hypervisor host.
Name
Type
Required
Description
agent_credential_hash
string or null
SHA-256 of the agent's bearer credential issued at registration. The API strips this field from every host view.
agent_version
string
Host OS / agent version string.
bridges
array of string
Declared standard-switch / host-bridge names (HostNetworkSystem.AddVirtualSwitch). Port groups on host-bridge networks also imply their bridge here when projected.
capabilities
array of string
Capabilities the agent declared at registration (kvm, tcg, swtpm, secure-boot, live-migration, nbd-export, dirty-bitmaps, runtime:<kind>). Placement and operations check them (a host without suspend-to-disk cannot suspend).
certificate_expires_at
string or null
Expiry of the issued host certificate.
certificate_sha256
string or null
SHA-256 (hex) of the DER host certificate the control plane issued at registration. Agent calls are accepted only over mutual TLS with exactly this certificate; issuing a new one (re-registration) revokes the old one.
Static leases, MAC (lower case, colon form) to address; maintained by the control plane ([HostBridgeBacking::reconcile_leases]).
nic_policies
object
Per-NIC policy, MAC (lower case, colon form) to policy: public addresses from IP pools and traffic throttles (docs/network/DESIGN.md §11.2). Projected by the control plane from the ip_pool allocations and the traffic state; never edited by hand.
A quarantine network (M2-NET-02, docs/network/DESIGN.md §11.1): the agent creates the bridge itself, dedicated and without uplink, the lease carries no gateway and no DNS, and the pipeline lets VMs reach each other and the DHCP responder only. Restore verification boots restored backups here (M2-STO-03).
Enforce each NIC's MAC and leased address (default true).
quarantine
boolean or null
Quarantine network (default false): a dedicated bridge the agents create, without uplink, gateway or DNS; VMs reach each other and DHCP only. Needs ipv4 with a serverId and no gateway; used by restore verification.
Answer DHCP (otherwise guests configure the leased address themselves).
dns_servers
array of string
DNS servers handed out; empty: the host agent's defaults.
domain_name
string or null
Domain name handed out.
gateway
string or null
Default gateway handed out (and the DHCP server identifier unless server_id is set).
lease_time_s
integer (int32)
Lease time in seconds.
mtu
integer (int32) or null
Interface MTU handed out.
prefix_len
integer (int32)
yes
Prefix length of the subnet.
range_end
string
yes
Last address leases are allocated from (inclusive).
range_start
string
yes
First address leases are allocated from.
server_id
string or null
DHCP server identifier.
HostBridgeIpv4Request
IPv4 / DHCP settings for a host-bridge network (POST/PUT /v1/networks).
Name
Type
Required
Description
dhcp
boolean or null
Answer DHCP (default true).
dnsServers
array of string
DNS servers handed out.
domainName
string or null
Domain name handed out.
gateway
string or null
Default gateway handed out (and DHCP server id unless serverId is set).
leaseTimeS
integer (int32) or null
Lease time in seconds (default 86400).
mtu
integer (int32) or null
Interface MTU handed out.
prefixLen
integer (int32)
yes
Prefix length of the subnet.
rangeEnd
string
yes
Last address leases are allocated from (inclusive).
rangeStart
string
yes
First address leases are allocated from.
serverId
string or null
DHCP server identifier.
HostBridgeNicTeamingPolicy
NIC teaming overrides (HostNicTeamingPolicy) for facade round-trip and OVS bonds.
With ≥2 members in active_nic + standby_nic, [HostBridgeNicTeamingPolicy::bond_spec] maps the policy to an OVS uplink bond the agent realises on the host-bridge (docs/network/VSPHERE_MAPPING.md). Fewer than two members stay facade-only (the operator plugs a single uplink). Beacon probing is stored but not realised.
Name
Type
Required
Description
active_nic
array of string
nicOrder.activeNic.
check_beacon
boolean or null
failureCriteria.checkBeacon.
notify_switches
boolean or null
notifySwitches.
policy
string or null
policy (loadbalance_srcid, failover_explicit, …).
reverse_policy
boolean or null
reversePolicy.
rolling_order
boolean or null
rollingOrder (true means no failback).
standby_nic
array of string
nicOrder.standbyNic.
HostBridgePortGroupPolicy
Port-group HostNetworkPolicy overrides persisted on a host-bridge network.
Layer-2 security overrides for a host-bridge port group (HostNetworkSecurityPolicy).
Persisted for SOAP / Terraform round-trip (M1-NET-01). macChanges / forgedTransmits drive OpenFlow MAC enforcement on host-bridge VM taps via [HostBridgeSecurityPolicy::mac_enforcement] → [BridgeAttach::port_security]. allowPromiscuous=true is refused (use a mirror session); OVS/OVN cannot dump the switch onto a port without mirroring.
Name
Type
Required
Description
allow_promiscuous
boolean or null
allowPromiscuous.
forged_transmits
boolean or null
forgedTransmits.
mac_changes
boolean or null
macChanges.
HostBridgeShapingPolicy
Traffic shaping overrides (HostNetworkTrafficShapingPolicy) for facade round-trip.
Bandwidth figures are bit/s and burst is bytes, matching vim25. When enabled, the host agent realises average/burst as OVS Interface.ingress_policing_* on VM taps ([HostBridgeShapingPolicy::ingress_policing], from the VM into the switch) and as a Port.qoslinux-htb queue ([HostBridgeShapingPolicy::egress_htb], to the VM). Peak sizes the burst bucket when burst_size is unset. Standard-switch HostNetworkTrafficShapingPolicy is one policy; both directions share those figures.
Name
Type
Required
Description
average_bandwidth
integer (int64) or null
averageBandwidth (bit/s).
burst_size
integer (int64) or null
burstSize (bytes).
enabled
boolean or null
enabled.
peak_bandwidth
integer (int64) or null
peakBandwidth (bit/s).
HostBridgeUplink
Uplink of a host-bridge network.
Name
Type
Required
Description
interface
string or null
The host interface facing the provider's router (eno1); required in proxy mode.
CHAP credentials for software iSCSI (adapter-level or per send target).
Uni-directional fields map to chapName/chapSecret; mutual fields map to mutualChapName/mutualChapSecret (node.session.auth.username_in / password_in via open-iscsi). Secrets are persisted for RescanHba and stripped from REST host views.
Name
Type
Required
Description
enabled
boolean
chapAuthEnabled on the HBA / target.
mutual_enabled
boolean
Mutual CHAP enabled (mutualChapAuthenticationType ≠ chapProhibited).
mutual_secret
string
Mutual CHAP secret (mutualChapSecret / password_in).
mutual_username
string
Mutual CHAP user name (mutualChapName / username_in).
secret
string
CHAP secret (chapSecret).
username
string
CHAP user name (chapName).
HostIscsiDiscoveredTarget
An iSCSI static target IQN (HostInternetScsiHbaStaticTarget).
Used for both manually configured targets (AddInternetScsiStaticTargets) and discovery results after RescanHba.
World-wide id (naa.…), empty when the device has none.
HostPciDevice
One PCI function reported by the host agent.
Name
Type
Required
Description
bus
integer (int32)
PCI bus number.
class_id
integer (int32)
Base class + subclass.
device_class_name
string or null
Short class label when known.
device_id
integer (int32)
Device id.
device_name
string
Device display name.
function
integer (int32)
Function number.
id
string
yes
Domain:bus:slot.function (0000:00:1f.2).
slot
integer (int32)
Device / slot number.
sub_device_id
integer (int32)
Subsystem device id.
sub_vendor_id
integer (int32)
Subsystem vendor id.
vendor_id
integer (int32)
Vendor id.
vendor_name
string
Vendor display name.
HostPowerRequest
Body of POST /v1/hosts/{id}/reboot and POST /v1/hosts/{id}/shutdown.
Name
Type
Required
Description
force
boolean
Reboot or shut down although the host is not in maintenance mode (default false). Virtual machines that still run on the host stop with it.
HostRealizationView
Realization of the firewall on one host.
Name
Type
Required
Description
agentVersion
integer (int64) or null
Version the agent holds.
appliedVersion
integer (int64) or null
Version every bridge confirmed.
error
string or null
Why not.
firewalled
integer (int32)
yes
Firewalled vNICs.
flows
integer (int64)
yes
Firewall flows.
host
string
yes
Host id.
preconditions
array of string
yes
Host preconditions that do not hold (owner actions, e.g. ct-zone-range).
realized
boolean
yes
The host applied the plan last sent.
reportedAt
string or null
Time of the last report.
wantedVersion
integer (int64) or null
Plan version last sent.
HostRuntime
Runtime state reported by the host agent.
Name
Type
Required
Description
admin_disconnected
boolean
Operator disconnected the host (DisconnectHost_Task); heartbeats and agent re-registration keep it disconnected until ReconnectHost_Task.
applied_generation
integer (int64)
Host-level desired-state generation the agent last applied (from its heartbeat or state report); compared with the generation the control plane last sent.