BareMetalMachineConfigurationData Class

  • java.lang.Object
    • com.azure.resourcemanager.networkcloud.models.BareMetalMachineConfigurationData

Implements

public final class BareMetalMachineConfigurationData
implements JsonSerializable<BareMetalMachineConfigurationData>

BareMetalMachineConfigurationData represents configuration for the bare metal machine.

Constructor Summary

Constructor Description
BareMetalMachineConfigurationData()

Creates an instance of BareMetalMachineConfigurationData class.

Method Summary

Modifier and Type Method and Description
String bmcConnectionString()

Get the bmcConnectionString property: The connection string for the baseboard management controller including IP address and protocol.

AdministrativeCredentials bmcCredentials()

Get the bmcCredentials property: The credentials of the baseboard management controller on this bare metal machine.

String bmcMacAddress()

Get the bmcMacAddress property: The MAC address of the BMC for this machine.

String bootMacAddress()

Get the bootMacAddress property: The MAC address associated with the PXE NIC card.

static BareMetalMachineConfigurationData fromJson(JsonReader jsonReader)

Reads an instance of BareMetalMachineConfigurationData from the JsonReader.

String machineDetails()

Get the machineDetails property: The free-form additional information about the machine, e.g.

String machineName()

Get the machineName property: The user-provided name for the bare metal machine created from this specification.

long rackSlot()

Get the rackSlot property: The slot the physical machine is in the rack based on the BOM configuration.

String serialNumber()

Get the serialNumber property: The serial number of the machine.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

BareMetalMachineConfigurationData withBmcCredentials(AdministrativeCredentials bmcCredentials)

Set the bmcCredentials property: The credentials of the baseboard management controller on this bare metal machine.

BareMetalMachineConfigurationData withBmcMacAddress(String bmcMacAddress)

Set the bmcMacAddress property: The MAC address of the BMC for this machine.

BareMetalMachineConfigurationData withBootMacAddress(String bootMacAddress)

Set the bootMacAddress property: The MAC address associated with the PXE NIC card.

BareMetalMachineConfigurationData withMachineDetails(String machineDetails)

Set the machineDetails property: The free-form additional information about the machine, e.g.

BareMetalMachineConfigurationData withMachineName(String machineName)

Set the machineName property: The user-provided name for the bare metal machine created from this specification.

BareMetalMachineConfigurationData withRackSlot(long rackSlot)

Set the rackSlot property: The slot the physical machine is in the rack based on the BOM configuration.

BareMetalMachineConfigurationData withSerialNumber(String serialNumber)

Set the serialNumber property: The serial number of the machine.

Methods inherited from java.lang.Object

Constructor Details

BareMetalMachineConfigurationData

public BareMetalMachineConfigurationData()

Creates an instance of BareMetalMachineConfigurationData class.

Method Details

bmcConnectionString

public String bmcConnectionString()

Get the bmcConnectionString property: The connection string for the baseboard management controller including IP address and protocol.

Returns:

the bmcConnectionString value.

bmcCredentials

public AdministrativeCredentials bmcCredentials()

Get the bmcCredentials property: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.

Returns:

the bmcCredentials value.

bmcMacAddress

public String bmcMacAddress()

Get the bmcMacAddress property: The MAC address of the BMC for this machine.

Returns:

the bmcMacAddress value.

bootMacAddress

public String bootMacAddress()

Get the bootMacAddress property: The MAC address associated with the PXE NIC card.

Returns:

the bootMacAddress value.

fromJson

public static BareMetalMachineConfigurationData fromJson(JsonReader jsonReader)

Reads an instance of BareMetalMachineConfigurationData from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BareMetalMachineConfigurationData if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

machineDetails

public String machineDetails()

Get the machineDetails property: The free-form additional information about the machine, e.g. an asset tag.

Returns:

the machineDetails value.

machineName

public String machineName()

Get the machineName property: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

Returns:

the machineName value.

rackSlot

public long rackSlot()

Get the rackSlot property: The slot the physical machine is in the rack based on the BOM configuration.

Returns:

the rackSlot value.

serialNumber

public String serialNumber()

Get the serialNumber property: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

Returns:

the serialNumber value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withBmcCredentials

public BareMetalMachineConfigurationData withBmcCredentials(AdministrativeCredentials bmcCredentials)

Set the bmcCredentials property: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.

Parameters:

bmcCredentials - the bmcCredentials value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withBmcMacAddress

public BareMetalMachineConfigurationData withBmcMacAddress(String bmcMacAddress)

Set the bmcMacAddress property: The MAC address of the BMC for this machine.

Parameters:

bmcMacAddress - the bmcMacAddress value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withBootMacAddress

public BareMetalMachineConfigurationData withBootMacAddress(String bootMacAddress)

Set the bootMacAddress property: The MAC address associated with the PXE NIC card.

Parameters:

bootMacAddress - the bootMacAddress value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withMachineDetails

public BareMetalMachineConfigurationData withMachineDetails(String machineDetails)

Set the machineDetails property: The free-form additional information about the machine, e.g. an asset tag.

Parameters:

machineDetails - the machineDetails value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withMachineName

public BareMetalMachineConfigurationData withMachineName(String machineName)

Set the machineName property: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

Parameters:

machineName - the machineName value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withRackSlot

public BareMetalMachineConfigurationData withRackSlot(long rackSlot)

Set the rackSlot property: The slot the physical machine is in the rack based on the BOM configuration.

Parameters:

rackSlot - the rackSlot value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

withSerialNumber

public BareMetalMachineConfigurationData withSerialNumber(String serialNumber)

Set the serialNumber property: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

Parameters:

serialNumber - the serialNumber value to set.

Returns:

the BareMetalMachineConfigurationData object itself.

Applies to