Packages:

• metal.ironcore.dev/v1alpha1

metal.ironcore.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the settings.gardener.cloud API group

Resource Types:

BIOSSettings

BIOSSettings is the Schema for the biossettings API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BIOSSettingsSpec	BIOSSettingsTemplate BIOSSettingsTemplate (Members of BIOSSettingsTemplate are embedded into this type.) BIOSSettingsTemplate defines the template for BIOS Settings to be applied on the servers. serverRef Kubernetes core/v1.LocalObjectReference ServerRef is a reference to a specific server to apply bios setting on.
status BIOSSettingsStatus

BIOSSettingsFlowState (string alias)

(Appears on:BIOSSettingsFlowStatus)

Value	Description
"Applied"	BIOSSettingsFlowStateApplied specifies that the bios setting has been completed for current Priority
"Failed"	BIOSSettingsFlowStateFailed specifies that the bios setting update has failed.
"InProgress"	BIOSSettingsFlowStateInProgress specifies that the BIOSSetting Controller is updating the settings for current Priority
"Pending"	BIOSSettingsFlowStatePending specifies that the BIOSSetting Controller is updating the settings for current Priority

BIOSSettingsFlowStatus

(Appears on:BIOSSettingsStatus)

Field	Description
flowState BIOSSettingsFlowState	(Optional) State represents the current state of the bios configuration task for current priority.
name string	(Optional) Name identifies current priority settings from the Spec
priority int32	(Optional) Priority identifies the settings priority from the Spec
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the BIOSSettings’s current Flowstate.
lastAppliedTime Kubernetes meta/v1.Time	(Optional) LastAppliedTime represents the timestamp when the last setting was successfully applied.

BIOSSettingsSet

BIOSSettingsSet is the Schema for the biossettingssets API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BIOSSettingsSetSpec	biosSettingsTemplate BIOSSettingsTemplate BiosSettingsTemplate defines the template for the BIOSSettings Resource to be applied to the servers. serverSelector Kubernetes meta/v1.LabelSelector ServerSelector specifies a label selector to identify the servers that are to be selected.
status BIOSSettingsSetStatus

BIOSSettingsSetSpec

(Appears on:BIOSSettingsSet)

BIOSSettingsSetSpec defines the desired state of BIOSSettingsSet.

Field	Description
biosSettingsTemplate BIOSSettingsTemplate	BiosSettingsTemplate defines the template for the BIOSSettings Resource to be applied to the servers.
serverSelector Kubernetes meta/v1.LabelSelector	ServerSelector specifies a label selector to identify the servers that are to be selected.

BIOSSettingsSetStatus

(Appears on:BIOSSettingsSet)

BIOSSettingsSetStatus defines the observed state of BIOSSettingsSet.

Field	Description
fullyLabeledServers int32	FullyLabeledServers is the number of server in the set.
availableBIOSSettings int32	AvailableBIOSVersion is the number of Settings current created by the set.
pendingBIOSSettings int32	PendingBIOSSettings is the total number of pending server in the set.
inProgressBIOSSettings int32	InProgressBIOSSettings is the total number of server in the set that are currently in InProgress.
completedBIOSSettings int32	CompletedBIOSSettings is the total number of completed server in the set.
failedBIOSSettings int32	FailedBIOSSettings is the total number of failed server in the set.

BIOSSettingsSpec

(Appears on:BIOSSettings)

BIOSSettingsSpec defines the desired state of BIOSSettings.

Field	Description
BIOSSettingsTemplate BIOSSettingsTemplate	(Members of BIOSSettingsTemplate are embedded into this type.) BIOSSettingsTemplate defines the template for BIOS Settings to be applied on the servers.
serverRef Kubernetes core/v1.LocalObjectReference	ServerRef is a reference to a specific server to apply bios setting on.

BIOSSettingsState (string alias)

(Appears on:BIOSSettingsStatus)

BIOSSettingsState specifies the current state of the BIOS Settings update.

Value	Description
"Applied"	BIOSSettingsStateApplied specifies that the bios setting update has been completed.
"Failed"	BIOSSettingsStateFailed specifies that the bios setting update has failed.
"InProgress"	BIOSSettingsStateInProgress specifies that the BIOSSetting Controller is updating the settings
"Pending"	BIOSSettingsStatePending specifies that the bios setting update is waiting

BIOSSettingsStatus

(Appears on:BIOSSettings)

BIOSSettingsStatus defines the observed state of BIOSSettings.

Field	Description
state BIOSSettingsState	(Optional) State represents the current state of the bios configuration task.
flowState []BIOSSettingsFlowStatus
lastAppliedTime Kubernetes meta/v1.Time	(Optional) LastAppliedTime represents the timestamp when the last setting was successfully applied.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the BIOSSettings’s current state.

BIOSSettingsTemplate

(Appears on:BIOSSettingsSetSpec, BIOSSettingsSpec)

Field	Description
version string	Version contains software (eg: BIOS, BMC) version this settings applies to
settingsFlow []SettingsFlowItem	(Optional) SettingsFlow contains BIOS settings sequence to apply on the BIOS in given order
serverMaintenancePolicy ServerMaintenancePolicy	(Optional) ServerMaintenancePolicy is a maintenance policy to be enforced on the server.
serverMaintenanceRef Kubernetes core/v1.ObjectReference	(Optional) ServerMaintenanceRef is a reference to a ServerMaintenance object that BiosSetting has requested for the referred server.

