Skip to content

API Reference

This document provides detailed reference for the KubeVirtBMC Custom Resource Definition (CRD).

Table of Contents

VirtualMachineBMC

The VirtualMachineBMC is a Custom Resource that represents a virtual BMC for a KubeVirt VirtualMachine.

API Version

bmc.kubevirt.io/v1beta1

Kind

VirtualMachineBMC

Full Resource Name

apiVersion: bmc.kubevirt.io/v1beta1
kind: VirtualMachineBMC

Specification

VirtualMachineBMCSpec

The spec section defines the desired state of the Virtual BMC.

spec:
  virtualMachineRef:
    name: string  # Required
  authSecretRef:
    name: string  # Required
  ipmi:
    enabled: false  # Optional, defaults to false

Fields

Field Type Required Description
virtualMachineRef LocalObjectReference Yes Reference to the VirtualMachine to manage
virtualMachineRef.name string Yes Name of the VirtualMachine resource
authSecretRef LocalObjectReference Yes Reference to the Secret containing BMC credentials
authSecretRef.name string Yes Name of the Secret resource
ipmi IPMISpec No IPMI configuration. When omitted, IPMI is disabled.

IPMISpec

IPMISpec configures the IPMI simulator.

ipmi:
  enabled: false  # Optional, defaults to false

Fields

Field Type Required Description
ipmi.enabled bool No Toggles the IPMI simulator. Defaults to false when omitted. Set to true to enable IPMI support.

For the latest API specification, see the CRD definition.