67 lines
1.4 KiB
Markdown
67 lines
1.4 KiB
Markdown
|
---
|
||
|
|
layout: "docs"
|
||
|
|
page_title: "Commands: Services"
|
||
|
|
sidebar_current: "docs-commands-services"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Consul Agent Services
|
||
|
|
|
||
|
|
Command: `consul services`
|
||
|
|
|
||
|
|
The `services` command has subcommands for interacting with Consul services
|
||
|
|
registered with the [local agent](/docs/agent/basics.html). These provide
|
||
|
|
useful commands such as `register` and `deregister` for easily registering
|
||
|
|
services in scripts, dev mode, etc.
|
||
|
|
To view all services in the catalog, instead of only agent-local services,
|
||
|
|
see the [`catalog services`](/docs/commands/catalog/services.html) command.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Usage: `consul services <subcommand>`
|
||
|
|
|
||
|
|
For the exact documentation for your Consul version, run `consul services -h` to
|
||
|
|
view the complete list of subcommands.
|
||
|
|
|
||
|
|
```text
|
||
|
|
Usage: consul services <subcommand> [options] [args]
|
||
|
|
|
||
|
|
...
|
||
|
|
|
||
|
|
Subcommands:
|
||
|
|
deregister Deregister services with the local agent
|
||
|
|
register Register services with the local agent
|
||
|
|
```
|
||
|
|
|
||
|
|
For more information, examples, and usage about a subcommand, click on the name
|
||
|
|
of the subcommand in the sidebar.
|
||
|
|
|
||
|
|
## Basic Examples
|
||
|
|
|
||
|
|
To create a simple service:
|
||
|
|
|
||
|
|
```text
|
||
|
|
$ consul services register -name=web
|
||
|
|
```
|
||
|
|
|
||
|
|
To create a service from a configuration file:
|
||
|
|
|
||
|
|
```text
|
||
|
|
$ cat web.json
|
||
|
|
{
|
||
|
|
"Service": {
|
||
|
|
"Name": "web"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$ consul services register web.json
|
||
|
|
```
|
||
|
|
|
||
|
|
To deregister a service:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Either style works:
|
||
|
|
$ consul services deregister web.json
|
||
|
|
|
||
|
|
$ consul services deregister -id web
|
||
|
|
```
|