Files
nomad/website/content/commands/volume/index.mdx

46 lines
2.0 KiB
Plaintext

---
layout: docs
page_title: 'nomad volume command reference'
description: |
The `nomad volume` command interacts with volumes. Generate an example volume specification. Create, delete, register, and deregister a volume. Create and delete a volume snapshot. Display a list of volumes and status information for a single volume.
---
# `nomad volume` command reference
The `volume` command is used to interact with volumes.
## Usage
```plaintext
nomad volume <subcommand> [options]
```
Run `nomad volume <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`volume create`][create] - Create a volume.
- [`volume claim delete`][claim-delete] - Delete a task group host volume claim.
- [`volume claim list`][claim-list] - List task group host volume claims.
- [`volume delete`][delete] - Delete a volume.
- [`volume deregister`][deregister] - Deregister a volume.
- [`volume detach`][detach] - Detach a volume.
- [`volume init`][init] - Create an example volume specification file.
- [`volume register`][register] - Register a volume.
- [`volume snapshot create`][snapshot-create] - Create a volume snapshot.
- [`volume snapshot delete`][snapshot-delete] - Delete a volume snapshot.
- [`volume snapshot list`][snapshot-list] - List all volume snapshots.
- [`volume status`][status] - Display status information about a volume.
[create]: /nomad/commands/volume/create
[claim-delete]: /nomad/commands/volume/claim-delete
[claim-list]: /nomad/commands/volume/claim-list
[delete]: /nomad/commands/volume/delete
[deregister]: /nomad/commands/volume/deregister 'Deregister a volume'
[detach]: /nomad/commands/volume/detach 'Detach a volume'
[init]: /nomad/commands/volume/init 'Create an example volume specification file'
[register]: /nomad/commands/volume/register 'Register a volume'
[snapshot-create]: /nomad/commands/volume/snapshot-create
[snapshot-delete]: /nomad/commands/volume/snapshot-delete
[snapshot-list]: /nomad/commands/volume/snapshot-list
[status]: /nomad/commands/volume/status 'Display status information about a volume'