2015-09-15 00:40:49 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2015-09-15 01:04:56 +00:00
|
|
|
page_title: "Commands: agent-join"
|
|
|
|
sidebar_current: "docs-commands-agent-join"
|
2015-09-15 00:40:49 +00:00
|
|
|
description: >
|
2015-09-15 01:04:56 +00:00
|
|
|
Joins the local server to one or more Nomad servers.
|
2015-09-15 00:40:49 +00:00
|
|
|
---
|
|
|
|
|
2015-09-15 03:24:04 +00:00
|
|
|
# Command: agent-join
|
2015-09-15 00:40:49 +00:00
|
|
|
|
2015-09-15 01:04:56 +00:00
|
|
|
The `agent-join` command joins the local server to one or more Nomad servers.
|
|
|
|
Joining is only required for server nodes, and only needs to succeed against
|
|
|
|
one or more of the provided addresses. Once joined, the gossip layer will
|
|
|
|
handle discovery of the other server nodes in the cluster.
|
2015-09-15 00:40:49 +00:00
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
```
|
2015-09-15 01:04:56 +00:00
|
|
|
nomad agent-join [options] <addr> [<addr>...]
|
2015-09-15 00:40:49 +00:00
|
|
|
```
|
|
|
|
|
2015-09-15 01:04:56 +00:00
|
|
|
One or more server addresses are required. If multiple server addresses are
|
|
|
|
specified, then an attempt will be made to join each one. If one or more nodes
|
|
|
|
are joined successfully, the exit code will be 0. Otherwise, the exit code will
|
|
|
|
be 1.
|
|
|
|
|
2015-09-15 00:40:49 +00:00
|
|
|
## General Options
|
|
|
|
|
2015-09-15 20:39:57 +00:00
|
|
|
<%= general_options_usage %>
|
2015-09-15 03:24:04 +00:00
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
Join the local server to a remote server:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ nomad agent-join 10.0.0.8:4648
|
|
|
|
Joined 1 nodes successfully
|
|
|
|
```
|