Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

Description

Metal3RemediationTemplate is the Schema for the metal3remediationtemplates API.

Type

`object`

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`	Metal3RemediationTemplateSpec defines the desired state of Metal3RemediationTemplate.
`status`	`object`	Metal3RemediationTemplateStatus defines the observed state of Metal3RemediationTemplate.

.spec

Description

Metal3RemediationTemplateSpec defines the desired state of Metal3RemediationTemplate.

Type

`object`

Required

template

Property	Type	Description
`template`	`object`	Metal3RemediationTemplateResource describes the data needed to create a Metal3Remediation from a template.

.spec.template

Description

Metal3RemediationTemplateResource describes the data needed to create a Metal3Remediation from a template.

Type

`object`

Required

spec

Property	Type	Description
`spec`	`object`	Spec is the specification of the desired behavior of the Metal3Remediation.

.spec.template.spec

Description

Spec is the specification of the desired behavior of the Metal3Remediation.

Type

`object`

Property	Type	Description
`strategy`	`object`	Strategy field defines remediation strategy.

.spec.template.spec.strategy

Description

Strategy field defines remediation strategy.

Type

`object`

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

Metal3RemediationTemplateStatus defines the observed state of Metal3RemediationTemplate.

Type

`object`

Required

status

Property	Type	Description
`status`	`object`	Metal3RemediationStatus defines the observed state of Metal3Remediation

.status.status

Description

Metal3RemediationStatus defines the observed state of Metal3Remediation

Type

`object`

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/metal3remediationtemplates
- GET: list objects of kind Metal3RemediationTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates
- DELETE: delete collection of Metal3RemediationTemplate
- GET: list objects of kind Metal3RemediationTemplate
- POST: create a Metal3RemediationTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}
- DELETE: delete a Metal3RemediationTemplate
- GET: read the specified Metal3RemediationTemplate
- PATCH: partially update the specified Metal3RemediationTemplate
- PUT: replace the specified Metal3RemediationTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status
- GET: read status of the specified Metal3RemediationTemplate
- PATCH: partially update status of the specified Metal3RemediationTemplate
- PUT: replace status of the specified Metal3RemediationTemplate

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

HTTP method

`GET`

Description

list objects of kind Metal3RemediationTemplate

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplateList` schema
401 - Unauthorized	Empty

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

HTTP method

`DELETE`

Description

delete collection of Metal3RemediationTemplate

HTTP responses

HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind Metal3RemediationTemplate

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplateList` schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a Metal3RemediationTemplate

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.

Body parameters

Parameter	Type	Description
`body`	`Metal3RemediationTemplate` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
201 - Created	`Metal3RemediationTemplate` schema
202 - Accepted	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
`name`	`string`	name of the Metal3RemediationTemplate

HTTP method

`DELETE`

Description

delete a Metal3RemediationTemplate

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

HTTP responses

HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified Metal3RemediationTemplate

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified Metal3RemediationTemplate

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.

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified Metal3RemediationTemplate

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.

Body parameters

Parameter	Type	Description
`body`	`Metal3RemediationTemplate` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
201 - Created	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
`name`	`string`	name of the Metal3RemediationTemplate

HTTP method

`GET`

Description

read status of the specified Metal3RemediationTemplate

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified Metal3RemediationTemplate

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.

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified Metal3RemediationTemplate

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.

Body parameters

Parameter	Type	Description
`body`	`Metal3RemediationTemplate` schema

HTTP responses

HTTP code	Reponse body
200 - OK	`Metal3RemediationTemplate` schema
201 - Created	`Metal3RemediationTemplate` schema
401 - Unauthorized	Empty

Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]¶

Specification¶

.spec¶

.spec.template¶

.spec.template.spec¶

.spec.template.spec.strategy¶

.status¶

.status.status¶

API endpoints¶

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates¶

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates¶

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}¶

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

Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

Specification

.spec

.spec.template

.spec.template.spec

.spec.template.spec.strategy

.status

.status.status

API endpoints

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

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

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

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