mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-21 04:05:49 +00:00
7645140477
For better URLs, the content folder has been renamed 'docs' and all other files have been moved up a level. Also, non-docs images have been moved to the static folder at the top level where they belong. Many relative paths had to be fixed to make this work.
108 lines
2.7 KiB
Markdown
108 lines
2.7 KiB
Markdown
---
|
|
html: connect.html
|
|
parent: peer-management-methods.html
|
|
seo:
|
|
description: Force the rippled server to connect to a specific peer.
|
|
labels:
|
|
- Core Server
|
|
---
|
|
# connect
|
|
[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
|
|
|
|
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
|
|
|
|
*The `connect` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
|
|
|
|
### Request Format
|
|
An example of the request format:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"command": "connect",
|
|
"ip": "192.170.145.88",
|
|
"port": 51235
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"method": "connect",
|
|
"params": [
|
|
{
|
|
"ip": "192.170.145.88",
|
|
"port": 51235
|
|
}
|
|
]
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```sh
|
|
#Syntax: connect ip [port]
|
|
rippled connect 192.170.145.88 51235
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
The request includes the following parameters:
|
|
|
|
| `Field` | Type | Description |
|
|
|:--------|:-------|:----------------------------------------------------------|
|
|
| `ip` | String | IP address of the server to connect to |
|
|
| `port` | Number | _(Optional)_ Port number to use when connecting. The default is **2459**. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}Updated in: rippled 1.6.0{% /badge %} |
|
|
|
|
### Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"result" : {
|
|
"message" : "connecting",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```json
|
|
Loading: "/etc/rippled.cfg"
|
|
Connecting to 127.0.0.1:5005
|
|
|
|
{
|
|
"result" : {
|
|
"message" : "connecting",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
The response follows the [standard format][], with a successful result containing the following fields:
|
|
|
|
| `Field` | Type | Description |
|
|
|:----------|:-------|:-------------------------------------------------------|
|
|
| `message` | String | The value `connecting`, if the command was successful. |
|
|
|
|
### Possible Errors
|
|
|
|
- Any of the [universal error types][].
|
|
- `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
|
|
- Cannot connect in stand-alone mode - Network-related commands are disabled in stand-alone mode.
|
|
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
|
|
|
|
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|