BIOSVersion

BIOSVersion is the Schema for the biosversions API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BIOSVersionSpec	BIOSVersionTemplate BIOSVersionTemplate (Members of BIOSVersionTemplate are embedded into this type.) BIOSVersionTemplate defines the template for Version to be applied on the servers. serverRef Kubernetes core/v1.LocalObjectReference (Optional) ServerRef is a reference to a specific server to apply bios upgrade on.
status BIOSVersionStatus

BIOSVersionSet

BIOSVersionSet is the Schema for the biosversionsets API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BIOSVersionSetSpec	serverSelector Kubernetes meta/v1.LabelSelector ServerSelector specifies a label selector to identify the servers that are to be selected. biosVersionTemplate BIOSVersionTemplate BIOSVersionTemplate defines the template for the BIOSversion Resource to be applied to the servers.
status BIOSVersionSetStatus

BIOSVersionSetSpec

(Appears on:BIOSVersionSet)

BIOSVersionSetSpec defines the desired state of BIOSVersionSet.

Field	Description
serverSelector Kubernetes meta/v1.LabelSelector	ServerSelector specifies a label selector to identify the servers that are to be selected.
biosVersionTemplate BIOSVersionTemplate	BIOSVersionTemplate defines the template for the BIOSversion Resource to be applied to the servers.

BIOSVersionSetStatus

(Appears on:BIOSVersionSet)

BIOSVersionSetStatus defines the observed state of BIOSVersionSet.

Field	Description
fullyLabeledServers int32	FullyLabeledServers is the number of servers in the set.
availableBIOSVersion int32	AvailableBIOSVersion is the number of BIOSVersion created by the set.
pendingBIOSVersion int32	PendingBIOSVersion is the total number of pending BIOSVersion in the set.
inProgressBIOSVersion int32	InProgressBIOSVersion is the total number of BIOSVersion in the set that are currently in InProgress.
completedBIOSVersion int32	CompletedBIOSVersion is the total number of completed BIOSVersion in the set.
failedBIOSVersion int32	FailedBIOSVersion is the total number of failed BIOSVersion in the set.

BIOSVersionSpec

(Appears on:BIOSVersion)

BIOSVersionSpec defines the desired state of BIOSVersion.

Field	Description
BIOSVersionTemplate BIOSVersionTemplate	(Members of BIOSVersionTemplate are embedded into this type.) BIOSVersionTemplate defines the template for Version to be applied on the servers.
serverRef Kubernetes core/v1.LocalObjectReference	(Optional) ServerRef is a reference to a specific server to apply bios upgrade on.

BIOSVersionState (string alias)

(Appears on:BIOSVersionStatus)

Value	Description
"Completed"	BIOSVersionStateCompleted specifies that the bios upgrade maintenance has been completed.
"Failed"	BIOSVersionStateFailed specifies that the bios upgrade maintenance has failed.
"Processing"	BIOSVersionStateInProgress specifies that upgrading bios is in progress.
"Pending"	BIOSVersionStatePending specifies that the bios upgrade maintenance is waiting

BIOSVersionStatus

(Appears on:BIOSVersion)

BIOSVersionStatus defines the observed state of BIOSVersion.

Field	Description
state BIOSVersionState	(Optional) State represents the current state of the bios configuration task.
upgradeTask Task	(Optional) UpgradeTask contains the state of the Upgrade Task created by the BMC
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the Bios version upgrade state.

BIOSVersionTemplate

(Appears on:BIOSVersionSetSpec, BIOSVersionSpec)

Field	Description
version string	Version contains a BIOS version to upgrade to
updatePolicy UpdatePolicy	(Optional) UpdatePolicy An indication of whether the server’s upgrade service should bypass vendor update policies
image ImageSpec	details regarding the image to use to upgrade to given BIOS version
serverMaintenancePolicy ServerMaintenancePolicy	(Optional) ServerMaintenancePolicy is a maintenance policy to be enforced on the server.
serverMaintenanceRef Kubernetes core/v1.ObjectReference	(Optional) ServerMaintenanceRef is a reference to a ServerMaintenance object that that Controller has requested for the referred server.

BMC

BMC is the Schema for the bmcs API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BMCSpec	bmcUUID string (Optional) BMCUUID is the unique identifier for the BMC as defined in Redfish API. endpointRef Kubernetes core/v1.LocalObjectReference (Optional) EndpointRef is a reference to the Kubernetes object that contains the endpoint information for the BMC. This reference is typically used to locate the BMC endpoint within the cluster. access InlineEndpoint (Optional) Endpoint allows inline configuration of network access details for the BMC. Use this field if access settings like address are to be configured directly within the BMC resource. bmcSecretRef Kubernetes core/v1.LocalObjectReference BMCSecretRef is a reference to the Kubernetes Secret object that contains the credentials required to access the BMC. This secret includes sensitive information such as usernames and passwords. protocol Protocol Protocol specifies the protocol to be used for communicating with the BMC. It could be a standard protocol such as IPMI or Redfish. consoleProtocol ConsoleProtocol (Optional) ConsoleProtocol specifies the protocol to be used for console access to the BMC. This field is optional and can be omitted if console access is not required. bmcSettingsRef Kubernetes core/v1.LocalObjectReference (Optional) BMCSettingRef is a reference to a BMCSettings object that specifies the BMC configuration for this BMC.
status BMCStatus

