mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 02:15:43 +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>
66 lines
1.7 KiB
Plaintext
66 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad alloc signal command reference'
|
|
description: |
|
|
The `nomad alloc signal` command sends a signal to a running allocation or task.
|
|
---
|
|
|
|
# `nomad alloc signal` command reference
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|
|
|
|
## 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.
|
|
|
|
## Examples
|
|
|
|
```shell-session
|
|
$ nomad alloc signal eb17e557
|
|
|
|
$ nomad alloc signal eb17e557 redis
|
|
Could not find task named: redis, found:
|
|
* 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
|
|
```
|