github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/volume/deregister.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume deregister'
     4  description: |
     5    Deregister volumes with CSI plugins.
     6  ---
     7  
     8  # Command: volume deregister
     9  
    10  The `volume deregister` command deregisters external storage volumes with
    11  Nomad's [Container Storage Interface (CSI)][csi] support. The volume will be
    12  removed from Nomad's state store but not deleted from the external storage
    13  provider. Note that deregistering a volume prevents Nomad from deleting it via
    14  [`volume delete`] at a later time.
    15  
    16  ## Usage
    17  
    18  ```plaintext
    19  nomad volume deregister [options] [volume]
    20  ```
    21  
    22  The `volume deregister` command requires a single argument, specifying
    23  the ID of volume to be deregistered. Deregistration will fail if the
    24  volume is still in use by an allocation or in the process of being
    25  unpublished.
    26  
    27  When ACLs are enabled, this command requires a token with the
    28  `csi-write-volume` capability for the volume's namespace.
    29  
    30  ## General Options
    31  
    32  @include 'general_options.mdx'
    33  
    34  ## Deregister Options
    35  
    36  - `-force`: Force deregistration of the volume and immediately drop claims for
    37    terminal allocations. Returns an error if the volume has running
    38    allocations. This does not detach the volume from client nodes.
    39  
    40  [csi]: https://github.com/container-storage-interface/spec
    41  [`volume delete`]: /docs/commands/volume/delete