Cluster Configuration Management Commands
Cluster configuration management commands are designed for working with the configuration at the level of the entire YDB cluster. These commands allow cluster administrators to view, modify, and manage settings that apply to all cluster nodes.
Alert
Commands in this section can harm your cluster if used incorrectly. Due to the potentially dangerous nature of these commands, ALL global parameters must be specified explicitly. Profiles are disabled by default and are only used when explicitly specified (--profile
General syntax for calling cluster configuration management commands:
ydb [global options] admin cluster config [command options] <subcommand>
Where:
ydb– The command to run the YDB CLI from the operating system command line.[global options]– Global options, common to all YDB CLI commands.admin cluster config– The command for managing cluster configuration.[command options]– Command options specific to each command and subcommand.<subcommand>– The subcommand.
Commands
The following is a list of available subcommands for managing cluster configuration. Any command can be called from the command line with the --help option to get help for it.
| Command / Subcommand | Brief Description |
|---|---|
| admin cluster config fetch | Fetch the current dynamic configuration (aliases: get, dump) |
| admin cluster config generate | Generate dynamic configuration from the static startup configuration |
| admin cluster config replace | Replace the dynamic configuration |