BMCAccess

(Appears on:ServerSpec)

BMCAccess defines the access details for the BMC.

Field	Description
protocol Protocol	Protocol specifies the protocol to be used for communicating with the BMC.
address string	Address is the address of the BMC.
bmcSecretRef Kubernetes core/v1.LocalObjectReference	BMCSecretRef is a reference to the Kubernetes Secret object that contains the credentials required to access the BMC. This secret includes sensitive information such as usernames and passwords.

BMCPowerState (string alias)

(Appears on:BMCStatus)

BMCPowerState defines the possible power states for a BMC.

Value	Description
"Off"	OffPowerState the system is powered off, although some components may continue to have AUX power such as management controller.
"On"	OnPowerState the system is powered on.
"Paused"	PausedPowerState the system is paused.
"PoweringOff"	PoweringOffPowerState A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process.
"PoweringOn"	PoweringOnPowerState A temporary state between Off and On. This temporary state can be very short.

BMCSecret

BMCSecret is the Schema for the bmcsecrets API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field.
immutable bool	(Optional) Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
data map[string][]byte	(Optional) Data contains the secret data. Each key must consist of alphanumeric characters, ‘-’, ‘_’ or ‘.’. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
stringData map[string]string	(Optional) stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
type Kubernetes core/v1.SecretType	(Optional) Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

BMCSettings

BMCSettings is the Schema for the BMCSettings API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BMCSettingsSpec	version string Version defines the BMC firmware for which the settings should be applied. settings map[string]string (Optional) SettingsMap contains bmc settings as map BMCRef Kubernetes core/v1.LocalObjectReference (Optional) BMCRef is a reference to a specific BMC to apply setting to. serverMaintenancePolicy ServerMaintenancePolicy (Optional) ServerMaintenancePolicy is a maintenance policy to be applied on the server. serverMaintenanceRefs []ServerMaintenanceRefItem (Optional) ServerMaintenanceRefs are references to ServerMaintenance objects which are created by the controller for each server that needs to be updated with the BMC settings.
status BMCSettingsStatus

BMCSettingsSpec

(Appears on:BMCSettings)

BMCSettingsSpec defines the desired state of BMCSettings.

Field	Description
version string	Version defines the BMC firmware for which the settings should be applied.
settings map[string]string	(Optional) SettingsMap contains bmc settings as map
BMCRef Kubernetes core/v1.LocalObjectReference	(Optional) BMCRef is a reference to a specific BMC to apply setting to.
serverMaintenancePolicy ServerMaintenancePolicy	(Optional) ServerMaintenancePolicy is a maintenance policy to be applied on the server.
serverMaintenanceRefs []ServerMaintenanceRefItem	(Optional) ServerMaintenanceRefs are references to ServerMaintenance objects which are created by the controller for each server that needs to be updated with the BMC settings.

BMCSettingsState (string alias)

(Appears on:BMCSettingsStatus)

BMCSettingsState specifies the current state of the server maintenance.

Value	Description
"Applied"	BMCSettingsStateApplied specifies that the BMC maintenance has been completed.
"Failed"	BMCSettingsStateFailed specifies that the BMC maintenance has failed.
"InProgress"	BMCSettingsStateInProgress specifies that the BMC setting changes are in progress
"Pending"	BMCSettingsStatePending specifies that the BMC maintenance is waiting

BMCSettingsStatus

(Appears on:BMCSettings)

BMCSettingsStatus defines the observed state of BMCSettings.

Field	Description
state BMCSettingsState	(Optional) State represents the current state of the BMC configuration task.

BMCSpec

(Appears on:BMC)

BMCSpec defines the desired state of BMC

Field	Description
bmcUUID string	(Optional) BMCUUID is the unique identifier for the BMC as defined in Redfish API.
endpointRef Kubernetes core/v1.LocalObjectReference	(Optional) EndpointRef is a reference to the Kubernetes object that contains the endpoint information for the BMC. This reference is typically used to locate the BMC endpoint within the cluster.
access InlineEndpoint	(Optional) Endpoint allows inline configuration of network access details for the BMC. Use this field if access settings like address are to be configured directly within the BMC resource.
bmcSecretRef Kubernetes core/v1.LocalObjectReference	BMCSecretRef is a reference to the Kubernetes Secret object that contains the credentials required to access the BMC. This secret includes sensitive information such as usernames and passwords.
protocol Protocol	Protocol specifies the protocol to be used for communicating with the BMC. It could be a standard protocol such as IPMI or Redfish.
consoleProtocol ConsoleProtocol	(Optional) ConsoleProtocol specifies the protocol to be used for console access to the BMC. This field is optional and can be omitted if console access is not required.
bmcSettingsRef Kubernetes core/v1.LocalObjectReference	(Optional) BMCSettingRef is a reference to a BMCSettings object that specifies the BMC configuration for this BMC.

BMCState (string alias)

(Appears on:BMCStatus)

BMCState defines the possible states of a BMC.

Value	Description
"Enabled"	BMCStateEnabled indicates that the BMC is enabled and functioning correctly.
"Error"	BMCStateError indicates that there is an error with the BMC.

BMCStatus

(Appears on:BMC)

BMCStatus defines the observed state of BMC.

Field	Description
macAddress string	(Optional) MACAddress is the MAC address of the BMC. The format is validated using a regular expression pattern.
ip IP	(Optional) IP is the IP address of the BMC. The type is specified as string and is schemaless.
manufacturer string	(Optional) Manufacturer is the name of the BMC manufacturer.
model string	(Optional) Model is the model number or name of the BMC.
sku string	(Optional) SKU is the stock keeping unit identifier for the BMC.
serialNumber string	(Optional) SerialNumber is the serial number of the BMC.
firmwareVersion string	(Optional) FirmwareVersion is the version of the firmware currently running on the BMC.
state BMCState	(Optional) State represents the current state of the BMC.
powerState BMCPowerState	(Optional) PowerState represents the current power state of the BMC.
lastResetTime Kubernetes meta/v1.Time	(Optional) LastResetTime is the timestamp of the last reset operation performed on the BMC.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the BMC’s current state.

BMCVersion

BMCVersion is the Schema for the bmcversions API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BMCVersionSpec	BMCVersionTemplate BMCVersionTemplate (Members of BMCVersionTemplate are embedded into this type.) BMCVersionTemplate defines the template for BMC version to be applied on the server’s BMC. bmcRef Kubernetes core/v1.LocalObjectReference BMCRef is a reference to a specific BMC to apply BMC upgrade on.
status BMCVersionStatus

BMCVersionSet

BMCVersionSet is the Schema for the bmcversionsets API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BMCVersionSetSpec	bmcSelector Kubernetes meta/v1.LabelSelector BMCSelector specifies a label selector to identify the BMC that are to be selected. bmcVersionTemplate BMCVersionTemplate BMCVersionTemplate defines the template for the BMCversion Resource to be applied to the servers.
status BMCVersionSetStatus

BMCVersionSetSpec

(Appears on:BMCVersionSet)

BMCVersionSetSpec defines the desired state of BMCVersionSet.

Field	Description
bmcSelector Kubernetes meta/v1.LabelSelector	BMCSelector specifies a label selector to identify the BMC that are to be selected.
bmcVersionTemplate BMCVersionTemplate	BMCVersionTemplate defines the template for the BMCversion Resource to be applied to the servers.

BMCVersionSetStatus

(Appears on:BMCVersionSet)

BMCVersionSetStatus defines the observed state of BMCVersionSet.

Field	Description
fullyLabeledBMCs int32	FullyLabeledBMCs is the number of server in the set.
availableBMCVersion int32	AvailableBMCVersion is the number of BMCVersion current created by the set.
pendingBMCVersion int32	PendingBMCVersion is the total number of pending BMCVersion in the set.
inProgressBMCVersion int32	InProgressBMCVersion is the total number of BMCVersion in the set that are currently in InProgress.
completedBMCVersion int32	CompletedBMCVersion is the total number of completed BMCVersion in the set.
failedBMCVersion int32	FailedBMCVersion is the total number of failed BMCVersion in the set.

BMCVersionSpec

(Appears on:BMCVersion)

BMCVersionSpec defines the desired state of BMCVersion.

Field	Description
BMCVersionTemplate BMCVersionTemplate	(Members of BMCVersionTemplate are embedded into this type.) BMCVersionTemplate defines the template for BMC version to be applied on the server’s BMC.
bmcRef Kubernetes core/v1.LocalObjectReference	BMCRef is a reference to a specific BMC to apply BMC upgrade on.

BMCVersionState (string alias)

(Appears on:BMCVersionStatus)

Value	Description
"Completed"	BMCVersionStateCompleted specifies that the BMC upgrade maintenance has been completed.
"Failed"	BMCVersionStateFailed specifies that the BMC upgrade maintenance has failed.
"InProgress"	BMCVersionStateInProgress specifies that upgrading BMC is in progress.
"Pending"	BMCVersionStatePending specifies that the BMC upgrade maintenance is waiting

BMCVersionStatus

(Appears on:BMCVersion)

BMCVersionStatus defines the observed state of BMCVersion.

Field	Description
state BMCVersionState	State represents the current state of the BMC configuration task.
upgradeTask Task	UpgradeTask contains the state of the Upgrade Task created by the BMC
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the BMC version upgrade state.

BMCVersionTemplate

(Appears on:BMCVersionSetSpec, BMCVersionSpec)

Field	Description
version string	Version contains a BMC version to upgrade to
updatePolicy UpdatePolicy	(Optional) UpdatePolicy is an indication of whether the server’s upgrade service should bypass vendor update policies
image ImageSpec	details regarding the image to use to upgrade to given BMC version
serverMaintenancePolicy ServerMaintenancePolicy	(Optional) ServerMaintenancePolicy is a maintenance policy to be enforced on the server managed by referred BMC.
serverMaintenanceRefs []ServerMaintenanceRefItem	(Optional) ServerMaintenanceRefs are references to a ServerMaintenance objects that Controller has requested for the each of the related server.

BootOrder

(Appears on:ServerSpec)

BootOrder represents the boot order of the server.

Field	Description
name string	Name is the name of the boot device.
priority int	Priority is the priority of the boot device.
device string	Device is the device to boot from.

ConsoleProtocol

(Appears on:BMCSpec)

ConsoleProtocol defines the protocol and port used for console access to the BMC.

Field	Description
name ConsoleProtocolName	Name specifies the name of the console protocol. This could be a protocol such as “SSH”, “Telnet”, etc.
port int32	Port specifies the port number used for console access. This port is used by the specified console protocol to establish connections.

ConsoleProtocolName (string alias)

(Appears on:ConsoleProtocol)

ConsoleProtocolName defines the possible names for console protocols.

Value	Description
"IPMI"	ConsoleProtocolNameIPMI represents the IPMI console protocol.
"SSH"	ConsoleProtocolNameSSH represents the SSH console protocol.
"SSHLenovo"	ConsoleProtocolNameSSHLenovo represents the SSH console protocol specific to Lenovo hardware.

Endpoint

Endpoint is the Schema for the endpoints API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EndpointSpec	macAddress string (Optional) MACAddress is the MAC address of the endpoint. ip IP (Optional) IP is the IP address of the endpoint.
status EndpointStatus

EndpointSpec

(Appears on:Endpoint)

EndpointSpec defines the desired state of Endpoint

Field	Description
macAddress string	(Optional) MACAddress is the MAC address of the endpoint.
ip IP	(Optional) IP is the IP address of the endpoint.

EndpointStatus

(Appears on:Endpoint)

EndpointStatus defines the observed state of Endpoint

IP

(Appears on:BMCStatus, EndpointSpec, InlineEndpoint, NetworkInterface)

IP is an IP address.

Field	Description
- net/netip.Addr

IPPrefix

IPPrefix represents a network prefix.

Field	Description
- net/netip.Prefix

ImageSpec

(Appears on:BIOSVersionTemplate, BMCVersionTemplate)

Field	Description
secretRef Kubernetes core/v1.LocalObjectReference	(Optional) ImageSecretRef is a reference to the Kubernetes Secret (of type SecretTypeBasicAuth) object that contains the credentials to access the ImageURI. This secret includes sensitive information such as usernames and passwords.
transferProtocol string	(Optional) The network protocol that the server’s update service uses to retrieve ‘ImageURI’
URI string	The URI of the software image to update/install.”

IndicatorLED (string alias)

(Appears on:ServerSpec, ServerStatus)

IndicatorLED represents LED indicator states

Value	Description
"Blinking"	BlinkingIndicatorLED indicates the Indicator LED is blinking.
"Lit"	LitIndicatorLED indicates the Indicator LED is lit.
"Off"	OffIndicatorLED indicates the Indicator LED is off.
"Unknown"	UnknownIndicatorLED indicates the state of the Indicator LED cannot be determined.

InlineEndpoint

(Appears on:BMCSpec)

InlineEndpoint defines inline network access configuration for the BMC.

Field	Description
macAddress string	(Optional) MACAddress is the MAC address of the endpoint.
ip IP	(Optional) IP is the IP address of the BMC.

NetworkInterface

(Appears on:ServerStatus)

NetworkInterface defines the details of a network interface.

Field	Description
name string	Name is the name of the network interface.
ip IP	IP is the IP address assigned to the network interface. The type is specified as string and is schemaless.
macAddress string	MACAddress is the MAC address of the network interface.

Phase (string alias)

(Appears on:ServerClaimStatus)

Phase defines the possible phases of a ServerClaim.

Value	Description
"Bound"	PhaseBound indicates that the server claim is bound to a server.
"Unbound"	PhaseUnbound indicates that the server claim is not bound to any server.

Power (string alias)

(Appears on:ServerClaimSpec, ServerMaintenanceSpec, ServerSpec)

Power defines the possible power states for a device.

Value	Description
"Off"	PowerOff indicates that the device is powered off.
"On"	PowerOn indicates that the device is powered on.

Processor

(Appears on:ServerStatus)

Processor defines the details of a Processor.

Field	Description
id string	ID is the name of the Processor.
type string	(Optional) Type is the type of the Processor.
architecture string	(Optional) Architecture is the architecture of the Processor.
instructionSet string	(Optional) InstructionSet is the instruction set of the Processor.
manufacturer string	(Optional) Manufacturer is the manufacturer of the Processor.
model string	(Optional) Model is the model of the Processor.
maxSpeedMHz int32	(Optional) MaxSpeedMHz is the maximum speed of the Processor in MHz.
totalCores int32	(Optional) TotalCores is the total number of cores in the Processor.
totalThreads int32	(Optional) TotalThreads is the total number of threads in the Processor.

Protocol

(Appears on:BMCAccess, BMCSpec)

Protocol defines the protocol and port used for communicating with the BMC.

Field	Description
name ProtocolName	Name specifies the name of the protocol. This could be a protocol such as “IPMI”, “Redfish”, etc.
port int32	Port specifies the port number used for communication. This port is used by the specified protocol to establish connections.
scheme ProtocolScheme	Scheme specifies the scheme used for communication.

ProtocolName (string alias)

(Appears on:Protocol)

ProtocolName defines the possible names for protocols used for communicating with the BMC.

Value	Description
"IPMI"	ProtocolNameIPMI represents the IPMI protocol.
"Redfish"	ProtocolNameRedfish represents the Redfish protocol.
"SSH"	ProtocolNameSSH represents the SSH protocol.

ProtocolScheme (string alias)

(Appears on:Protocol)

ProtocolScheme is a string that contains the protocol scheme

Value	Description
"http"	HTTPProtocolScheme is the http protocol scheme
"https"	HTTPSProtocolScheme is the https protocol scheme

Server

Server is the Schema for the servers API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ServerSpec	uuid string UUID is the unique identifier for the server. Deprecated in favor of systemUUID. systemUUID string (Optional) SystemUUID is the unique identifier for the server. systemURI string SystemURI is the unique URI for the server resource in REDFISH API. power Power (Optional) Power specifies the desired power state of the server. indicatorLED IndicatorLED (Optional) IndicatorLED specifies the desired state of the server’s indicator LED. serverClaimRef Kubernetes core/v1.ObjectReference (Optional) ServerClaimRef is a reference to a ServerClaim object that claims this server. This field is optional and can be omitted if no claim is associated with this server. serverMaintenanceRef Kubernetes core/v1.ObjectReference (Optional) ServerMaintenanceRef is a reference to a ServerMaintenance object that maintains this server. bmcRef Kubernetes core/v1.LocalObjectReference (Optional) BMCRef is a reference to the BMC object associated with this server. This field is optional and can be omitted if no BMC is associated with this server. bmc BMCAccess (Optional) BMC contains the access details for the BMC. This field is optional and can be omitted if no BMC access is specified. bootConfigurationRef Kubernetes core/v1.ObjectReference (Optional) BootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server. This field is optional and can be omitted if no boot configuration is specified. maintenanceBootConfigurationRef Kubernetes core/v1.ObjectReference (Optional) MaintenanceBootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server during maintenance. This field is optional and can be omitted bootOrder []BootOrder (Optional) BootOrder specifies the boot order of the server. biosSettingsRef Kubernetes core/v1.LocalObjectReference (Optional) BIOSSettingsRef is a reference to a biossettings object that specifies the BIOS configuration for this server.
status ServerStatus

ServerBootConfiguration

ServerBootConfiguration is the Schema for the serverbootconfigurations API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ServerBootConfigurationSpec	serverRef Kubernetes core/v1.LocalObjectReference ServerRef is a reference to the server for which this boot configuration is intended. image string (Optional) Image specifies the boot image to be used for the server. This field is optional and can be omitted if not specified. ignitionSecretRef Kubernetes core/v1.LocalObjectReference (Optional) IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified.
status ServerBootConfigurationStatus

ServerBootConfigurationSpec

(Appears on:ServerBootConfiguration, ServerBootConfigurationTemplate)

ServerBootConfigurationSpec defines the desired state of ServerBootConfiguration.

Field	Description
serverRef Kubernetes core/v1.LocalObjectReference	ServerRef is a reference to the server for which this boot configuration is intended.
image string	(Optional) Image specifies the boot image to be used for the server. This field is optional and can be omitted if not specified.
ignitionSecretRef Kubernetes core/v1.LocalObjectReference	(Optional) IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified.

ServerBootConfigurationState (string alias)

(Appears on:ServerBootConfigurationStatus)

ServerBootConfigurationState defines the possible states of a ServerBootConfiguration.

Value	Description
"Error"	ServerBootConfigurationStateError indicates that there is an error with the boot configuration.
"Pending"	ServerBootConfigurationStatePending indicates that the boot configuration is pending and not yet ready.
"Ready"	ServerBootConfigurationStateReady indicates that the boot configuration is ready for use.

ServerBootConfigurationStatus

(Appears on:ServerBootConfiguration)

ServerBootConfigurationStatus defines the observed state of ServerBootConfiguration.

Field	Description
state ServerBootConfigurationState	(Optional) State represents the current state of the boot configuration.

ServerBootConfigurationTemplate

(Appears on:ServerMaintenanceSpec)

ServerBootConfigurationTemplate defines the parameters to be used for rendering a boot configuration.

Field	Description
name string	Name specifies the name of the boot configuration.
spec ServerBootConfigurationSpec	Parameters specify the parameters to be used for rendering the boot configuration. serverRef Kubernetes core/v1.LocalObjectReference ServerRef is a reference to the server for which this boot configuration is intended. image string (Optional) Image specifies the boot image to be used for the server. This field is optional and can be omitted if not specified. ignitionSecretRef Kubernetes core/v1.LocalObjectReference (Optional) IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified.

ServerClaim

ServerClaim is the Schema for the serverclaims API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ServerClaimSpec	power Power Power specifies the desired power state of the server. serverRef Kubernetes core/v1.LocalObjectReference (Optional) ServerRef is a reference to a specific server to be claimed. This field is optional and can be omitted if the server is to be selected using ServerSelector. serverSelector Kubernetes meta/v1.LabelSelector (Optional) ServerSelector specifies a label selector to identify the server to be claimed. This field is optional and can be omitted if a specific server is referenced using ServerRef. ignitionSecretRef Kubernetes core/v1.LocalObjectReference (Optional) IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified. image string Image specifies the boot image to be used for the server.
status ServerClaimStatus

ServerClaimSpec

(Appears on:ServerClaim)

ServerClaimSpec defines the desired state of ServerClaim.

