java.lang.Object
- io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1.BareMetalHostSpec

All Implemented Interfaces:: Editable<BareMetalHostSpecBuilder>, KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class BareMetalHostSpec
extends Object
implements Editable<BareMetalHostSpecBuilder>, KubernetesResource

BareMetalHostSpec defines the desired state of BareMetalHost.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`BareMetalHostSpec()`	No args constructor for use in serialization
BareMetalHostSpec(String architecture, String automatedCleaningMode, BMCDetails bmc, String bootMACAddress, String bootMode, ObjectReference consumerRef, CustomDeploy customDeploy, String description, Boolean disablePowerOff, Boolean externallyProvisioned, FirmwareConfig firmware, String hardwareProfile, Image image, String inspectionMode, SecretReference metaData, SecretReference networkData, Boolean online, String preprovisioningNetworkDataName, RAIDConfig raid, RootDeviceHints rootDeviceHints, List<Taint> taints, SecretReference userData)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BareMetalHostSpecBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getArchitecture()`	CPU architecture of the host, e.g.
`String`	`getAutomatedCleaningMode()`	When set to disabled, automated cleaning will be skipped during provisioning and deprovisioning.
`BMCDetails`	`getBmc()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`String`	`getBootMACAddress()`	The MAC address of the NIC used for provisioning the host.
`String`	`getBootMode()`	Select the method of initializing the hardware during boot.
`ObjectReference`	`getConsumerRef()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`CustomDeploy`	`getCustomDeploy()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`String`	`getDescription()`	Description is a human-entered text used to help identify the host.
`Boolean`	`getDisablePowerOff()`	When set to true, power off of the node will be disabled, instead, a reboot will be used in place of power on/off
`Boolean`	`getExternallyProvisioned()`	ExternallyProvisioned means something else has provisioned the image running on the host, and the operator should only manage the power status.
`FirmwareConfig`	`getFirmware()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`String`	`getHardwareProfile()`	What is the name of the hardware profile for this host?
`Image`	`getImage()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`String`	`getInspectionMode()`	Specifies the mode for host inspection.
`SecretReference`	`getMetaData()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`SecretReference`	`getNetworkData()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`Boolean`	`getOnline()`	Should the host be powered on?
`String`	`getPreprovisioningNetworkDataName()`	PreprovisioningNetworkDataName is the name of the Secret in the local namespace containing network configuration which is passed to the preprovisioning image, and to the Config Drive if not overridden by specifying NetworkData.
`RAIDConfig`	`getRaid()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`RootDeviceHints`	`getRootDeviceHints()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`List<Taint>`	`getTaints()`	Taints is the full, authoritative list of taints to apply to the corresponding Machine.
`SecretReference`	`getUserData()`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setArchitecture(String architecture)`	CPU architecture of the host, e.g.
`void`	`setAutomatedCleaningMode(String automatedCleaningMode)`	When set to disabled, automated cleaning will be skipped during provisioning and deprovisioning.
`void`	`setBmc(BMCDetails bmc)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setBootMACAddress(String bootMACAddress)`	The MAC address of the NIC used for provisioning the host.
`void`	`setBootMode(String bootMode)`	Select the method of initializing the hardware during boot.
`void`	`setConsumerRef(ObjectReference consumerRef)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setCustomDeploy(CustomDeploy customDeploy)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setDescription(String description)`	Description is a human-entered text used to help identify the host.
`void`	`setDisablePowerOff(Boolean disablePowerOff)`	When set to true, power off of the node will be disabled, instead, a reboot will be used in place of power on/off
`void`	`setExternallyProvisioned(Boolean externallyProvisioned)`	ExternallyProvisioned means something else has provisioned the image running on the host, and the operator should only manage the power status.
`void`	`setFirmware(FirmwareConfig firmware)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setHardwareProfile(String hardwareProfile)`	What is the name of the hardware profile for this host?
`void`	`setImage(Image image)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setInspectionMode(String inspectionMode)`	Specifies the mode for host inspection.
`void`	`setMetaData(SecretReference metaData)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setNetworkData(SecretReference networkData)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setOnline(Boolean online)`	Should the host be powered on?
`void`	`setPreprovisioningNetworkDataName(String preprovisioningNetworkDataName)`	PreprovisioningNetworkDataName is the name of the Secret in the local namespace containing network configuration which is passed to the preprovisioning image, and to the Config Drive if not overridden by specifying NetworkData.
`void`	`setRaid(RAIDConfig raid)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setRootDeviceHints(RootDeviceHints rootDeviceHints)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`void`	`setTaints(List<Taint> taints)`	Taints is the full, authoritative list of taints to apply to the corresponding Machine.
`void`	`setUserData(SecretReference userData)`	BareMetalHostSpec defines the desired state of BareMetalHost.
`BareMetalHostSpecBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BareMetalHostSpec
```
public BareMetalHostSpec()
```
    No args constructor for use in serialization
  - BareMetalHostSpec
```
public BareMetalHostSpec(String architecture,
                         String automatedCleaningMode,
                         BMCDetails bmc,
                         String bootMACAddress,
                         String bootMode,
                         ObjectReference consumerRef,
                         CustomDeploy customDeploy,
                         String description,
                         Boolean disablePowerOff,
                         Boolean externallyProvisioned,
                         FirmwareConfig firmware,
                         String hardwareProfile,
                         Image image,
                         String inspectionMode,
                         SecretReference metaData,
                         SecretReference networkData,
                         Boolean online,
                         String preprovisioningNetworkDataName,
                         RAIDConfig raid,
                         RootDeviceHints rootDeviceHints,
                         List<Taint> taints,
                         SecretReference userData)
