connect

[Source]

The connect command forces the rippled server to connect to a specific peer rippled server.

The connect request is an admin method that cannot be run by unprivileged users!

Request Format

An example of the request format:

{
    "command": "connect",
    "ip": "192.170.145.88",
    "port": 51235
}
{
    "method": "connect",
    "params": [
        {
            "ip": "192.170.145.88",
            "port": 51235
        }
    ]
}
#Syntax: connect ip [port]
rippled connect 192.170.145.88 51235

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:

{
   "result" : {
      "message" : "connecting",
      "status" : "success"
   }
}
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "message" : "connecting",
      "status" : "success"
   }
}

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 standalone mode - Network-related commands are disabled in stand-alone mode.