Chapter 18. NetworkAttachmentDefinition [k8s.cni.cncf.io/v1] Description NetworkAttachmentDefinition is a CRD schema specified by the Network Plumbing Working Group to express the intent for attaching pods to one or more logical or physical networks. More information available at: https://github.com/k8snetworkplumbingwg/multi-net-spec Type object 18.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 NetworkAttachmentDefinition spec defines the desired state of a network attachment 18.1.1. .spec Description NetworkAttachmentDefinition spec defines the desired state of a network attachment Type object Property Type Description config string NetworkAttachmentDefinition config is a JSON-formatted CNI configuration 18.2. API endpoints The following API endpoints are available: /apis/k8s.cni.cncf.io/v1/network-attachment-definitions GET : list objects of kind NetworkAttachmentDefinition /apis/k8s.cni.cncf.io/v1/namespaces/{namespace}/network-attachment-definitions DELETE : delete collection of NetworkAttachmentDefinition GET : list objects of kind NetworkAttachmentDefinition POST : create a NetworkAttachmentDefinition /apis/k8s.cni.cncf.io/v1/namespaces/{namespace}/network-attachment-definitions/{name} DELETE : delete a NetworkAttachmentDefinition GET : read the specified NetworkAttachmentDefinition PATCH : partially update the specified NetworkAttachmentDefinition PUT : replace the specified NetworkAttachmentDefinition 18.2.1. /apis/k8s.cni.cncf.io/v1/network-attachment-definitions HTTP method GET Description list objects of kind NetworkAttachmentDefinition Table 18.1. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinitionList schema 401 - Unauthorized Empty 18.2.2. /apis/k8s.cni.cncf.io/v1/namespaces/{namespace}/network-attachment-definitions HTTP method DELETE Description delete collection of NetworkAttachmentDefinition Table 18.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind NetworkAttachmentDefinition Table 18.3. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinitionList schema 401 - Unauthorized Empty HTTP method POST Description create a NetworkAttachmentDefinition Table 18.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 18.5. Body parameters Parameter Type Description body NetworkAttachmentDefinition schema Table 18.6. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinition schema 201 - Created NetworkAttachmentDefinition schema 202 - Accepted NetworkAttachmentDefinition schema 401 - Unauthorized Empty 18.2.3. /apis/k8s.cni.cncf.io/v1/namespaces/{namespace}/network-attachment-definitions/{name} Table 18.7. Global path parameters Parameter Type Description name string name of the NetworkAttachmentDefinition HTTP method DELETE Description delete a NetworkAttachmentDefinition Table 18.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 18.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 NetworkAttachmentDefinition Table 18.10. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinition schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified NetworkAttachmentDefinition Table 18.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 18.12. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinition schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified NetworkAttachmentDefinition Table 18.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 18.14. Body parameters Parameter Type Description body NetworkAttachmentDefinition schema Table 18.15. HTTP responses HTTP code Reponse body 200 - OK NetworkAttachmentDefinition schema 201 - Created NetworkAttachmentDefinition schema 401 - Unauthorized Empty

Commands: