open-nomad/website/content/docs/commands/alloc/index.mdx
2021-01-05 19:02:39 -05:00

35 lines
1.3 KiB
Plaintext

---
layout: docs
page_title: 'Commands: alloc'
sidebar_title: alloc
description: |
The alloc command is used to interact with allocations.
---
# Command: alloc
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 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
[exec]: /docs/commands/alloc/exec 'Run a command in a running allocation'
[fs]: /docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
[logs]: /docs/commands/alloc/logs 'Streams the logs of a task'
[restart]: /docs/commands/alloc/restart 'Restart a running allocation or task'
[signal]: /docs/commands/alloc/signal 'Signal a running allocation'
[status]: /docs/commands/alloc/status 'Display allocation status information and metadata'
[stop]: /docs/commands/alloc/stop 'Stop and reschedule a running allocation'