mirror of
https://github.com/kemko/nomad.git
synced 2026-01-08 19:35:41 +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>
36 lines
1.8 KiB
Plaintext
36 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad alloc command reference'
|
|
description: |
|
|
The `nomad alloc` commands interact with allocations. Access allocation directories, display status and health checks, stream task logs, run commands inside an allocation, and signal a running allocation. You can also stop, reschedule, and restart a running allocation.
|
|
---
|
|
|
|
# `nomad alloc` command reference
|
|
|
|
The `alloc` command is used to interact with allocations.
|
|
|
|
## Usage
|
|
|
|
Usage: `nomad alloc <subcommand> [options]`
|
|
|
|
Run `nomad alloc <subcommand> -h` for help on that subcommand. The following
|
|
subcommands are available:
|
|
|
|
- [`alloc checks`][checks] - Outputs service health check status information.
|
|
- [`alloc exec`][exec] - Run a command in a running allocation
|
|
- [`alloc fs`][fs] - Inspect the contents of an allocation directory
|
|
- [`alloc logs`][logs] - Streams the logs of a task
|
|
- [`alloc restart`][restart] - Restart a running allocation or task
|
|
- [`alloc signal`][signal] - Signal a running allocation
|
|
- [`alloc status`][status] - Display allocation status information and metadata
|
|
- [`alloc stop`][stop] - Stop and reschedule a running allocation
|
|
|
|
[checks]: /nomad/docs/commands/alloc/checks 'Outputs service health check status information'
|
|
[exec]: /nomad/docs/commands/alloc/exec 'Run a command in a running allocation'
|
|
[fs]: /nomad/docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
|
|
[logs]: /nomad/docs/commands/alloc/logs 'Streams the logs of a task'
|
|
[restart]: /nomad/docs/commands/alloc/restart 'Restart a running allocation or task'
|
|
[signal]: /nomad/docs/commands/alloc/signal 'Signal a running allocation'
|
|
[status]: /nomad/docs/commands/alloc/status 'Display allocation status information and metadata'
|
|
[stop]: /nomad/docs/commands/alloc/stop 'Stop and reschedule a running allocation'
|