mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
97 lines
2.2 KiB
Markdown
97 lines
2.2 KiB
Markdown
## connect
|
|
[[Source]<br>](https://github.com/ripple/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` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
|
|
|
#### Request Format
|
|
An example of the request format:
|
|
|
|
<!-- MULTICODE_BLOCK_START -->
|
|
|
|
*WebSocket*
|
|
|
|
```
|
|
{
|
|
"command": "connect",
|
|
"ip": "192.170.145.88",
|
|
"port": 51235
|
|
}
|
|
```
|
|
|
|
*JSON-RPC*
|
|
|
|
```
|
|
{
|
|
"method": "connect",
|
|
"params": [
|
|
{
|
|
"ip": "192.170.145.88",
|
|
"port": 51235
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
|
|
*Commandline*
|
|
|
|
```
|
|
#Syntax: connect ip [port]
|
|
rippled connect 192.170.145.88 51235
|
|
```
|
|
|
|
<!-- MULTICODE_BLOCK_END -->
|
|
|
|
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. Defaults to 6561. |
|
|
|
|
#### Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
<!-- MULTICODE_BLOCK_START -->
|
|
|
|
*JSON-RPC*
|
|
|
|
```
|
|
{
|
|
"result" : {
|
|
"message" : "connecting",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
|
|
*Commandline*
|
|
|
|
```
|
|
Loading: "/etc/rippled.cfg"
|
|
Connecting to 127.0.0.1:5005
|
|
{
|
|
"result" : {
|
|
"message" : "connecting",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- MULTICODE_BLOCK_END -->
|
|
|
|
The response follows the [standard format](#response-formatting), 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](#universal-errors).
|
|
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
|
|
* Cannot connect in standalone mode - Network-related commands are disabled in stand-alone mode.
|