java.lang.Object
- io.fabric8.openshift.api.model.installer.baremetal.v1.Platform

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
```
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Platform
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
```
Platform stores all the global configuration that all machinesets use.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`Platform()`	No args constructor for use in serialization
Platform(List<String> additionalNTPServers, String apiVIP, List<String> apiVIPs, String bootstrapExternalStaticDNS, String bootstrapExternalStaticGateway, String bootstrapExternalStaticIP, String bootstrapOSImage, String bootstrapProvisioningIP, String clusterOSImage, String clusterProvisioningIP, MachinePool defaultMachinePlatform, String externalBridge, String externalMACAddress, List<Host> hosts, String ingressVIP, List<String> ingressVIPs, String libvirtURI, io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer loadBalancer, String provisioningBridge, Boolean provisioningDHCPExternal, String provisioningDHCPRange, String provisioningHostIP, String provisioningMACAddress, String provisioningNetwork, String provisioningNetworkCIDR, String provisioningNetworkInterface)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PlatformBuilder`	`edit()`
`List<String>`	`getAdditionalNTPServers()`	AdditionalNTPServers defines a list of additional NTP servers to use for provisioning
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getApiVIP()`	DeprecatedAPIVIP is the VIP to use for internal API communication Deprecated: Use APIVIPs
`List<String>`	`getApiVIPs()`	APIVIPs contains the VIP(s) to use for internal API communication.
`String`	`getBootstrapExternalStaticDNS()`	BootstrapExternalStaticDNS is the static network DNS of the bootstrap node.
`String`	`getBootstrapExternalStaticGateway()`	BootstrapExternalStaticGateway is the static network gateway of the bootstrap node.
`String`	`getBootstrapExternalStaticIP()`	BootstrapExternalStaticIP is the static IP address of the bootstrap node.
`String`	`getBootstrapOSImage()`	BootstrapOSImage is a URL to override the default OS image for the bootstrap node.
`String`	`getBootstrapProvisioningIP()`	BootstrapProvisioningIP is the IP used on the bootstrap VM to bring up provisioning services that are used to create the control-plane machines
`String`	`getClusterOSImage()`	ClusterOSImage is a URL to override the default OS image for cluster nodes.
`String`	`getClusterProvisioningIP()`	ClusterProvisioningIP is the IP on the dedicated provisioning network where the baremetal-operator pod runs provisioning services, and an http server to cache some downloaded content e.g RHCOS/IPA images
`MachinePool`	`getDefaultMachinePlatform()`	Platform stores all the global configuration that all machinesets use.
`String`	`getExternalBridge()`	External bridge is used for external communication.
`String`	`getExternalMACAddress()`	ExternalMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the external network.
`List<Host>`	`getHosts()`	Hosts is the information needed to create the objects in Ironic.
`String`	`getIngressVIP()`	DeprecatedIngressVIP is the VIP to use for ingress traffic Deprecated: Use IngressVIPs
`List<String>`	`getIngressVIPs()`	IngressVIPs contains the VIP(s) to use for ingress traffic.
`String`	`getLibvirtURI()`	LibvirtURI is the identifier for the libvirtd connection.
`io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer`	`getLoadBalancer()`	Platform stores all the global configuration that all machinesets use.
`String`	`getProvisioningBridge()`	Provisioning bridge is used for provisioning nodes, on the host that will run the bootstrap VM.
`Boolean`	`getProvisioningDHCPExternal()`	DeprecatedProvisioningDHCPExternal indicates that DHCP is provided by an external service.
`String`	`getProvisioningDHCPRange()`	ProvisioningDHCPRange is used to provide DHCP services to hosts for provisioning.
`String`	`getProvisioningHostIP()`	DeprecatedProvisioningHostIP is the deprecated version of clusterProvisioningIP.
`String`	`getProvisioningMACAddress()`	ProvisioningMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the provisioning network.
`String`	`getProvisioningNetwork()`	ProvisioningNetwork is used to indicate if we will have a provisioning network, and how it will be managed.
`String`	`getProvisioningNetworkCIDR()`	Platform stores all the global configuration that all machinesets use.
`String`	`getProvisioningNetworkInterface()`	ProvisioningNetworkInterface is the name of the network interface on a control plane baremetal host that is connected to the provisioning network.
`void`	`setAdditionalNTPServers(List<String> additionalNTPServers)`	AdditionalNTPServers defines a list of additional NTP servers to use for provisioning
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setApiVIP(String apiVIP)`	DeprecatedAPIVIP is the VIP to use for internal API communication Deprecated: Use APIVIPs
`void`	`setApiVIPs(List<String> apiVIPs)`	APIVIPs contains the VIP(s) to use for internal API communication.
`void`	`setBootstrapExternalStaticDNS(String bootstrapExternalStaticDNS)`	BootstrapExternalStaticDNS is the static network DNS of the bootstrap node.
`void`	`setBootstrapExternalStaticGateway(String bootstrapExternalStaticGateway)`	BootstrapExternalStaticGateway is the static network gateway of the bootstrap node.
`void`	`setBootstrapExternalStaticIP(String bootstrapExternalStaticIP)`	BootstrapExternalStaticIP is the static IP address of the bootstrap node.
`void`	`setBootstrapOSImage(String bootstrapOSImage)`	BootstrapOSImage is a URL to override the default OS image for the bootstrap node.
`void`	`setBootstrapProvisioningIP(String bootstrapProvisioningIP)`	BootstrapProvisioningIP is the IP used on the bootstrap VM to bring up provisioning services that are used to create the control-plane machines
`void`	`setClusterOSImage(String clusterOSImage)`	ClusterOSImage is a URL to override the default OS image for cluster nodes.
`void`	`setClusterProvisioningIP(String clusterProvisioningIP)`	ClusterProvisioningIP is the IP on the dedicated provisioning network where the baremetal-operator pod runs provisioning services, and an http server to cache some downloaded content e.g RHCOS/IPA images
`void`	`setDefaultMachinePlatform(MachinePool defaultMachinePlatform)`	Platform stores all the global configuration that all machinesets use.
`void`	`setExternalBridge(String externalBridge)`	External bridge is used for external communication.
`void`	`setExternalMACAddress(String externalMACAddress)`	ExternalMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the external network.
`void`	`setHosts(List<Host> hosts)`	Hosts is the information needed to create the objects in Ironic.
`void`	`setIngressVIP(String ingressVIP)`	DeprecatedIngressVIP is the VIP to use for ingress traffic Deprecated: Use IngressVIPs
`void`	`setIngressVIPs(List<String> ingressVIPs)`	IngressVIPs contains the VIP(s) to use for ingress traffic.
`void`	`setLibvirtURI(String libvirtURI)`	LibvirtURI is the identifier for the libvirtd connection.
`void`	`setLoadBalancer(io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer loadBalancer)`	Platform stores all the global configuration that all machinesets use.
`void`	`setProvisioningBridge(String provisioningBridge)`	Provisioning bridge is used for provisioning nodes, on the host that will run the bootstrap VM.
`void`	`setProvisioningDHCPExternal(Boolean provisioningDHCPExternal)`	DeprecatedProvisioningDHCPExternal indicates that DHCP is provided by an external service.
`void`	`setProvisioningDHCPRange(String provisioningDHCPRange)`	ProvisioningDHCPRange is used to provide DHCP services to hosts for provisioning.
`void`	`setProvisioningHostIP(String provisioningHostIP)`	DeprecatedProvisioningHostIP is the deprecated version of clusterProvisioningIP.
`void`	`setProvisioningMACAddress(String provisioningMACAddress)`	ProvisioningMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the provisioning network.
`void`	`setProvisioningNetwork(String provisioningNetwork)`	ProvisioningNetwork is used to indicate if we will have a provisioning network, and how it will be managed.
`void`	`setProvisioningNetworkCIDR(String provisioningNetworkCIDR)`	Platform stores all the global configuration that all machinesets use.
`void`	`setProvisioningNetworkInterface(String provisioningNetworkInterface)`	ProvisioningNetworkInterface is the name of the network interface on a control plane baremetal host that is connected to the provisioning network.
`PlatformBuilder`	`toBuilder()`

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

- Constructor Detail
  - Platform
```
public Platform()
```
    No args constructor for use in serialization
  - Platform
```
public Platform(List<String> additionalNTPServers,
                String apiVIP,
                List<String> apiVIPs,
                String bootstrapExternalStaticDNS,
                String bootstrapExternalStaticGateway,
                String bootstrapExternalStaticIP,
                String bootstrapOSImage,
                String bootstrapProvisioningIP,
                String clusterOSImage,
                String clusterProvisioningIP,
                MachinePool defaultMachinePlatform,
                String externalBridge,
                String externalMACAddress,
                List<Host> hosts,
                String ingressVIP,
                List<String> ingressVIPs,
                String libvirtURI,
                io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer loadBalancer,
                String provisioningBridge,
                Boolean provisioningDHCPExternal,
                String provisioningDHCPRange,
                String provisioningHostIP,
                String provisioningMACAddress,
                String provisioningNetwork,
                String provisioningNetworkCIDR,
                String provisioningNetworkInterface)
