API Reference¶

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

Table of Contents¶

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

bmc.kubevirt.io/v1beta1

VirtualMachineBMC

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

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

spec:
  virtualMachineRef:
    name: string  # Required
  authSecretRef:
    name: string  # Required

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

For the latest API specification, see the CRD definition.