Field	Description
power Power	Power specifies the desired power state of the server.
serverRef Kubernetes core/v1.LocalObjectReference	(Optional) ServerRef is a reference to a specific server to be claimed. This field is optional and can be omitted if the server is to be selected using ServerSelector.
serverSelector Kubernetes meta/v1.LabelSelector	(Optional) ServerSelector specifies a label selector to identify the server to be claimed. This field is optional and can be omitted if a specific server is referenced using ServerRef.
ignitionSecretRef Kubernetes core/v1.LocalObjectReference	(Optional) IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified.
image string	Image specifies the boot image to be used for the server.

ServerClaimStatus

(Appears on:ServerClaim)

ServerClaimStatus defines the observed state of ServerClaim.

Field	Description
phase Phase	(Optional) Phase represents the current phase of the server claim.

ServerMaintenance

ServerMaintenance is the Schema for the ServerMaintenance API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ServerMaintenanceSpec	policy ServerMaintenancePolicy (Optional) Policy specifies the maintenance policy to be enforced on the server. serverRef Kubernetes core/v1.LocalObjectReference ServerRef is a reference to the server that is to be maintained. serverPower Power (Optional) ServerPower specifies the power state of the server during maintenance. serverBootConfigurationTemplate ServerBootConfigurationTemplate (Optional) ServerBootConfigurationTemplate specifies the boot configuration to be applied to the server during maintenance.
status ServerMaintenanceStatus

ServerMaintenancePolicy (string alias)

(Appears on:BIOSSettingsTemplate, BIOSVersionTemplate, BMCSettingsSpec, BMCVersionTemplate, ServerMaintenanceSpec)

ServerMaintenancePolicy specifies the maintenance policy to be enforced on the server.

Value	Description
"Enforced"	ServerMaintenancePolicyEnforced specifies that the maintenance policy is enforced.
"OwnerApproval"	ServerMaintenancePolicyOwnerApproval specifies that the maintenance policy requires owner approval.

ServerMaintenanceRefItem

(Appears on:BMCSettingsSpec, BMCVersionTemplate)

ServerMaintenanceRefItem is a reference to a ServerMaintenance object.

Field	Description
serverMaintenanceRef Kubernetes core/v1.ObjectReference	(Optional) ServerMaintenanceRef is a reference to a ServerMaintenance object that the BMCSettings has requested for the referred server.

ServerMaintenanceSpec

(Appears on:ServerMaintenance)

ServerMaintenanceSpec defines the desired state of a ServerMaintenance

Field	Description
policy ServerMaintenancePolicy	(Optional) Policy specifies the maintenance policy to be enforced on the server.
serverRef Kubernetes core/v1.LocalObjectReference	ServerRef is a reference to the server that is to be maintained.
serverPower Power	(Optional) ServerPower specifies the power state of the server during maintenance.
serverBootConfigurationTemplate ServerBootConfigurationTemplate	(Optional) ServerBootConfigurationTemplate specifies the boot configuration to be applied to the server during maintenance.

ServerMaintenanceState (string alias)

(Appears on:ServerMaintenanceStatus)

ServerMaintenanceState specifies the current state of the server maintenance.

Value	Description
"Failed"	ServerMaintenanceStateFailed specifies that the server maintenance has failed.
"InMaintenance"	ServerMaintenanceStateInMaintenance specifies that the server is in maintenance.
"Pending"	ServerMaintenanceStatePending specifies that the server maintenance is pending.

ServerMaintenanceStatus

(Appears on:ServerMaintenance)

ServerMaintenanceStatus defines the observed state of a ServerMaintenance

Field	Description
state ServerMaintenanceState	State specifies the current state of the server maintenance.

ServerPowerState (string alias)

(Appears on:ServerStatus)

ServerPowerState defines the possible power states for a server.

Value	Description
"Off"	ServerOffPowerState indicates that the system is powered off, although some components may continue to have auxiliary power such as the management controller.
"On"	ServerOnPowerState indicates that the system is powered on.
"Paused"	ServerPausedPowerState indicates that the system is paused.
"PoweringOff"	ServerPoweringOffPowerState indicates a temporary state between On and Off. The power off action can take time while the OS is in the shutdown process.
"PoweringOn"	ServerPoweringOnPowerState indicates a temporary state between Off and On. This temporary state can be very short.

ServerSpec

(Appears on:Server)

ServerSpec defines the desired state of a Server.

Field	Description
uuid string	UUID is the unique identifier for the server. Deprecated in favor of systemUUID.
systemUUID string	(Optional) SystemUUID is the unique identifier for the server.
systemURI string	SystemURI is the unique URI for the server resource in REDFISH API.
power Power	(Optional) Power specifies the desired power state of the server.
indicatorLED IndicatorLED	(Optional) IndicatorLED specifies the desired state of the server’s indicator LED.
serverClaimRef Kubernetes core/v1.ObjectReference	(Optional) ServerClaimRef is a reference to a ServerClaim object that claims this server. This field is optional and can be omitted if no claim is associated with this server.
serverMaintenanceRef Kubernetes core/v1.ObjectReference	(Optional) ServerMaintenanceRef is a reference to a ServerMaintenance object that maintains this server.
bmcRef Kubernetes core/v1.LocalObjectReference	(Optional) BMCRef is a reference to the BMC object associated with this server. This field is optional and can be omitted if no BMC is associated with this server.
bmc BMCAccess	(Optional) BMC contains the access details for the BMC. This field is optional and can be omitted if no BMC access is specified.
bootConfigurationRef Kubernetes core/v1.ObjectReference	(Optional) BootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server. This field is optional and can be omitted if no boot configuration is specified.
maintenanceBootConfigurationRef Kubernetes core/v1.ObjectReference	(Optional) MaintenanceBootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server during maintenance. This field is optional and can be omitted
bootOrder []BootOrder	(Optional) BootOrder specifies the boot order of the server.
biosSettingsRef Kubernetes core/v1.LocalObjectReference	(Optional) BIOSSettingsRef is a reference to a biossettings object that specifies the BIOS configuration for this server.

