mirror of
https://github.com/kemko/nomad.git
synced 2026-01-11 12:55:42 +03:00
dae496e427
* Enhance front matter description for search * acl section * alloc section * config section * deployment section * eval section * job section * license section * namespace section * node section * node pool section * operator section * plugin section * quota section * recommendation section * scaling section * sentinel section * server section * service section * setup section * system section * tls section * var section * volume section * change reference to command reference * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
44 lines
2.1 KiB
Plaintext
44 lines
2.1 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
|
|
|
|
Usage: `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/docs/commands/volume/create
|
|
[claim-delete]: /nomad/docs/commands/volume/claim-delete
|
|
[claim-list]: /nomad/docs/commands/volume/claim-list
|
|
[delete]: /nomad/docs/commands/volume/delete
|
|
[deregister]: /nomad/docs/commands/volume/deregister 'Deregister a volume'
|
|
[detach]: /nomad/docs/commands/volume/detach 'Detach a volume'
|
|
[init]: /nomad/docs/commands/volume/init 'Create an example volume specification file'
|
|
[register]: /nomad/docs/commands/volume/register 'Register a volume'
|
|
[snapshot-create]: /nomad/docs/commands/volume/snapshot-create
|
|
[snapshot-delete]: /nomad/docs/commands/volume/snapshot-delete
|
|
[snapshot-list]: /nomad/docs/commands/volume/snapshot-list
|
|
[status]: /nomad/docs/commands/volume/status 'Display status information about a volume'
|