Package io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1

Class BareMetalHostSpec

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<BareMetalHostSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class BareMetalHostSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<BareMetalHostSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    BareMetalHostSpec defines the desired state of BareMetalHost.
    See Also:
    Serialized Form

    • 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,
                         io.fabric8.kubernetes.api.model.ObjectReference consumerRef,
                         CustomDeploy customDeploy,
                         String description,
                         Boolean externallyProvisioned,
                         FirmwareConfig firmware,
                         String hardwareProfile,
                         Image image,
                         io.fabric8.kubernetes.api.model.SecretReference metaData,
                         io.fabric8.kubernetes.api.model.SecretReference networkData,
                         Boolean online,
                         String preprovisioningNetworkDataName,
                         RAIDConfig raid,
                         RootDeviceHints rootDeviceHints,
                         List<io.fabric8.kubernetes.api.model.Taint> taints,
                         io.fabric8.kubernetes.api.model.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 io.fabric8.kubernetes.api.model.ObjectReference getConsumerRef()
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • setConsumerRef

        public void setConsumerRef​(io.fabric8.kubernetes.api.model.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.

      • 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. 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. 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.

      • getMetaData

        public io.fabric8.kubernetes.api.model.SecretReference getMetaData()
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • setMetaData

        public void setMetaData​(io.fabric8.kubernetes.api.model.SecretReference metaData)
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • getNetworkData

        public io.fabric8.kubernetes.api.model.SecretReference getNetworkData()
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • setNetworkData

        public void setNetworkData​(io.fabric8.kubernetes.api.model.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<io.fabric8.kubernetes.api.model.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<io.fabric8.kubernetes.api.model.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 io.fabric8.kubernetes.api.model.SecretReference getUserData()
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • setUserData

        public void setUserData​(io.fabric8.kubernetes.api.model.SecretReference userData)
        BareMetalHostSpec defines the desired state of BareMetalHost.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)