mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
344 lines
11 KiB
Plaintext
344 lines
11 KiB
Plaintext
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
|
|
:_mod-docs-content-type: ASSEMBLY
|
|
[id="hostupdatepolicy-metal3-io-v1alpha1"]
|
|
= HostUpdatePolicy [metal3.io/v1alpha1]
|
|
:toc: macro
|
|
:toc-title:
|
|
|
|
toc::[]
|
|
|
|
|
|
Description::
|
|
+
|
|
--
|
|
HostUpdatePolicy is the Schema for the hostupdatepolicy API.
|
|
--
|
|
|
|
Type::
|
|
`object`
|
|
|
|
|
|
|
|
== Specification
|
|
|
|
[cols="1,1,1",options="header"]
|
|
|===
|
|
| 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`
|
|
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`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.
|
|
|
|
|===
|
|
=== .spec
|
|
Description::
|
|
+
|
|
--
|
|
HostUpdatePolicySpec defines the desired state of HostUpdatePolicy.
|
|
--
|
|
|
|
Type::
|
|
`object`
|
|
|
|
|
|
|
|
|
|
[cols="1,1,1",options="header"]
|
|
|===
|
|
| Property | Type | Description
|
|
|
|
| `firmwareSettings`
|
|
| `string`
|
|
| Defines policy for changing firmware settings
|
|
|
|
| `firmwareUpdates`
|
|
| `string`
|
|
| Defines policy for updating firmware
|
|
|
|
|===
|
|
=== .status
|
|
Description::
|
|
+
|
|
--
|
|
HostUpdatePolicyStatus defines the observed state of HostUpdatePolicy.
|
|
--
|
|
|
|
Type::
|
|
`object`
|
|
|
|
|
|
|
|
|
|
|
|
== 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
|
|
|
|
|
|
=== /apis/metal3.io/v1alpha1/hostupdatepolicies
|
|
|
|
|
|
|
|
HTTP method::
|
|
`GET`
|
|
|
|
Description::
|
|
list objects of kind HostUpdatePolicy
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../objects/index.adoc#io-metal3-v1alpha1-HostUpdatePolicyList[`HostUpdatePolicyList`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
|
|
=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies
|
|
|
|
|
|
|
|
HTTP method::
|
|
`DELETE`
|
|
|
|
Description::
|
|
delete collection of HostUpdatePolicy
|
|
|
|
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
HTTP method::
|
|
`GET`
|
|
|
|
Description::
|
|
list objects of kind HostUpdatePolicy
|
|
|
|
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../objects/index.adoc#io-metal3-v1alpha1-HostUpdatePolicyList[`HostUpdatePolicyList`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
HTTP method::
|
|
`POST`
|
|
|
|
Description::
|
|
create a HostUpdatePolicy
|
|
|
|
|
|
.Query parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| 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.
|
|
|===
|
|
|
|
.Body parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| Parameter | Type | Description
|
|
| `body`
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
|
|
|
|===
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 201 - Created
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 202 - Accepted
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
|
|
=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies/{name}
|
|
|
|
.Global path parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| Parameter | Type | Description
|
|
| `name`
|
|
| `string`
|
|
| name of the HostUpdatePolicy
|
|
|===
|
|
|
|
|
|
HTTP method::
|
|
`DELETE`
|
|
|
|
Description::
|
|
delete a HostUpdatePolicy
|
|
|
|
|
|
.Query parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| 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
|
|
|===
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
|
|
| 202 - Accepted
|
|
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
HTTP method::
|
|
`GET`
|
|
|
|
Description::
|
|
read the specified HostUpdatePolicy
|
|
|
|
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
HTTP method::
|
|
`PATCH`
|
|
|
|
Description::
|
|
partially update the specified HostUpdatePolicy
|
|
|
|
|
|
.Query parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| 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.
|
|
|===
|
|
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
HTTP method::
|
|
`PUT`
|
|
|
|
Description::
|
|
replace the specified HostUpdatePolicy
|
|
|
|
|
|
.Query parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| 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.
|
|
|===
|
|
|
|
.Body parameters
|
|
[cols="1,1,2",options="header"]
|
|
|===
|
|
| Parameter | Type | Description
|
|
| `body`
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
|
|
|
|===
|
|
|
|
.HTTP responses
|
|
[cols="1,1",options="header"]
|
|
|===
|
|
| HTTP code | Reponse body
|
|
| 200 - OK
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 201 - Created
|
|
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|
| 401 - Unauthorized
|
|
| Empty
|
|
|===
|
|
|
|
|