ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-01 00:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate content syntax via script

Browse Source 
The changes in this commit were auto-generated by running

tool/migrate.sh

Following this commit, the Dactyl build no longer works but the Redocly
build (mostly) should.
This commit is contained in:
mDuo13
2024-01-31 16:09:41 -08:00
parent 96121303b2
commit 554a3732d4
898 changed files with 19879 additions and 18631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md
View File

@@ -10,15 +10,14 @@ labels:
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
*The `connect` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `connect` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "connect",
@@ -26,9 +25,9 @@ An example of the request format:
"port": 51235
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "connect",
@@ -40,32 +39,31 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: connect ip [port]
rippled connect 192.170.145.88 51235
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /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**. [Updated in: rippled 1.6.0][] |
| `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:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -74,9 +72,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -88,8 +86,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -104,7 +103,4 @@ The response follows the [standard format][], with a successful result containin
- 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.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}