ServerState (string alias)

(Appears on:ServerStatus)

ServerState defines the possible states of a server.

Value	Description
"Available"	ServerStateAvailable indicates that the server is available for use.
"Discovery"	ServerStateDiscovery indicates that the server is in its discovery state.
"Error"	ServerStateError indicates that there is an error with the server.
"Initial"	ServerStateInitial indicates that the server is in its initial state.
"Maintenance"	ServerStateMaintenance indicates that the server is in maintenance.
"Reserved"	ServerStateReserved indicates that the server is reserved for a specific use or user.

ServerStatus

(Appears on:Server)

ServerStatus defines the observed state of Server.

Field	Description
manufacturer string	(Optional) Manufacturer is the name of the server manufacturer.
biosVersion string	BIOSVersion is the version of the server’s BIOS.
model string	(Optional) Model is the model of the server.
sku string	(Optional) SKU is the stock keeping unit identifier for the server.
serialNumber string	(Optional) SerialNumber is the serial number of the server.
powerState ServerPowerState	(Optional) PowerState represents the current power state of the server.
indicatorLED IndicatorLED	(Optional) IndicatorLED specifies the current state of the server’s indicator LED.
state ServerState	(Optional) State represents the current state of the server.
networkInterfaces []NetworkInterface	(Optional) NetworkInterfaces is a list of network interfaces associated with the server.
totalSystemMemory k8s.io/apimachinery/pkg/api/resource.Quantity	(Optional) TotalSystemMemory is the total amount of memory in bytes available on the server.
processors []Processor	(Optional) Processors is a list of Processors associated with the server.
storages []Storage	(Optional) Storages is a list of storages associated with the server.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions represents the latest available observations of the server’s current state.

SettingsFlowItem

(Appears on:BIOSSettingsTemplate)

Field	Description
name string	Name identifies what this settings is doing
settings map[string]string	(Optional) Settings contains software (eg: BIOS, BMC) settings as map
priority int32	Priority defines the order of applying the settings any int greater than 0. lower number have higher Priority (ie; lower number is applied first)

Storage

(Appears on:ServerStatus)

Storage defines the details of one storage device

Field	Description
name string	(Optional) Name is the name of the storage interface.
state StorageState	(Optional) State specifies the state of the storage device.
volumes []StorageVolume	(Optional) Volumes is a collection of volumes associated with this storage.
drives []StorageDrive	(Optional) Drives is a collection of drives associated with this storage.

StorageDrive

(Appears on:Storage)

StorageDrive defines the details of one storage drive

Field	Description
name string	(Optional) Name is the name of the storage interface.
mediaType string	(Optional) MediaType specifies the media type of the storage device.
type string	(Optional) Type specifies the type of the storage device.
capacity k8s.io/apimachinery/pkg/api/resource.Quantity	(Optional) Capacity specifies the size of the storage device in bytes.
vendor string	(Optional) Vendor specifies the vendor of the storage device.
model string	(Optional) Model specifies the model of the storage device.
state StorageState	(Optional) State specifies the state of the storage device.

StorageState (string alias)

(Appears on:Storage, StorageDrive, StorageVolume)

StorageState represents Storage states

Value	Description
"Absent"	StorageStateAbsent indicates that the storage device is absent.
"Disabled"	StorageStateDisabled indicates that the storage device is disabled.
"Enabled"	StorageStateEnabled indicates that the storage device is enabled.

StorageVolume

(Appears on:Storage)

StorageVolume defines the details of one storage volume

Field	Description
name string	(Optional) Name is the name of the storage interface.
capacity k8s.io/apimachinery/pkg/api/resource.Quantity	(Optional) Capacity specifies the size of the storage device in bytes.
state StorageState	(Optional) Status specifies the status of the volume.
raidType string	(Optional) RAIDType specifies the RAID type of the associated Volume.
volumeUsage string	(Optional) VolumeUsage specifies the volume usage type for the Volume.

Task

(Appears on:BIOSVersionStatus, BMCVersionStatus)

Task contains the status of the task created by the BMC for the BIOS upgrade.

Field	Description
URI string	(Optional) URI is the URI of the task created by the BMC for the BIOS upgrade.
state github.com/stmcginnis/gofish/redfish.TaskState	(Optional) State is the current state of the task.
status github.com/stmcginnis/gofish/common.Health	(Optional) Status is the current status of the task.
percentageComplete int32	(Optional) PercentComplete is the percentage of completion of the task.

UpdatePolicy (string alias)

(Appears on:BIOSVersionTemplate, BMCVersionTemplate)

Value	Description
"Force"

---

Generated with gen-crd-api-reference-docs