Chapter 4. DataImage [metal3.io/v1alpha1] Description DataImage is the Schema for the dataimages API. Type object 4.1. 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 DataImageSpec defines the desired state of DataImage. status object DataImageStatus defines the observed state of DataImage. 4.1.1. .spec Description DataImageSpec defines the desired state of DataImage. Type object Required url Property Type Description url string Url is the address of the dataImage that we want to attach to a BareMetalHost 4.1.2. .status Description DataImageStatus defines the observed state of DataImage. Type object Property Type Description attachedImage object Currently attached DataImage error object Error count and message when attaching/detaching lastReconciled string Time of last reconciliation 4.1.3. .status.attachedImage Description Currently attached DataImage Type object Required url Property Type Description url string 4.1.4. .status.error Description Error count and message when attaching/detaching Type object Required count message Property Type Description count integer message string 4.2. API endpoints The following API endpoints are available: /apis/metal3.io/v1alpha1/dataimages GET : list objects of kind DataImage /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages DELETE : delete collection of DataImage GET : list objects of kind DataImage POST : create a DataImage /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name} DELETE : delete a DataImage GET : read the specified DataImage PATCH : partially update the specified DataImage PUT : replace the specified DataImage /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status GET : read status of the specified DataImage PATCH : partially update status of the specified DataImage PUT : replace status of the specified DataImage 4.2.1. /apis/metal3.io/v1alpha1/dataimages HTTP method GET Description list objects of kind DataImage Table 4.1. HTTP responses HTTP code Reponse body 200 - OK DataImageList schema 401 - Unauthorized Empty 4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages HTTP method DELETE Description delete collection of DataImage Table 4.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind DataImage Table 4.3. HTTP responses HTTP code Reponse body 200 - OK DataImageList schema 401 - Unauthorized Empty HTTP method POST Description create a DataImage Table 4.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 4.5. Body parameters Parameter Type Description body DataImage schema Table 4.6. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 201 - Created DataImage schema 202 - Accepted DataImage schema 401 - Unauthorized Empty 4.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name} Table 4.7. Global path parameters Parameter Type Description name string name of the DataImage HTTP method DELETE Description delete a DataImage Table 4.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 4.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 DataImage Table 4.10. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified DataImage Table 4.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 4.12. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified DataImage Table 4.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 4.14. Body parameters Parameter Type Description body DataImage schema Table 4.15. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 201 - Created DataImage schema 401 - Unauthorized Empty 4.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status Table 4.16. Global path parameters Parameter Type Description name string name of the DataImage HTTP method GET Description read status of the specified DataImage Table 4.17. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified DataImage Table 4.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 4.19. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified DataImage Table 4.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 4.21. Body parameters Parameter Type Description body DataImage schema Table 4.22. HTTP responses HTTP code Reponse body 200 - OK DataImage schema 201 - Created DataImage schema 401 - Unauthorized Empty

Commands: