open-nomad/website/content/docs/commands/alloc/signal.mdx

46 lines
1 KiB
Plaintext

---
layout: docs
page_title: 'Commands: alloc signal'
description: |
Signal a running allocation or task
---
# Command: alloc signal
The `alloc signal` command allows a user to perform an in place signal of an
an entire allocation or individual task.
## Usage
```plaintext
nomad alloc signal [options] <allocation> <task>
```
This command accepts a single allocation ID and a task name. The task name must
be part of the allocation and the task must be currently running. The task name
is optional and if omitted every task in the allocation will be signaled.
When ACLs are enabled, this command requires a token with the
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
allocation's namespace.
## General Options
@include 'general_options.mdx'
## Signal Options
- `-s`: Signal to send to the tasks. Valid options depend on the driver.
- `-verbose`: Display verbose output.
## Examples
```shell-session
$ nomad alloc signal eb17e557
$ nomad alloc signal eb17e557 foo
Could not find task named: foo, found:
* test
<blocking>
```