From b0c16ea14796884de56cd5a25e20aa86b7e9894c Mon Sep 17 00:00:00 2001 From: Ryan Young Date: Tue, 8 May 2018 19:15:42 -0700 Subject: [PATCH 1/6] initial work on admin methods --- dactyl-config.yml | 62 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/dactyl-config.yml b/dactyl-config.yml index 55797dc8f0..d75eb76d6f 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -597,11 +597,71 @@ pages: funnel: Docs doc_type: References supercategory: rippled API - category: Public rippled Methods + category: Admin rippled Methods subcategory: Key Generation Methods targets: - local + - md: references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md + html: wallet_propose.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Key Generation Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md + html: can_delete.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md + html: ledger_cleaner.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md + html: ledger_request.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md + html: log_level.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md + html: logrotate.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + targets: + - local + # TODO: Subcategory landings and pages for: # - Logging and Data Management Methods (5) # - Server Control Methods (4) From 05733d6067cd86b30af322a0e567bd0b9c0f6c84 Mon Sep 17 00:00:00 2001 From: Ryan Young Date: Tue, 8 May 2018 23:35:36 -0700 Subject: [PATCH 2/6] updated config for admin methods --- .../admin-rippled-methods.md | 8 +- dactyl-config.yml | 158 +++++++++++++++++- 2 files changed, 161 insertions(+), 5 deletions(-) diff --git a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md index c03ab1afc3..7be65727a3 100644 --- a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md @@ -7,14 +7,14 @@ Admin methods are meant only for trusted personnel in charge of keeping the serv 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. -* **[Key Generation Methods](x)** +* **[Key Generation Methods](key-generation-methods.html)** -* **[Logging and Data Management Methods](x)** +* **[Logging and Data Management Methods](logging-and-data-management-methods.html)** -* **[Server Control Methods](x)** +* **[Server Control Methods](server-and-control-methods.html)** -* **[Status and Debugging Methods](x)** +* **[Status and Debugging Methods](status-and-debugging-methods.html)** diff --git a/dactyl-config.yml b/dactyl-config.yml index d75eb76d6f..9ebea8c7ef 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -586,7 +586,7 @@ pages: funnel: Docs doc_type: References supercategory: rippled API - category: Public rippled Methods + category: Admin rippled Methods subcategory: Key Generation Methods template: template-landing-children.html targets: @@ -612,6 +612,17 @@ pages: targets: - local + - name: Logging and Data Management Methods + html: logging-and-data-management-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Logging and Data Management Methods + template: template-landing-children.html + targets: + - local + - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md html: can_delete.html funnel: Docs @@ -662,6 +673,151 @@ pages: targets: - local + - name: Server Control Methods + html: server-and-control-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Server Control Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.md + html: connect.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Server Control Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md + html: ledger_accept.html + funnel: docs + doc_type: References + supercategory: + category: Admin rippled Methods + subcategory: Server Control Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/server-control-methods/stop.md + html: stop.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Server Control Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md + html: validation_seed.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Server Control Methods + targets: + - local + + - name: Status and Debugging Methods + html: status-and-debugging-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + template: template-landing-children.html + targets: + - local + + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md + html: consensus_info.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md + html: feature.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md + html: fetch_info.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md + html: get_counts.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md + html: peers.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md + html: print.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md + html: validator_list_sites.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md + html: validators.html + funnel: docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + subcategory: Status and Debugging Methods + targets: + - local + + + # TODO: Subcategory landings and pages for: # - Logging and Data Management Methods (5) # - Server Control Methods (4) From 52ec01222f4db893ea4efe68507525c03c0e1b4b Mon Sep 17 00:00:00 2001 From: Ryan Young Date: Wed, 9 May 2018 14:12:45 -0700 Subject: [PATCH 3/6] added blurbs, demoted headers --- .../validation_create.md | 8 +-- .../key-generation-methods/wallet_propose.md | 10 ++-- .../can_delete.md | 6 +- .../ledger_cleaner.md | 8 +-- .../ledger_request.md | 10 ++-- .../log_level.md | 8 +-- .../logrotate.md | 8 +-- .../server-control-methods/connect.md | 8 +-- .../server-control-methods/ledger_accept.md | 8 +-- .../server-control-methods/stop.md | 8 +-- .../server-control-methods/validation_seed.md | 8 +-- .../consensus_info.md | 8 +-- .../status-and-debugging-methods/feature.md | 8 +-- .../fetch_info.md | 8 +-- .../get_counts.md | 8 +-- .../status-and-debugging-methods/peers.md | 8 +-- .../status-and-debugging-methods/print.md | 8 +-- .../validator_list_sites.md | 8 +-- .../validators.md | 8 +-- dactyl-config.yml | 57 ++++++++++++------- 20 files changed, 114 insertions(+), 97 deletions(-) diff --git a/content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md index 73de2acd8e..5876a2102d 100644 --- a/content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md +++ b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md @@ -1,11 +1,11 @@ -## validation_create +# validation_create [[Source]
](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -50,7 +50,7 @@ The request includes the following parameters: **Note:** The security of your validator depends on the entropy of your seed. Do not use a secret value for real business purposes unless it is generated with a strong source of randomness. Ripple recommends omitting the `secret` when generating new credentials for the first time. -#### Response Format +### Response Format An example of a successful response: @@ -94,7 +94,7 @@ The response follows the [standard format](#response-formatting), with a success | `validation_public_key` | String | The public key for these validation credentials, in Ripple's [base58][] encoded string format. | | `validation_seed` | String | The secret key for these validation credentials, in Ripple's [base58][] encoded string format. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `badSeed` - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key. diff --git a/content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md index 8c2b3afe21..a7f07343b4 100644 --- a/content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md +++ b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md @@ -1,4 +1,4 @@ -## wallet_propose +# wallet_propose [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source") 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](reference-transaction-format.html#creating-accounts) that provides enough XRP to meet the [reserve requirement](concept-reserves.html). @@ -7,7 +7,7 @@ Use the `wallet_propose` method to generate a key pair and XRP Ledger address. T [Updated in: rippled 0.31.0][New in: rippled 0.31.0] -#### Request Format +### Request Format An example of the request format: @@ -81,7 +81,7 @@ You must provide **at most one** of the following fields: `passphrase`, `seed`, **Note:** [Ed25519](https://ed25519.cr.yp.to/) support is experimental. The commandline version of this command cannot generate Ed25519 keys. -##### Specifying a Seed +#### Specifying a Seed For most cases, you should use a seed value generated from a strong source of randomness. Anyone who knows the seed value for an address has full power to [send transactions signed by that address](reference-transaction-format.html#authorizing-transactions). Generally, running this command with no parameters is a good way to generate a random seed. @@ -101,7 +101,7 @@ If you do specify a seed, you can specify it in any of the following formats: [RFC-1751]: https://tools.ietf.org/html/rfc1751 [hexadecimal]: https://en.wikipedia.org/wiki/Hexadecimal -#### Response Format +### Response Format An example of a successful response: @@ -185,7 +185,7 @@ For more information about master and regular key pairs, see [Cryptographic Keys For more information about multi-signing and signer lists, see [Multi-Signing](reference-transaction-format.html#multi-signing). -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly. diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md index 848773bbd8..10466e6abf 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md @@ -1,11 +1,11 @@ -## can_delete +# can_delete [[Source]
](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/CanDelete.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -60,7 +60,7 @@ a successful result containing the following fields: Use this command with no parameter to query the existing `can_delete` setting. -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `notEnabled` - Not enabled in configuration. diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md index f224944ec3..fcc60d9fc0 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md @@ -1,11 +1,11 @@ -## ledger_cleaner +# ledger_cleaner [[Source]
](https://github.com/ripple/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -35,7 +35,7 @@ The request includes the following parameters: | `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state objects in the specified ledger(s). Overrides `full` if provided. | | `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. | -#### Response Format +### Response Format An example of a successful response: @@ -62,7 +62,7 @@ The response follows the [standard format](#response-formatting), with a success |:----------|:-------|:---------------------------------| | `message` | String | `Cleaner configured` on success. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.) diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md index c8da29afd4..f82dd26b06 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md @@ -1,11 +1,11 @@ -## ledger_request +# ledger_request [[Source]
](https://github.com/ripple/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -37,7 +37,7 @@ The request includes the following parameters: You must provide either `ledger_index` or `ledger_hash` but not both. -#### Response Format +### Response Format The response follows the [standard format](#response-formatting). However, the request returns a failure response if it does not have the specified ledger _even if it successfully instructed the `rippled` server to start retrieving the ledger_. @@ -156,7 +156,7 @@ The three possible response formats are as follows: 2. When the response shows the server is currently fetching the ledger, the body of the result is a [Ledger Request Object](#ledger-request-object) indicating the progress of fetching the ledger from the peer-to-peer network. 3. When the ledger is fully available, the response is a representation of the [ledger header](reference-ledger-format.html#header-format). -#### Ledger Request Object +### Ledger Request Object When the server is in the progress of fetching a ledger, but has not yet finished, the `rippled` server returns a ledger request object indicating its progress towards fetching the ledger. This object has the following fields: @@ -171,7 +171,7 @@ When the server is in the progress of fetching a ledger, but has not yet finishe | `peers` | Number | How many peers the server is querying to find this ledger. | | `timeouts` | Number | Number of times fetching this ledger has timed out so far. | -#### Possible Errors +### 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. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger. diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md index 6dc8cb0423..b20c4a5f8e 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md @@ -1,11 +1,11 @@ -## log_level +# log_level [[Source]
](https://github.com/ripple/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -37,7 +37,7 @@ The request includes the following parameters: | `severity` | String | _(Optional)_ What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. | | `partition` | String | _(Optional)_ Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. | -#### Response Format +### Response Format Examples of successful responses: @@ -129,7 +129,7 @@ Otherwise, the request contains the following field: |:--------|:-------|:----------------------------------------------------------| | `level` | Object | The current log levels of each category. This list of categories is subject to change without notice in future releases. You can use the field names as values to `partition` in requests to this command. | -#### Possible Errors +### 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. diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md index adefcff788..0076cd1545 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md @@ -1,11 +1,11 @@ -## logrotate +# logrotate [[Source]
](https://github.com/ripple/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -29,7 +29,7 @@ rippled logrotate The request includes no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -70,6 +70,6 @@ The response follows the [standard format](#response-formatting), with a success |:----------|:-------|:--------------------------------------------------------| | `message` | String | On success, contains the message `The log file was closed and reopened.` | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md index dbe2452c2f..ebf33d7000 100644 --- a/content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md +++ b/content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md @@ -1,11 +1,11 @@ -## connect +# connect [[Source]
](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 +### Request Format An example of the request format: @@ -51,7 +51,7 @@ The request includes the following parameters: | `ip` | String | IP address of the server to connect to | | `port` | Number | _(Optional)_ Port number to use when connecting. Defaults to 6561. | -#### Response Format +### Response Format An example of a successful response: @@ -89,7 +89,7 @@ The response follows the [standard format](#response-formatting), with a success |:----------|:-------|:-------------------------------------------------------| | `message` | String | The value `connecting`, if the command was successful. | -#### Possible Errors +### 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. diff --git a/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md index f70f33e723..7eea1c56d5 100644 --- a/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md +++ b/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md @@ -1,11 +1,11 @@ -## ledger_accept +# ledger_accept [[Source]
](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -31,7 +31,7 @@ rippled ledger_accept The request accepts no parameters. -#### Response Format +### Response Format An example of a successful response: ```js @@ -53,7 +53,7 @@ The response follows the [standard format](#response-formatting), with a success **Note:** When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger. -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode. diff --git a/content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md index 3ab85d2789..6bc0d56bd2 100644 --- a/content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md +++ b/content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md @@ -1,11 +1,11 @@ -## stop +# stop [[Source]
](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Stop.cpp "Source") Gracefully shuts down the server. *The `stop` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!* -#### Request Format +### Request Format An example of the request format: @@ -40,7 +40,7 @@ rippled stop The request includes no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -78,6 +78,6 @@ The response follows the [standard format](#response-formatting), with a success |:----------|:-------|:-------------------------------------| | `message` | String | `ripple server stopping` on success. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md index cdaf2721a2..a0fa5a8382 100644 --- a/content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md +++ b/content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md @@ -1,11 +1,11 @@ -## validation_seed +# validation_seed [[Source]
](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -35,7 +35,7 @@ The request includes the following parameters: |:---------|:-------|:---------------------------------------------------------| | `secret` | String | _(Optional)_ If present, use this value as the secret value for the validating key pair. Valid formats include [base58][], [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. | -#### Response Format +### Response Format An example of a successful response: @@ -80,7 +80,7 @@ The response follows the [standard format](#response-formatting), with a success | `validation_public_key` | String | (Omitted if proposing disabled) The public key for these validation credentials, in Ripple's [base58][] encoded string format. | | `validation_seed` | String | (Omitted if proposing disabled) The secret key for these validation credentials, in Ripple's [base58][] encoded string format. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `badSeed` - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key. diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md index e8f5509265..a308774530 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md @@ -1,11 +1,11 @@ -## consensus_info +# consensus_info [[Source]
](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -41,7 +41,7 @@ rippled consensus_info The request has no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -223,6 +223,6 @@ It is also normal to get a minimal result where the only field in `info` is `"co The results of the `consensus_info` command can vary dramatically if you run it several times, even in short succession. -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md index af6f65fe8d..dddda3e324 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md @@ -1,4 +1,4 @@ -## feature +# feature [[Source]
](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Feature1.cpp "Source") The `feature` command returns information about [amendments](concept-amendments.html) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](concept-amendments.html#amendment-process). [New in: rippled 0.31.0][] @@ -7,7 +7,7 @@ You can use the `feature` command to temporarily configure the server to vote ag _The `feature` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._ -#### Request Format +### Request Format An example of the request format: @@ -64,7 +64,7 @@ The request includes the following parameters: **Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment. -#### Response Format +### Response Format An example of a successful response: @@ -182,7 +182,7 @@ The response follows the [standard format](#response-formatting), with a success **Caution:** The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers. -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). * `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name. diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md index 2867f79169..44343f2d0f 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md @@ -1,11 +1,11 @@ -## fetch_info +# fetch_info [[Source]
](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -48,7 +48,7 @@ The request includes the following parameters: |:--------|:--------|:---------------------------------------------------------| | `clear` | Boolean | If `true`, reset current fetches. Otherwise, only get status of fetches in progress. | -#### Response Format +### Response Format An example of a successful response: @@ -151,6 +151,6 @@ The fields describing a fetch in progress are subject to change without notice. | `peers` | Number | The number of peers who have this item available. | | `timeouts` | Number | The number of times that fetching this item has resulted in a timeout (2.5 seconds). | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md index 59b82ffde1..243d09d54a 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md @@ -1,11 +1,11 @@ -## get_counts +# get_counts [[Source]
](https://github.com/ripple/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source") 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._ -#### Request Format +### Request Format An example of the request format: @@ -48,7 +48,7 @@ The request includes the following parameters: |:------------|:--------------------------|:-----------------------------------| | `min_count` | Number (Unsigned Integer) | Only return fields with a value at least this high. | -#### Response Format +### Response Format An example of a successful response: @@ -142,7 +142,7 @@ The response follows the [standard format](#response-formatting). The list of fi For most other entries, the value indicates the number of objects of that type currently in memory. -#### Possible Errors +### 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. diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md index dad423853d..e228c6cfc7 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md @@ -1,11 +1,11 @@ -## peers +# peers [[Source]
](https://github.com/ripple/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -29,7 +29,7 @@ rippled peers The request includes no additional parameters. -#### Response Format +### Response Format An example of a successful response: @@ -404,6 +404,6 @@ Each member of the `peers` array is a peer object with the following fields: | `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. [New in: rippled 0.30.1][] | | `version` | string | (May be omitted) The `rippled` version number of the peer server | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md index 34a29394e3..28372d4724 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md @@ -1,11 +1,11 @@ -## print +# print [[Source]
](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -29,7 +29,7 @@ rippled print The request includes no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -226,6 +226,6 @@ Connecting to 127.0.0.1:5005 The response follows the [standard format](#response-formatting). Additional fields in the result depend on the internal state of the `rippled` server. The results of this command are subject to change without notice. -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md index c0f2a27b0c..72518c3732 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md @@ -1,11 +1,11 @@ -## validator_list_sites +# validator_list_sites [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -41,7 +41,7 @@ rippled validator_list_sites The request includes no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -124,6 +124,6 @@ Each member of the `validator_sites` field array is an object with the following | `refresh_interval_min` | Unsigned Integer | The number of minutes between refresh attempts. | | `uri` | String | The URI of the site. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md index e172503206..b15ea18e58 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md @@ -1,11 +1,11 @@ -## validators +# validators [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source") 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!* -#### Request Format +### Request Format An example of the request format: @@ -41,7 +41,7 @@ rippled validators The request includes no parameters. -#### Response Format +### Response Format An example of a successful response: @@ -172,6 +172,6 @@ Each member of the `publisher_lists` array is an object with the following field | `seq` | Unsigned Integer | The sequence number of this published list. | | `version` | Unsigned Integer | The version of the list format. | -#### Possible Errors +### Possible Errors * Any of the [universal error types](#universal-errors). diff --git a/dactyl-config.yml b/dactyl-config.yml index 9ebea8c7ef..1246b5d77a 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -570,8 +570,9 @@ pages: # - Server Info Methods (3) # - Utility Methods (3) - - md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md + - name: Admin rippled Methods html: admin-rippled-methods.html + blurb: 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. funnel: Docs doc_type: References supercategory: rippled API @@ -583,6 +584,7 @@ pages: - name: Key Generation Methods #TODO: possible md landing content? html: key-generation-methods.html + blurb: Use these methods to generate and manage keys. funnel: Docs doc_type: References supercategory: rippled API @@ -594,6 +596,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md html: validation_create.html + blurb: Generate keys for a new rippled validator. funnel: Docs doc_type: References supercategory: rippled API @@ -604,6 +607,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md html: wallet_propose.html + blurb: Generate keys for a new account. funnel: Docs doc_type: References supercategory: rippled API @@ -614,6 +618,7 @@ pages: - name: Logging and Data Management Methods html: logging-and-data-management-methods.html + blurb: Use these methods to manage log levels and other data, such as ledgers. funnel: Docs doc_type: References supercategory: rippled API @@ -625,6 +630,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md html: can_delete.html + blurb: Allow online deletion of ledgers up to a specific ledger. funnel: Docs doc_type: References supercategory: rippled API @@ -635,6 +641,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md html: ledger_cleaner.html + blurb: Configure the ledger cleaner service to check for corrupted data. funnel: Docs doc_type: References supercategory: rippled API @@ -645,6 +652,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md html: ledger_request.html + blurb: Query a peer server for a specific ledger version. funnel: Docs doc_type: References supercategory: rippled API @@ -655,6 +663,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md html: log_level.html + blurb: Get or modify log verbosity. funnel: Docs doc_type: References supercategory: rippled API @@ -665,6 +674,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md html: logrotate.html + blurb: Reopen the log file. funnel: Docs doc_type: References supercategory: rippled API @@ -675,6 +685,7 @@ pages: - name: Server Control Methods html: server-and-control-methods.html + blurb: Use these methods to manage the rippled server. funnel: Docs doc_type: References supercategory: rippled API @@ -686,7 +697,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.md html: connect.html - funnel: docs + blurb: Force the rippled server to connect to a specific peer. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -696,7 +708,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md html: ledger_accept.html - funnel: docs + blurb: Close and advance the ledger in stand-alone mode. + funnel: Docs doc_type: References supercategory: category: Admin rippled Methods @@ -706,7 +719,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/server-control-methods/stop.md html: stop.html - funnel: docs + blurb: Shut down the rippled server. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -716,7 +730,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md html: validation_seed.html - funnel: docs + blurb: Temporarily set key to be used for validating. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -726,6 +741,7 @@ pages: - name: Status and Debugging Methods html: status-and-debugging-methods.html + blurb: Use these methods to check the status of the network and server. funnel: Docs doc_type: References supercategory: rippled API @@ -738,7 +754,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md html: consensus_info.html - funnel: docs + blurb: Get information about the state of consensus as it happens. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -748,7 +765,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md html: feature.html - funnel: docs + blurb: Get information about protocol amendments. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -758,7 +776,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md html: fetch_info.html - funnel: docs + blurb: Get information about the server's sync with the network. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -768,7 +787,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md html: get_counts.html - funnel: docs + blurb: Get statistics about the server's internals and memory usage. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -778,7 +798,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md html: peers.html - funnel: docs + blurb: Get information about the peer servers connected. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -788,7 +809,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md html: print.html - funnel: docs + blurb: Get information about internal subsystems. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -798,7 +820,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md html: validator_list_sites.html - funnel: docs + blurb: Get information about sites that publish validator lists. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -808,7 +831,8 @@ pages: - md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md html: validators.html - funnel: docs + blurb: Get information about the current validators. + funnel: Docs doc_type: References supercategory: rippled API category: Admin rippled Methods @@ -816,13 +840,6 @@ pages: targets: - local - - - # TODO: Subcategory landings and pages for: - # - Logging and Data Management Methods (5) - # - Server Control Methods (4) - # - Status and Debugging Messages (8) - - md: references/rippled-api/ledger-data-formats/ledger-data-formats.md html: ledger-data-formats.html funnel: Docs From 0eb4a89efcde76f5c7ab4f34a4215dc88a7e673e Mon Sep 17 00:00:00 2001 From: Ryan Young Date: Wed, 9 May 2018 14:15:10 -0700 Subject: [PATCH 4/6] added missing supercategory value --- dactyl-config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dactyl-config.yml b/dactyl-config.yml index 1246b5d77a..2301653eb7 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -711,7 +711,7 @@ pages: blurb: Close and advance the ledger in stand-alone mode. funnel: Docs doc_type: References - supercategory: + supercategory: rippled API category: Admin rippled Methods subcategory: Server Control Methods targets: From 46fe1caff230ff2c5fdeaa011c5c0d86d4465607 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 10 May 2018 13:19:58 -0700 Subject: [PATCH 5/6] Reorg - redo admin methods landing page w/ deprecated methods --- .../admin-rippled-methods.md | 40 ++++++++++++++----- .../rippled-api/rippled-old-monolith.md | 29 -------------- dactyl-config.yml | 4 +- 3 files changed, 33 insertions(+), 40 deletions(-) diff --git a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md index 7be65727a3..cf0c834fbf 100644 --- a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md @@ -5,16 +5,38 @@ 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. - -* **[Key Generation Methods](key-generation-methods.html)** - +## List of Admin Methods -* **[Logging and Data Management Methods](logging-and-data-management-methods.html)** - +* [`can_delete` - Allow online deletion of ledgers up to a specific ledger](can_delete.html) +* [`connect` - Force the rippled server to connect to a specific peer](connect.html) +* [`consensus_info` - Get information about the state of consensus as it happens](consensus_info.html) +* [`feature` - Get information about protocol amendments](feature.html) +* [`fetch_info` - Get information about the server's sync with the network](fetch_info.html) +* [`get_counts` - Get statistics about the server's internals and memory usage](get_counts.html) +* [`ledger_accept` - Close and advance the ledger in stand-alone mode](ledger_accept.html) +* [`ledger_cleaner` - Configure the ledger cleaner service to check for corrupted data](ledger_cleaner.html) +* [`ledger_request` - Query a peer server for a specific ledger version](ledger_request.html) +* [`log_level` - Get or modify log verbosity](log_level.html) +* [`logrotate` - Reopen the log file](logrotate.html) +* [`peers` - Get information about the peer servers connected](peers.html) +* [`print` - Get information about internal subsystems](print.html) +* [`stop` - Shut down the rippled server](stop.html) +* [`validation_create` - Generate keys for a new rippled validator](validation_create.html) +* [`validation_seed` - Temporarily set key to be used for validating](validation_seed.html) +* [`validators` - Get information about the current validators](validators.html) +* [`validator_list_sites` - Get information about sites that publish validator lists](validator_list_sites.html) +* [`wallet_propose` - Generate keys for a new account](wallet_propose.html) -* **[Server Control Methods](server-and-control-methods.html)** - +## Deprecated Methods -* **[Status and Debugging Methods](status-and-debugging-methods.html)** - +The following admin commands are deprecated and may be removed without further notice: + +* `ledger_header` - Use the [ledger method][] instead. +* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead. +* `wallet_seed` - Use the [wallet_propose method][] instead. + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/references/rippled-api/rippled-old-monolith.md b/content/references/rippled-api/rippled-old-monolith.md index ed0f1252f7..2e094256a5 100755 --- a/content/references/rippled-api/rippled-old-monolith.md +++ b/content/references/rippled-api/rippled-old-monolith.md @@ -556,35 +556,6 @@ API methods for the Websocket and JSON-RPC APIs are defined by command names, an The `owner_info` command is deprecated. Use [`account_objects`](#account-objects) instead. -## List of Admin Commands - -Admin commands are only available if you [connect to `rippled`](#connecting-to-rippled) on a host and port that the config file identifies as admin. (By default, the commandline client uses an admin connection.) - -* [`can_delete` - Allow online deletion of ledgers up to a specific ledger](#can-delete) -* [`connect` - Force the rippled server to connect to a specific peer](#connect) -* [`consensus_info` - Get information about the state of consensus as it happens](#consensus-info) -* [`feature` - Get information about protocol amendments](#feature) -* [`fetch_info` - Get information about the server's sync with the network](#fetch-info) -* [`get_counts` - Get statistics about the server's internals and memory usage](#get-counts) -* [`ledger_accept` - Close and advance the ledger in stand-alone mode](#ledger-accept) -* [`ledger_cleaner` - Configure the ledger cleaner service to check for corrupted data](#ledger-cleaner) -* [`ledger_request` - Query a peer server for a specific ledger version](#ledger-request) -* [`log_level` - Get or modify log verbosity](#log-level) -* [`logrotate` - Reopen the log file](#logrotate) -* [`peers` - Get information about the peer servers connected](#peers) -* [`print` - Get information about internal subsystems](#print) -* [`stop` - Shut down the rippled server](#stop) -* [`validation_create` - Generate keys for a new rippled validator](#validation-create) -* [`validation_seed` - Temporarily set key to be used for validating](#validation-seed) -* [`validators` - Get information about the current validators](#validators) -* [`validator_list_sites` - Get information about sites that publish validator lists](#validator-list-sites) -* [`wallet_propose` - Generate keys for a new account](#wallet-propose) - -The following admin commands are deprecated and may be removed without further notice: - -* `ledger_header` - Use the [`ledger` command](#ledger) instead. -* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead. -* `wallet_seed` - Use [`wallet_propose`](#wallet-propose) instead. ## Commandline Access diff --git a/dactyl-config.yml b/dactyl-config.yml index 2301653eb7..68e70edadf 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -570,7 +570,7 @@ pages: # - Server Info Methods (3) # - Utility Methods (3) - - name: Admin rippled Methods + - md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md html: admin-rippled-methods.html blurb: 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. funnel: Docs @@ -582,7 +582,7 @@ pages: targets: - local - - name: Key Generation Methods #TODO: possible md landing content? + - name: Key Generation Methods html: key-generation-methods.html blurb: Use these methods to generate and manage keys. funnel: Docs From 271cc00bbe35aa40468b3af0a592c2190bfee495 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 10 May 2018 13:20:57 -0700 Subject: [PATCH 6/6] fix ledger_request blurb nit (query peer servers plural) --- dactyl-config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dactyl-config.yml b/dactyl-config.yml index 68e70edadf..e0a20f8347 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -652,7 +652,7 @@ pages: - md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md html: ledger_request.html - blurb: Query a peer server for a specific ledger version. + blurb: Query peer servers for a specific ledger version. funnel: Docs doc_type: References supercategory: rippled API