2020-04-07 18:55:19 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-07 18:55:19 +00:00
|
|
|
page_title: 'Commands: Watch'
|
2020-04-13 18:40:26 +00:00
|
|
|
sidebar_title: watch
|
2020-04-07 18:55:19 +00:00
|
|
|
description: >-
|
|
|
|
|
The `watch` command provides a mechanism to watch for changes in a particular
|
|
|
|
|
data view (list of nodes, service members, key value, etc) and to invoke a
|
|
|
|
|
process with the latest values of the view. If no process is specified, the
|
|
|
|
|
current values are dumped to stdout which can be a useful way to inspect data
|
|
|
|
|
in Consul.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Watch
|
|
|
|
|
|
|
|
|
|
Command: `consul watch`
|
|
|
|
|
|
|
|
|
|
The `watch` command provides a mechanism to watch for changes in a particular
|
|
|
|
|
data view (list of nodes, service members, key value, etc) and to invoke
|
|
|
|
|
a process with the latest values of the view. If no process is specified,
|
|
|
|
|
the current values are dumped to STDOUT which can be a useful way to inspect
|
|
|
|
|
data in Consul.
|
|
|
|
|
|
2020-04-09 23:46:54 +00:00
|
|
|
There is more [documentation on watches here](/docs/agent/watches).
|
2020-04-07 18:55:19 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `consul watch [options] [child...]`
|
|
|
|
|
|
|
|
|
|
The only required option is `-type` which specifies the particular
|
|
|
|
|
data view. Depending on the type, various options may be required
|
|
|
|
|
or optionally provided. There is more documentation on watch
|
2020-04-09 23:46:54 +00:00
|
|
|
[specifications here](/docs/agent/watches).
|
2020-04-07 18:55:19 +00:00
|
|
|
|
|
|
|
|
#### API Options
|
|
|
|
|
|
|
|
|
|
@include 'http_api_options_client.mdx'
|
2020-04-07 23:56:08 +00:00
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
|
|
|
|
|
|
#### Command Options
|
|
|
|
|
|
|
|
|
|
- `-key` - Key to watch. Only for `key` type.
|
|
|
|
|
|
|
|
|
|
- `-name`- Event name to watch. Only for `event` type.
|
|
|
|
|
|
|
|
|
|
- `-passingonly=[true|false]` - Should only passing entries be returned. Defaults to
|
|
|
|
|
`false` and only applies for `service` type.
|
|
|
|
|
|
|
|
|
|
- `-prefix` - Key prefix to watch. Only for `keyprefix` type.
|
|
|
|
|
|
|
|
|
|
- `-service` - Service to watch. Required for `service` type, optional for `checks` type.
|
|
|
|
|
|
|
|
|
|
- `-shell` - Optional, use a shell to run the command (can set a custom shell via the
|
|
|
|
|
SHELL environment variable). The default value is true.
|
|
|
|
|
|
|
|
|
|
- `-state` - Check state to filter on. Optional for `checks` type.
|
|
|
|
|
|
|
|
|
|
- `-tag` - Service tag to filter on. Optional for `service` type.
|
|
|
|
|
|
|
|
|
|
- `-type` - Watch type. Required, one of "`key`, `keyprefix`, `services`,
|
|
|
|
|
`nodes`, `service`, `checks`, or `event`.
|
