--- api_metadata: apiVersion: "storage.k8s.io/v1" import: "k8s.io/api/storage/v1" kind: "VolumeAttachment" content_type: "api_reference" description: "VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node." title: "VolumeAttachment" weight: 7 auto_generated: true --- `apiVersion: storage.k8s.io/v1` `import "k8s.io/api/storage/v1"` ## VolumeAttachment {#VolumeAttachment} VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. VolumeAttachment objects are non-namespaced.

- **apiVersion**: storage.k8s.io/v1 - **kind**: VolumeAttachment - **metadata** (}}">ObjectMeta) Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **spec** (}}">VolumeAttachmentSpec), required Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. - **status** (}}">VolumeAttachmentStatus) Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. ## VolumeAttachmentSpec {#VolumeAttachmentSpec} VolumeAttachmentSpec is the specification of a VolumeAttachment request.

- **attacher** (string), required Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). - **nodeName** (string), required The node that the volume should be attached to. - **source** (VolumeAttachmentSource), required Source represents the volume that should be attached. *VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.* - **source.inlineVolumeSpec** (}}">PersistentVolumeSpec) inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. - **source.persistentVolumeName** (string) Name of the persistent volume to attach. ## VolumeAttachmentStatus {#VolumeAttachmentStatus} VolumeAttachmentStatus is the status of a VolumeAttachment request.

- **attached** (boolean), required Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. - **attachError** (VolumeError) The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. *VolumeError captures an error encountered during a volume operation.* - **attachError.message** (string) String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. - **attachError.time** (Time) Time the error was encountered. *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.* - **attachmentMetadata** (map[string]string) Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. - **detachError** (VolumeError) The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. *VolumeError captures an error encountered during a volume operation.* - **detachError.message** (string) String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. - **detachError.time** (Time) Time the error was encountered. *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.* ## VolumeAttachmentList {#VolumeAttachmentList} VolumeAttachmentList is a collection of VolumeAttachment objects.

- **apiVersion**: storage.k8s.io/v1 - **kind**: VolumeAttachmentList - **metadata** (}}">ListMeta) Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]}}">VolumeAttachment), required Items is the list of VolumeAttachments ## Operations {#Operations}

### `get` read the specified VolumeAttachment #### HTTP Request GET /apis/storage.k8s.io/v1/volumeattachments/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 401: Unauthorized ### `get` read status of the specified VolumeAttachment #### HTTP Request GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 401: Unauthorized ### `list` list or watch objects of kind VolumeAttachment #### HTTP Request GET /apis/storage.k8s.io/v1/volumeattachments #### Parameters - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">VolumeAttachmentList): OK 401: Unauthorized ### `create` create a VolumeAttachment #### HTTP Request POST /apis/storage.k8s.io/v1/volumeattachments #### Parameters - **body**: }}">VolumeAttachment, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 201 (}}">VolumeAttachment): Created 202 (}}">VolumeAttachment): Accepted 401: Unauthorized ### `update` replace the specified VolumeAttachment #### HTTP Request PUT /apis/storage.k8s.io/v1/volumeattachments/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **body**: }}">VolumeAttachment, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 201 (}}">VolumeAttachment): Created 401: Unauthorized ### `update` replace status of the specified VolumeAttachment #### HTTP Request PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **body**: }}">VolumeAttachment, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 201 (}}">VolumeAttachment): Created 401: Unauthorized ### `patch` partially update the specified VolumeAttachment #### HTTP Request PATCH /apis/storage.k8s.io/v1/volumeattachments/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 401: Unauthorized ### `patch` partially update status of the specified VolumeAttachment #### HTTP Request PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttachment): OK 401: Unauthorized ### `delete` delete a VolumeAttachment #### HTTP Request DELETE /apis/storage.k8s.io/v1/volumeattachments/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttachment - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### Response 200 (}}">VolumeAttachment): OK 202 (}}">VolumeAttachment): Accepted 401: Unauthorized ### `deletecollection` delete collection of VolumeAttachment #### HTTP Request DELETE /apis/storage.k8s.io/v1/volumeattachments #### Parameters - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized