Search

Chapter 6. HardwareData [metal3.io/v1alpha1]

download PDF
Description
HardwareData is the Schema for the hardwaredata API.
Type
object

6.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

HardwareDataSpec defines the desired state of HardwareData.

6.1.1. .spec

Description
HardwareDataSpec defines the desired state of HardwareData.
Type
object
PropertyTypeDescription

hardware

object

The hardware discovered on the host during its inspection.

6.1.2. .spec.hardware

Description
The hardware discovered on the host during its inspection.
Type
object
PropertyTypeDescription

cpu

object

CPU describes one processor on the host.

firmware

object

Firmware describes the firmware on the host.

hostname

string

 

nics

array

 

nics[]

object

NIC describes one network interface on the host.

ramMebibytes

integer

 

storage

array

 

storage[]

object

Storage describes one storage device (disk, SSD, etc.) on the host.

systemVendor

object

HardwareSystemVendor stores details about the whole hardware system.

6.1.3. .spec.hardware.cpu

Description
CPU describes one processor on the host.
Type
object
PropertyTypeDescription

arch

string

 

clockMegahertz

number

ClockSpeed is a clock speed in MHz

count

integer

 

flags

array (string)

 

model

string

 

6.1.4. .spec.hardware.firmware

Description
Firmware describes the firmware on the host.
Type
object
PropertyTypeDescription

bios

object

The BIOS for this firmware

6.1.5. .spec.hardware.firmware.bios

Description
The BIOS for this firmware
Type
object
PropertyTypeDescription

date

string

The release/build date for this BIOS

vendor

string

The vendor name for this BIOS

version

string

The version of the BIOS

6.1.6. .spec.hardware.nics

Description
Type
array

6.1.7. .spec.hardware.nics[]

Description
NIC describes one network interface on the host.
Type
object
PropertyTypeDescription

ip

string

The IP address of the interface. This will be an IPv4 or IPv6 address if one is present. If both IPv4 and IPv6 addresses are present in a dual-stack environment, two nics will be output, one with each IP.

mac

string

The device MAC address

model

string

The vendor and product IDs of the NIC, e.g. "0x8086 0x1572"

name

string

The name of the network interface, e.g. "en0"

pxe

boolean

Whether the NIC is PXE Bootable

speedGbps

integer

The speed of the device in Gigabits per second

vlanId

integer

The untagged VLAN ID

vlans

array

The VLANs available

vlans[]

object

VLAN represents the name and ID of a VLAN.

6.1.8. .spec.hardware.nics[].vlans

Description
The VLANs available
Type
array

6.1.9. .spec.hardware.nics[].vlans[]

Description
VLAN represents the name and ID of a VLAN.
Type
object
PropertyTypeDescription

id

integer

VLANID is a 12-bit 802.1Q VLAN identifier

name

string

 

6.1.10. .spec.hardware.storage

Description
Type
array

6.1.11. .spec.hardware.storage[]

Description
Storage describes one storage device (disk, SSD, etc.) on the host.
Type
object
PropertyTypeDescription

alternateNames

array (string)

A list of alternate Linux device names of the disk, e.g. "/dev/sda". Note that this list is not exhaustive, and names may not be stable across reboots.

hctl

string

The SCSI location of the device

model

string

Hardware model

name

string

A Linux device name of the disk, e.g. "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0". This will be a name that is stable across reboots if one is available.

rotational

boolean

Whether this disk represents rotational storage. This field is not recommended for usage, please prefer using 'Type' field instead, this field will be deprecated eventually.

serialNumber

string

The serial number of the device

sizeBytes

integer

The size of the disk in Bytes

type

string

Device type, one of: HDD, SSD, NVME.

vendor

string

The name of the vendor of the device

wwn

string

The WWN of the device

wwnVendorExtension

string

The WWN Vendor extension of the device

wwnWithExtension

string

The WWN with the extension

6.1.12. .spec.hardware.systemVendor

Description
HardwareSystemVendor stores details about the whole hardware system.
Type
object
PropertyTypeDescription

manufacturer

string

 

productName

string

 

serialNumber

string

 

6.2. API endpoints

The following API endpoints are available:

  • /apis/metal3.io/v1alpha1/hardwaredata

    • GET: list objects of kind HardwareData
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

    • DELETE: delete collection of HardwareData
    • GET: list objects of kind HardwareData
    • POST: create a HardwareData
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

    • DELETE: delete a HardwareData
    • GET: read the specified HardwareData
    • PATCH: partially update the specified HardwareData
    • PUT: replace the specified HardwareData

6.2.1. /apis/metal3.io/v1alpha1/hardwaredata

HTTP method
GET
Description
list objects of kind HardwareData
Table 6.1. HTTP responses
HTTP codeReponse body

200 - OK

HardwareDataList schema

401 - Unauthorized

Empty

6.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

HTTP method
DELETE
Description
delete collection of HardwareData
Table 6.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind HardwareData
Table 6.3. HTTP responses
HTTP codeReponse body

200 - OK

HardwareDataList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a HardwareData
Table 6.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.5. Body parameters
ParameterTypeDescription

body

HardwareData schema

 
Table 6.6. HTTP responses
HTTP codeReponse body

200 - OK

HardwareData schema

201 - Created

HardwareData schema

202 - Accepted

HardwareData schema

401 - Unauthorized

Empty

6.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

Table 6.7. Global path parameters
ParameterTypeDescription

name

string

name of the HardwareData

HTTP method
DELETE
Description
delete a HardwareData
Table 6.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 6.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified HardwareData
Table 6.10. HTTP responses
HTTP codeReponse body

200 - OK

HardwareData schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified HardwareData
Table 6.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.12. HTTP responses
HTTP codeReponse body

200 - OK

HardwareData schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified HardwareData
Table 6.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.14. Body parameters
ParameterTypeDescription

body

HardwareData schema

 
Table 6.15. HTTP responses
HTTP codeReponse body

200 - OK

HardwareData schema

201 - Created

HardwareData schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.