```
- Method Detail
  - getAdditionalNTPServers
```
public List<String> getAdditionalNTPServers()
```
    AdditionalNTPServers defines a list of additional NTP servers to use for provisioning
  - setAdditionalNTPServers
```
public void setAdditionalNTPServers(List<String> additionalNTPServers)
```
    AdditionalNTPServers defines a list of additional NTP servers to use for provisioning
  - getApiVIP
```
public String getApiVIP()
```
    DeprecatedAPIVIP is the VIP to use for internal API communication Deprecated: Use APIVIPs
  - setApiVIP
```
public void setApiVIP(String apiVIP)
```
    DeprecatedAPIVIP is the VIP to use for internal API communication Deprecated: Use APIVIPs
  - getApiVIPs
```
public List<String> getApiVIPs()
```
    APIVIPs contains the VIP(s) to use for internal API communication. In dual stack clusters it contains an IPv4 and IPv6 address, otherwise only one VIP
  - setApiVIPs
```
public void setApiVIPs(List<String> apiVIPs)
```
    APIVIPs contains the VIP(s) to use for internal API communication. In dual stack clusters it contains an IPv4 and IPv6 address, otherwise only one VIP
  - getBootstrapExternalStaticDNS
```
public String getBootstrapExternalStaticDNS()
```
    BootstrapExternalStaticDNS is the static network DNS of the bootstrap node. This can be useful in environments without a DHCP server.
  - setBootstrapExternalStaticDNS
```
public void setBootstrapExternalStaticDNS(String bootstrapExternalStaticDNS)
```
    BootstrapExternalStaticDNS is the static network DNS of the bootstrap node. This can be useful in environments without a DHCP server.
  - getBootstrapExternalStaticGateway
```
public String getBootstrapExternalStaticGateway()
```
    BootstrapExternalStaticGateway is the static network gateway of the bootstrap node. This can be useful in environments without a DHCP server.
  - setBootstrapExternalStaticGateway
```
public void setBootstrapExternalStaticGateway(String bootstrapExternalStaticGateway)
```
    BootstrapExternalStaticGateway is the static network gateway of the bootstrap node. This can be useful in environments without a DHCP server.
  - getBootstrapExternalStaticIP
```
public String getBootstrapExternalStaticIP()
```
    BootstrapExternalStaticIP is the static IP address of the bootstrap node. This can be useful in environments without a DHCP server.
  - setBootstrapExternalStaticIP
```
public void setBootstrapExternalStaticIP(String bootstrapExternalStaticIP)
```
    BootstrapExternalStaticIP is the static IP address of the bootstrap node. This can be useful in environments without a DHCP server.
  - getBootstrapOSImage
```
public String getBootstrapOSImage()
```
    BootstrapOSImage is a URL to override the default OS image for the bootstrap node. The URL must contain a sha256 hash of the image e.g https://mirror.example.com/images/qemu.qcow2.gz?sha256=a07bd...
  - setBootstrapOSImage
```
public void setBootstrapOSImage(String bootstrapOSImage)
```
    BootstrapOSImage is a URL to override the default OS image for the bootstrap node. The URL must contain a sha256 hash of the image e.g https://mirror.example.com/images/qemu.qcow2.gz?sha256=a07bd...
  - getBootstrapProvisioningIP
```
public String getBootstrapProvisioningIP()
```
    BootstrapProvisioningIP is the IP used on the bootstrap VM to bring up provisioning services that are used to create the control-plane machines
  - setBootstrapProvisioningIP
```
public void setBootstrapProvisioningIP(String bootstrapProvisioningIP)
```
    BootstrapProvisioningIP is the IP used on the bootstrap VM to bring up provisioning services that are used to create the control-plane machines
  - getClusterOSImage
```
public String getClusterOSImage()
```
    ClusterOSImage is a URL to override the default OS image for cluster nodes. The URL must contain a sha256 hash of the image e.g https://mirror.example.com/images/metal.qcow2.gz?sha256=3b5a8...
  - setClusterOSImage
```
public void setClusterOSImage(String clusterOSImage)
```
    ClusterOSImage is a URL to override the default OS image for cluster nodes. The URL must contain a sha256 hash of the image e.g https://mirror.example.com/images/metal.qcow2.gz?sha256=3b5a8...
  - getClusterProvisioningIP
```
public String getClusterProvisioningIP()
```
    ClusterProvisioningIP is the IP on the dedicated provisioning network where the baremetal-operator pod runs provisioning services, and an http server to cache some downloaded content e.g RHCOS/IPA images
  - setClusterProvisioningIP
```
public void setClusterProvisioningIP(String clusterProvisioningIP)
```
    ClusterProvisioningIP is the IP on the dedicated provisioning network where the baremetal-operator pod runs provisioning services, and an http server to cache some downloaded content e.g RHCOS/IPA images
  - getDefaultMachinePlatform
```
public MachinePool getDefaultMachinePlatform()
```
    Platform stores all the global configuration that all machinesets use.
  - setDefaultMachinePlatform
```
public void setDefaultMachinePlatform(MachinePool defaultMachinePlatform)
```
    Platform stores all the global configuration that all machinesets use.
  - getExternalBridge
```
public String getExternalBridge()
```
    External bridge is used for external communication.
  - setExternalBridge
```
public void setExternalBridge(String externalBridge)
```
    External bridge is used for external communication.
  - getExternalMACAddress
```
public String getExternalMACAddress()
```
    ExternalMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the external network. Consider using the QEMU vendor prefix `52:54:00`. If left blank, libvirt will generate one for you.
  - setExternalMACAddress
```
public void setExternalMACAddress(String externalMACAddress)
```
    ExternalMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the external network. Consider using the QEMU vendor prefix `52:54:00`. If left blank, libvirt will generate one for you.
  - getHosts
```
public List<Host> getHosts()
```
    Hosts is the information needed to create the objects in Ironic.
  - setHosts
```
public void setHosts(List<Host> hosts)
```
    Hosts is the information needed to create the objects in Ironic.
  - getIngressVIP
```
public String getIngressVIP()
```
    DeprecatedIngressVIP is the VIP to use for ingress traffic Deprecated: Use IngressVIPs
  - setIngressVIP
```
public void setIngressVIP(String ingressVIP)
```
    DeprecatedIngressVIP is the VIP to use for ingress traffic Deprecated: Use IngressVIPs
  - getIngressVIPs
```
public List<String> getIngressVIPs()
```
    IngressVIPs contains the VIP(s) to use for ingress traffic. In dual stack clusters it contains an IPv4 and IPv6 address, otherwise only one VIP
  - setIngressVIPs
```
public void setIngressVIPs(List<String> ingressVIPs)
```
    IngressVIPs contains the VIP(s) to use for ingress traffic. In dual stack clusters it contains an IPv4 and IPv6 address, otherwise only one VIP
  - getLibvirtURI
```
public String getLibvirtURI()
```
    LibvirtURI is the identifier for the libvirtd connection. It must be reachable from the host where the installer is run. Default is qemu:///system
  - setLibvirtURI
```
public void setLibvirtURI(String libvirtURI)
```
    LibvirtURI is the identifier for the libvirtd connection. It must be reachable from the host where the installer is run. Default is qemu:///system
  - getLoadBalancer
```
public io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer getLoadBalancer()
```
    Platform stores all the global configuration that all machinesets use.
  - setLoadBalancer
```
public void setLoadBalancer(io.fabric8.openshift.api.model.config.v1.BareMetalPlatformLoadBalancer loadBalancer)
```
    Platform stores all the global configuration that all machinesets use.
  - getProvisioningBridge
```
public String getProvisioningBridge()
```
    Provisioning bridge is used for provisioning nodes, on the host that will run the bootstrap VM.
  - setProvisioningBridge
```
public void setProvisioningBridge(String provisioningBridge)
```
    Provisioning bridge is used for provisioning nodes, on the host that will run the bootstrap VM.
  - getProvisioningDHCPExternal
```
public Boolean getProvisioningDHCPExternal()
```
    DeprecatedProvisioningDHCPExternal indicates that DHCP is provided by an external service. This parameter is replaced by ProvisioningNetwork being set to "Unmanaged".
  - setProvisioningDHCPExternal
```
public void setProvisioningDHCPExternal(Boolean provisioningDHCPExternal)
```
    DeprecatedProvisioningDHCPExternal indicates that DHCP is provided by an external service. This parameter is replaced by ProvisioningNetwork being set to "Unmanaged".
  - getProvisioningDHCPRange
```
public String getProvisioningDHCPRange()
```
    ProvisioningDHCPRange is used to provide DHCP services to hosts for provisioning.
  - setProvisioningDHCPRange
```
public void setProvisioningDHCPRange(String provisioningDHCPRange)
```
    ProvisioningDHCPRange is used to provide DHCP services to hosts for provisioning.
  - getProvisioningHostIP
```
public String getProvisioningHostIP()
```
    DeprecatedProvisioningHostIP is the deprecated version of clusterProvisioningIP. When the baremetal platform was initially added to the installer, the JSON field for ClusterProvisioningIP was incorrectly set to "provisioningHostIP." This field is here to allow backwards-compatibility.
  - setProvisioningHostIP
```
public void setProvisioningHostIP(String provisioningHostIP)
```
    DeprecatedProvisioningHostIP is the deprecated version of clusterProvisioningIP. When the baremetal platform was initially added to the installer, the JSON field for ClusterProvisioningIP was incorrectly set to "provisioningHostIP." This field is here to allow backwards-compatibility.
  - getProvisioningMACAddress
```
public String getProvisioningMACAddress()
```
    ProvisioningMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the provisioning network. Consider using the QEMU vendor prefix `52:54:00`. If left blank, libvirt will generate one for you.
  - setProvisioningMACAddress
```
public void setProvisioningMACAddress(String provisioningMACAddress)
```
    ProvisioningMACAddress is used to allow setting a static unicast MAC address for the bootstrap host on the provisioning network. Consider using the QEMU vendor prefix `52:54:00`. If left blank, libvirt will generate one for you.
  - getProvisioningNetwork
```
public String getProvisioningNetwork()
```
    ProvisioningNetwork is used to indicate if we will have a provisioning network, and how it will be managed.
  - setProvisioningNetwork
```
public void setProvisioningNetwork(String provisioningNetwork)
```
    ProvisioningNetwork is used to indicate if we will have a provisioning network, and how it will be managed.
  - getProvisioningNetworkCIDR
```
public String getProvisioningNetworkCIDR()
```
    Platform stores all the global configuration that all machinesets use.
  - setProvisioningNetworkCIDR
```
public void setProvisioningNetworkCIDR(String provisioningNetworkCIDR)
```
    Platform stores all the global configuration that all machinesets use.
  - getProvisioningNetworkInterface
```
public String getProvisioningNetworkInterface()
```
    ProvisioningNetworkInterface is the name of the network interface on a control plane baremetal host that is connected to the provisioning network.
  - setProvisioningNetworkInterface
```
public void setProvisioningNetworkInterface(String provisioningNetworkInterface)
```
    ProvisioningNetworkInterface is the name of the network interface on a control plane baremetal host that is connected to the provisioning network.
  - edit
```
public PlatformBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>
  - toBuilder
```
public PlatformBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class Platform

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Platform

Platform

Method Detail

getAdditionalNTPServers

setAdditionalNTPServers

getApiVIP

setApiVIP

getApiVIPs

setApiVIPs

getBootstrapExternalStaticDNS

setBootstrapExternalStaticDNS

getBootstrapExternalStaticGateway

setBootstrapExternalStaticGateway

getBootstrapExternalStaticIP

setBootstrapExternalStaticIP

getBootstrapOSImage

setBootstrapOSImage

getBootstrapProvisioningIP

setBootstrapProvisioningIP

getClusterOSImage

setClusterOSImage

getClusterProvisioningIP

setClusterProvisioningIP

getDefaultMachinePlatform

setDefaultMachinePlatform

getExternalBridge

setExternalBridge

getExternalMACAddress

setExternalMACAddress

getHosts

setHosts

getIngressVIP

setIngressVIP

getIngressVIPs

setIngressVIPs

getLibvirtURI

setLibvirtURI

getLoadBalancer

setLoadBalancer

getProvisioningBridge

setProvisioningBridge

getProvisioningDHCPExternal

setProvisioningDHCPExternal

getProvisioningDHCPRange

setProvisioningDHCPRange

getProvisioningHostIP

setProvisioningHostIP

getProvisioningMACAddress

setProvisioningMACAddress

getProvisioningNetwork

setProvisioningNetwork

getProvisioningNetworkCIDR

setProvisioningNetworkCIDR

getProvisioningNetworkInterface

setProvisioningNetworkInterface

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties