mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-23 13:15:49 +00:00
Update admin command links
This commit is contained in:
mDuo13
@@ -4,7 +4,7 @@ Communicate directly with a `rippled` server using these admin API methods.
|
||||
|
||||
Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server.
|
||||
|
||||
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection.
|
||||
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the rippled API](get-started-with-the-rippled-api.html).
|
||||
|
||||
## List of Admin Methods
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
Use the `validation_create` command to generate the keys for a rippled [validator](tutorial-rippled-setup.html#validator-setup). Similar to the [wallet_propose](#wallet-propose) command, this command makes no real changes, but only generates a set of keys in the proper format.
|
||||
|
||||
_The `validation_create` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `validation_create` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded address stored in the ledger, the address must [receive a Payment transaction](accounts.html#creating-accounts) that provides enough XRP to meet the [reserve requirement](reserves.html).
|
||||
|
||||
*The `wallet_propose` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
|
||||
*The `wallet_propose` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
|
||||
|
||||
[Updated in: rippled 0.31.0][New in: rippled 0.31.0]
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
With `online_delete` and `advisory_delete` configuration options enabled, the `can_delete` method informs the rippled server of the latest ledger which may be deleted.
|
||||
|
||||
_The `can_delete` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `can_delete` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers.
|
||||
|
||||
_The `ledger_cleaner` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `ledger_cleaner` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `ledger_request` command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger.
|
||||
|
||||
*The `ledger_request` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `ledger_request` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages.
|
||||
|
||||
_The `log_level` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `log_level` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `logrotate` command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
|
||||
|
||||
_The `logrotate` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `logrotate` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
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!*
|
||||
*The `connect` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `ledger_accept` method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the `rippled` server is running stand-alone mode.
|
||||
|
||||
*The `ledger_accept` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `ledger_accept` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
Gracefully shuts down the server.
|
||||
|
||||
*The `stop` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `stop` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server.
|
||||
|
||||
*The `validation_seed` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `validation_seed` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `consensus_info` command provides information about the consensus process for debugging purposes.
|
||||
|
||||
_The `consensus_info` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `consensus_info` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -5,7 +5,7 @@ The `feature` command returns information about [amendments](amendments.html) th
|
||||
|
||||
You can use the `feature` command to temporarily configure the server to vote against or in favor of an amendment. This change does not persist if you restart the server. To make lasting changes in amendment voting, use the `rippled.cfg` file. See [Configuring Amendment Voting](amendments.html#configuring-amendment-voting) for more information.
|
||||
|
||||
_The `feature` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `feature` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `fetch_info` command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches.
|
||||
|
||||
_The `fetch_info` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `fetch_info` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
|
||||
|
||||
_The `get_counts` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
_The `get_counts` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `peers` command returns a list of all other `rippled` servers currently connected to this one, including information on their connection and sync status.
|
||||
|
||||
*The `peers` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `peers` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `print` command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager.
|
||||
|
||||
*The `print` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `print` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `validator_list_sites` command returns status information of sites serving validator lists. [New in: rippled 0.80.1][]
|
||||
|
||||
*The `validator_list_sites` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `validator_list_sites` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
The `validators` command returns human readable information about the current list of published and trusted validators used by the server. [New in: rippled 0.80.1][]
|
||||
|
||||
*The `validators` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
*The `validators` request is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users!*
|
||||
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
Reference in New Issue
Block a user