Admin CLI
This topic summarizes the Dremio administrator, dremio-admin
, CLI commands.
Syntax
dremio-admin [--config <conf-dir>] (backup|clean|delete-all-users|reset-catalog-search|restore|set-password|upgrade) [args...]
Options
Command | Description |
---|---|
--help, -h | Displays online help information for the CLI commands. |
--config <conf-dir> | Used when your configuration file location is different than the /opt/dremio/conf directory. For example, if you put the dremio.conf, dremio-env, logbook.xml, and logbook-admin.xml files
under the /etc/dremio directory, you will have to run all the |
backup | Backs up Dremio metadata and user-upoaded files. |
clean | Cleans Dremio metadata. |
delete-all-users | Deletes all internal dremio users and their home spaces. |
encrypt | Allows administrator to provide secret for use with third-party services, like LDAP, which may require secure credential entry. The output URI should be copied and pasted into the Dremio configuration file. |
reset-catalog-search | Reset index to recover catalog search. |
restore | Restores Dremio metadata and user-upoaded files. |
set-password | Sets passwords for Dremio users (non-LDAP). |
repair-acls | Repairs access control lists of sources, spaces, and datasets. This command should be used to repair the KVStore if problems arise when upgrading to Dremio 16.0+. |
upgrade | Upgrades the KV store version. There are no options available for this command. |
export-profiles | Exports Job profiles to the specified location. |
Log Directory
The default value for DREMIO_ADMIN_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:
export DREMIO_ADMIN_LOG_DIR=<path>
note:
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:
export DREMIO_ADMIN_LOG_VERBOSITY=<value>