// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1"]
= Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
Metal3Remediation is the Schema for the metal3remediations 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`
| Metal3RemediationSpec defines the desired state of Metal3Remediation.

| `status`
| `object`
| Metal3RemediationStatus defines the observed state of Metal3Remediation.

|===
=== .spec
Description::
+
--
Metal3RemediationSpec defines the desired state of Metal3Remediation.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `strategy`
| `object`
| Strategy field defines remediation strategy.

|===
=== .spec.strategy
Description::
+
--
Strategy field defines remediation strategy.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `retryLimit`
| `integer`
| Sets maximum number of remediation retries.

| `timeout`
| `string`
| Sets the timeout between remediation retries.

| `type`
| `string`
| Type of remediation.

|===
=== .status
Description::
+
--
Metal3RemediationStatus defines the observed state of Metal3Remediation.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastRemediated`
| `string`
| LastRemediated identifies when the host was last remediated

| `phase`
| `string`
| Phase represents the current phase of machine remediation.
E.g. Pending, Running, Done etc.

| `retryCount`
| `integer`
| RetryCount can be used as a counter during the remediation.
Field can hold number of reboots etc.

|===

== API endpoints

The following API endpoints are available:

* `/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations`
- `GET`: list objects of kind Metal3Remediation
* `/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations`
- `DELETE`: delete collection of Metal3Remediation
- `GET`: list objects of kind Metal3Remediation
- `POST`: create a Metal3Remediation
* `/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}`
- `DELETE`: delete a Metal3Remediation
- `GET`: read the specified Metal3Remediation
- `PATCH`: partially update the specified Metal3Remediation
- `PUT`: replace the specified Metal3Remediation
* `/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status`
- `GET`: read status of the specified Metal3Remediation
- `PATCH`: partially update status of the specified Metal3Remediation
- `PUT`: replace status of the specified Metal3Remediation


=== /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations



HTTP method::
  `GET`

Description::
  list objects of kind Metal3Remediation


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-x-k8s-cluster-infrastructure-v1beta1-Metal3RemediationList[`Metal3RemediationList`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations



HTTP method::
  `DELETE`

Description::
  delete collection of Metal3Remediation




.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 Metal3Remediation




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-x-k8s-cluster-infrastructure-v1beta1-Metal3RemediationList[`Metal3RemediationList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a Metal3Remediation


.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/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 201 - Created
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 202 - Accepted
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the Metal3Remediation
|===


HTTP method::
  `DELETE`

Description::
  delete a Metal3Remediation


.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 Metal3Remediation




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified Metal3Remediation


.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/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified Metal3Remediation


.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/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 201 - Created
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the Metal3Remediation
|===


HTTP method::
  `GET`

Description::
  read status of the specified Metal3Remediation




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified Metal3Remediation


.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/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified Metal3Remediation


.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/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 201 - Created
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[`Metal3Remediation`] schema
| 401 - Unauthorized
| Empty
|===