```
- Method Detail
  - getArchitecture
```
public String getArchitecture()
```
    CPU architecture of the host, e.g. "x86_64" or "aarch64". If unset, eventually populated by inspection.
  - setArchitecture
```
public void setArchitecture(String architecture)
```
    CPU architecture of the host, e.g. "x86_64" or "aarch64". If unset, eventually populated by inspection.
  - getAutomatedCleaningMode
```
public String getAutomatedCleaningMode()
```
    When set to disabled, automated cleaning will be skipped during provisioning and deprovisioning.
  - setAutomatedCleaningMode
```
public void setAutomatedCleaningMode(String automatedCleaningMode)
```
    When set to disabled, automated cleaning will be skipped during provisioning and deprovisioning.
  - getBmc
```
public BMCDetails getBmc()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setBmc
```
public void setBmc(BMCDetails bmc)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getBootMACAddress
```
public String getBootMACAddress()
```
    The MAC address of the NIC used for provisioning the host. In case of network boot, this is the MAC address of the PXE booting interface. The MAC address of the BMC must never be used here!
  - setBootMACAddress
```
public void setBootMACAddress(String bootMACAddress)
```
    The MAC address of the NIC used for provisioning the host. In case of network boot, this is the MAC address of the PXE booting interface. The MAC address of the BMC must never be used here!
  - getBootMode
```
public String getBootMode()
```
    Select the method of initializing the hardware during boot. Defaults to UEFI. Legacy boot should only be used for hardware that does not support UEFI correctly. Set to UEFISecureBoot to turn secure boot on automatically after provisioning.
  - setBootMode
```
public void setBootMode(String bootMode)
```
    Select the method of initializing the hardware during boot. Defaults to UEFI. Legacy boot should only be used for hardware that does not support UEFI correctly. Set to UEFISecureBoot to turn secure boot on automatically after provisioning.
  - getConsumerRef
```
public ObjectReference getConsumerRef()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setConsumerRef
```
public void setConsumerRef(ObjectReference consumerRef)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getCustomDeploy
```
public CustomDeploy getCustomDeploy()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setCustomDeploy
```
public void setCustomDeploy(CustomDeploy customDeploy)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getDescription
```
public String getDescription()
```
    Description is a human-entered text used to help identify the host.
  - setDescription
```
public void setDescription(String description)
```
    Description is a human-entered text used to help identify the host.
  - getDisablePowerOff
```
public Boolean getDisablePowerOff()
```
    When set to true, power off of the node will be disabled, instead, a reboot will be used in place of power on/off
  - setDisablePowerOff
```
public void setDisablePowerOff(Boolean disablePowerOff)
```
    When set to true, power off of the node will be disabled, instead, a reboot will be used in place of power on/off
  - getExternallyProvisioned
```
public Boolean getExternallyProvisioned()
```
    ExternallyProvisioned means something else has provisioned the image running on the host, and the operator should only manage the power status. This field is used for integration with already provisioned hosts and when pivoting hosts between clusters.
    
    This field can be set to true either: 1. During initial host creation (e.g., for pre-provisioned hosts) 2. After inspection completes when the host reaches Available state
    
    When used in environments with Cluster API Provider Metal3 (CAPM3), ensure hosts are labeled appropriately so CAPM3's host selector can distinguish them from CAPM3-managed hosts. If unsure, leave this field as false.
  - setExternallyProvisioned
```
public void setExternallyProvisioned(Boolean externallyProvisioned)
```
    ExternallyProvisioned means something else has provisioned the image running on the host, and the operator should only manage the power status. This field is used for integration with already provisioned hosts and when pivoting hosts between clusters.
    
    This field can be set to true either: 1. During initial host creation (e.g., for pre-provisioned hosts) 2. After inspection completes when the host reaches Available state
    
    When used in environments with Cluster API Provider Metal3 (CAPM3), ensure hosts are labeled appropriately so CAPM3's host selector can distinguish them from CAPM3-managed hosts. If unsure, leave this field as false.
  - getFirmware
```
public FirmwareConfig getFirmware()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setFirmware
```
public void setFirmware(FirmwareConfig firmware)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getHardwareProfile
```
public String getHardwareProfile()
```
    What is the name of the hardware profile for this host? Hardware profiles are deprecated and should not be used. Use the separate fields Architecture and RootDeviceHints instead. Set to "empty" to prepare for the future version of the API without hardware profiles.
  - setHardwareProfile
```
public void setHardwareProfile(String hardwareProfile)
```
    What is the name of the hardware profile for this host? Hardware profiles are deprecated and should not be used. Use the separate fields Architecture and RootDeviceHints instead. Set to "empty" to prepare for the future version of the API without hardware profiles.
  - getImage
```
public Image getImage()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setImage
```
public void setImage(Image image)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getInspectionMode
```
public String getInspectionMode()
```
    Specifies the mode for host inspection. "disabled" - no inspection will be performed "agent" - normal agent-based inspection will run
  - setInspectionMode
```
public void setInspectionMode(String inspectionMode)
```
    Specifies the mode for host inspection. "disabled" - no inspection will be performed "agent" - normal agent-based inspection will run
  - getMetaData
```
public SecretReference getMetaData()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setMetaData
```
public void setMetaData(SecretReference metaData)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getNetworkData
```
public SecretReference getNetworkData()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setNetworkData
```
public void setNetworkData(SecretReference networkData)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getOnline
```
public Boolean getOnline()
```
    Should the host be powered on? If the host is currently in a stable state (e.g. provisioned), its power state will be forced to match this value.
  - setOnline
```
public void setOnline(Boolean online)
```
    Should the host be powered on? If the host is currently in a stable state (e.g. provisioned), its power state will be forced to match this value.
  - getPreprovisioningNetworkDataName
```
public String getPreprovisioningNetworkDataName()
```
    PreprovisioningNetworkDataName is the name of the Secret in the local namespace containing network configuration which is passed to the preprovisioning image, and to the Config Drive if not overridden by specifying NetworkData.
  - setPreprovisioningNetworkDataName
```
public void setPreprovisioningNetworkDataName(String preprovisioningNetworkDataName)
```
    PreprovisioningNetworkDataName is the name of the Secret in the local namespace containing network configuration which is passed to the preprovisioning image, and to the Config Drive if not overridden by specifying NetworkData.
  - getRaid
```
public RAIDConfig getRaid()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setRaid
```
public void setRaid(RAIDConfig raid)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getRootDeviceHints
```
public RootDeviceHints getRootDeviceHints()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setRootDeviceHints
```
public void setRootDeviceHints(RootDeviceHints rootDeviceHints)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - getTaints
```
public List<Taint> getTaints()
```
    Taints is the full, authoritative list of taints to apply to the corresponding Machine. This list will overwrite any modifications made to the Machine on an ongoing basis.
  - setTaints
```
public void setTaints(List<Taint> taints)
```
    Taints is the full, authoritative list of taints to apply to the corresponding Machine. This list will overwrite any modifications made to the Machine on an ongoing basis.
  - getUserData
```
public SecretReference getUserData()
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - setUserData
```
public void setUserData(SecretReference userData)
```
    BareMetalHostSpec defines the desired state of BareMetalHost.
  - edit
```
public BareMetalHostSpecBuilder edit()
```
    Specified by:
    
    edit in interface Editable<BareMetalHostSpecBuilder>
  - toBuilder
```
public BareMetalHostSpecBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class BareMetalHostSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BareMetalHostSpec

BareMetalHostSpec

Method Detail

getArchitecture

setArchitecture

getAutomatedCleaningMode

setAutomatedCleaningMode

getBmc

setBmc

getBootMACAddress

setBootMACAddress

getBootMode

setBootMode

getConsumerRef

setConsumerRef

getCustomDeploy

setCustomDeploy

getDescription

setDescription

getDisablePowerOff

setDisablePowerOff

getExternallyProvisioned

setExternallyProvisioned

getFirmware

setFirmware

getHardwareProfile

setHardwareProfile

getImage

setImage

getInspectionMode

setInspectionMode

getMetaData

setMetaData

getNetworkData

setNetworkData

getOnline

setOnline

getPreprovisioningNetworkDataName

setPreprovisioningNetworkDataName

getRaid

setRaid

getRootDeviceHints

setRootDeviceHints

getTaints

setTaints

getUserData

setUserData

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties