이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 9. HostUpdatePolicy [metal3.io/v1alpha1]


Description
HostUpdatePolicy is the Schema for the hostupdatepolicy API.
Type
object

9.1. Specification

Expand
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

HostUpdatePolicySpec defines the desired state of HostUpdatePolicy.

status

object

HostUpdatePolicyStatus defines the observed state of HostUpdatePolicy.

9.1.1. .spec

Description
HostUpdatePolicySpec defines the desired state of HostUpdatePolicy.
Type
object
Expand
PropertyTypeDescription

firmwareSettings

string

Defines policy for changing firmware settings

firmwareUpdates

string

Defines policy for updating firmware

9.1.2. .status

Description
HostUpdatePolicyStatus defines the observed state of HostUpdatePolicy.
Type
object

9.2. API endpoints

The following API endpoints are available:

  • /apis/metal3.io/v1alpha1/hostupdatepolicies

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

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

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

9.2.1. /apis/metal3.io/v1alpha1/hostupdatepolicies

HTTP method
GET
Description
list objects of kind HostUpdatePolicy
Expand
Table 9.1. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicyList schema

401 - Unauthorized

Empty

9.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies

HTTP method
DELETE
Description
delete collection of HostUpdatePolicy
Expand
Table 9.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind HostUpdatePolicy
Expand
Table 9.3. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicyList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a HostUpdatePolicy
Expand
Table 9.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.

Expand
Table 9.5. Body parameters
ParameterTypeDescription

body

HostUpdatePolicy schema

 
Expand
Table 9.6. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicy schema

201 - Created

HostUpdatePolicy schema

202 - Accepted

HostUpdatePolicy schema

401 - Unauthorized

Empty

9.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies/{name}

Expand
Table 9.7. Global path parameters
ParameterTypeDescription

name

string

name of the HostUpdatePolicy

HTTP method
DELETE
Description
delete a HostUpdatePolicy
Expand
Table 9.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

Expand
Table 9.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified HostUpdatePolicy
Expand
Table 9.10. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicy schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified HostUpdatePolicy
Expand
Table 9.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.

Expand
Table 9.12. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicy schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified HostUpdatePolicy
Expand
Table 9.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.

Expand
Table 9.14. Body parameters
ParameterTypeDescription

body

HostUpdatePolicy schema

 
Expand
Table 9.15. HTTP responses
HTTP codeReponse body

200 - OK

HostUpdatePolicy schema

201 - Created

HostUpdatePolicy schema

401 - Unauthorized

Empty

Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2026 Red Hat
맨 위로 이동