Admin CLI
This topic summarizes the dremio-admin CLI commands.
Syntax
{{< codeheader "Syntax for dremio-admin commands" >}}
dremio-admin [--config <conf-dir>] (backup|clean|delete-all-users|export-profiles|encrypt|nessie-maintenance|remove-duplicate-roles|repair-acls|reset-catalog-search|restore|set-password|upgrade) [args...]
Options
| Option | Description |
|---|---|
--help, -h | Displays usage information for the CLI commands. |
--config <conf-dir> | Used when the configuration file location is different than the /opt/dremio/conf default directory. For example, if dremio.conf, dremio-env, logbook.xml, and logbook-admin.xml are located in /etc/dremio, you will have to run all of the dremio-admin commands as ./dremio-admin --config /etc/dremio <command> <arguments>. |
Commands
| Command | Description |
|---|---|
backup | Backs up Dremio metadata and user-uploaded files. |
clean | Cleans Dremio metadata. |
delete-all-users | Deletes all internal dremio users and their home spaces. |
encrypt | Allows the administrator to encrypt a plain text secret in the Dremio configuration files. |
export-profiles | Exports Job profiles to the specified location. |
nessie-maintenance | Purges unused embedded Nessie data from the KV store. |
remove-duplicate-roles | Removes duplicate LDAP groups or local roles and consolidates into a single role. |
reset-catalog-search | Reset index to recover catalog search. |
repair-acls | Repairs access control lists of sources, spaces, and datasets. This command should be used to repair the KV store if problems arise when upgrading to Dremio 16.0+. |
restore | Restores Dremio metadata and user-uploaded files. |
set-password | Sets passwords for Dremio users (non-LDAP). |
upgrade | Upgrades the KV store version. There are no options available for this command. |
Log Directory
The default value for DREMIOADMIN_LOG_DIR is null / not set. When this parameter is _not set, log files are not created.
To set the log directory, provide the log directory path by running the following:
{{< codeheader "Set log directory" >}}
export DREMIO_ADMIN_LOG_DIR=<path>
The export option must be set and access must be available for the user running the dremio-admin command.
Log Verbosity
Log verbosity is used in conjunction with DREMIO_ADMIN_LOG_DIR.
Otherwise, all the output is printed to stdout; there is no control on setting verbosity for stdout.
Verbosity options include:
- TRACE
- DEBUG
- INFO (default)
- WARN
- ERROR
To set the log verbosity (default: INFO), provide the verbose level by running the following:
{{< codeheader "Set log verbosity" >}}
export DREMIO_ADMIN_LOG_VERBOSITY=<value>