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

66 lines
1.6 KiB
Plaintext
Raw Normal View History

2019-04-25 12:39:49 +00:00
---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: alloc signal'
description: |
2019-04-25 12:39:49 +00:00
Signal a running allocation or task
---
2019-06-05 15:09:22 +00:00
# Command: alloc signal
2019-04-25 12:39:49 +00:00
The `alloc signal` command allows a user to perform an in place signal of an
an entire allocation or individual task.
## Usage
```plaintext
2019-04-25 12:39:49 +00:00
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.
Task name may also be specified using the `-task` option rather than a command
argument. If task name is given with both an argument and the `-task` option,
preference is given to the `-task` option.
When ACLs are enabled, this command requires a token with the
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
allocation's namespace.
2019-04-25 12:39:49 +00:00
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
2019-04-25 12:39:49 +00:00
## Signal Options
- `-s`: Signal to send to the tasks. Valid options depend on the driver.
- `-task`: Specify the individual task that will receive the signal.
- `-verbose`: Display verbose output.
2019-04-25 12:39:49 +00:00
## Examples
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad alloc signal eb17e557
2019-04-25 12:39:49 +00:00
$ nomad alloc signal eb17e557 redis
Could not find task named: redis, found:
2019-04-25 12:39:49 +00:00
* test
<blocking>
```
Specifying task name with the `-task` option:
```shell-session
$ nomad alloc signal -task redis eb17e557
```
If task name is specified using both options, the command argument is ignored.
The following will signal the "redis" task only, not the "api" task:
```shell-session
$ nomad alloc signal -task redis eb17e557 api
```