This is a cache of https://docs.okd.io/latest/rest_api/provisioning_apis/hostfirmwarecomponents-metal3-io-v1alpha1.html. It is a snapshot of the page at 2024-11-23T19:54:05.237+0000.
HostFirmwareComponents [metal3.io/v1alpha1] - Provisioning <strong>api</strong>s | <strong>api</strong> reference | OKD 4
×

Specification

Property Type Description

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

HostFirmwareComponentsSpec defines the desired state of HostFirmwareComponents.

status

object

HostFirmwareComponentsStatus defines the observed state of HostFirmwareComponents.

.spec

Description

HostFirmwareComponentsSpec defines the desired state of HostFirmwareComponents.

Type

object

Required
  • updates

Property Type Description

updates

array

updates[]

object

FirmwareUpdate defines a firmware update specification.

.spec.updates

Description
Type

array

.spec.updates[]

Description

FirmwareUpdate defines a firmware update specification.

Type

object

Required
  • component

  • url

Property Type Description

component

string

url

string

.status

Description

HostFirmwareComponentsStatus defines the observed state of HostFirmwareComponents.

Type

object

Property Type Description

components

array

Components is the list of all available firmware components and their information.

components[]

object

FirmwareComponentStatus defines the status of a firmware component.

conditions

array

Track whether updates stored in the spec are valid based on the schema

conditions[]

object

Condition contains details for one aspect of the current state of this api Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

lastUpdated

string

Time that the status was last updated

updates

array

Updates is the list of all firmware components that should be updated they are specified via name and url fields.

updates[]

object

FirmwareUpdate defines a firmware update specification.

.status.components

Description

Components is the list of all available firmware components and their information.

Type

array

.status.components[]

Description

FirmwareComponentStatus defines the status of a firmware component.

Type

object

Required
  • component

  • initialVersion

Property Type Description

component

string

currentVersion

string

initialVersion

string

lastVersionFlashed

string

updatedAt

string

.status.conditions

Description

Track whether updates stored in the spec are valid based on the schema

Type

array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this api Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Type

object

Required
  • lastTransitionTime

  • message

  • reason

  • status

  • type

Property Type Description

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the api field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed api. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.updates

Description

Updates is the list of all firmware components that should be updated they are specified via name and url fields.

Type

array

.status.updates[]

Description

FirmwareUpdate defines a firmware update specification.

Type

object

Required
  • component

  • url

Property Type Description

component

string

url

string

api endpoints

The following api endpoints are available:

  • /apis/metal3.io/v1alpha1/hostfirmwarecomponents

    • GET: list objects of kind HostFirmwareComponents

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

    • DELETE: delete collection of HostFirmwareComponents

    • GET: list objects of kind HostFirmwareComponents

    • POST: create HostFirmwareComponents

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

    • DELETE: delete HostFirmwareComponents

    • GET: read the specified HostFirmwareComponents

    • PATCH: partially update the specified HostFirmwareComponents

    • PUT: replace the specified HostFirmwareComponents

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

    • GET: read status of the specified HostFirmwareComponents

    • PATCH: partially update status of the specified HostFirmwareComponents

    • PUT: replace status of the specified HostFirmwareComponents

/apis/metal3.io/v1alpha1/hostfirmwarecomponents

HTTP method

GET

Description

list objects of kind HostFirmwareComponents

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponentsList schema

401 - Unauthorized

Empty

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

HTTP method

DELETE

Description

delete collection of HostFirmwareComponents

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind HostFirmwareComponents

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponentsList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create HostFirmwareComponents

Table 4. Query parameters
Parameter Type Description

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 5. Body parameters
Parameter Type Description

body

HostFirmwareComponents schema

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

201 - Created

HostFirmwareComponents schema

202 - Accepted

HostFirmwareComponents schema

401 - Unauthorized

Empty

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the HostFirmwareComponents

HTTP method

DELETE

Description

delete HostFirmwareComponents

Table 8. Query parameters
Parameter Type Description

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 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified HostFirmwareComponents

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified HostFirmwareComponents

Table 11. Query parameters
Parameter Type Description

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 12. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified HostFirmwareComponents

Table 13. Query parameters
Parameter Type Description

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 14. Body parameters
Parameter Type Description

body

HostFirmwareComponents schema

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

201 - Created

HostFirmwareComponents schema

401 - Unauthorized

Empty

/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the HostFirmwareComponents

HTTP method

GET

Description

read status of the specified HostFirmwareComponents

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified HostFirmwareComponents

Table 18. Query parameters
Parameter Type Description

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 19. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified HostFirmwareComponents

Table 20. Query parameters
Parameter Type Description

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 21. Body parameters
Parameter Type Description

body

HostFirmwareComponents schema

Table 22. HTTP responses
HTTP code Reponse body

200 - OK

HostFirmwareComponents schema

201 - Created

HostFirmwareComponents schema

401 - Unauthorized

Empty