Skip to main content
Version: current [25.0.x]

Admin CLI

This topic summarizes the dremio-admin CLI commands.


Syntax for dremio-admin commands
dremio-admin [--config <conf-dir>] (encrypt|set-password|upgrade|recommend-reflections|delete-user-homespace|optimize-acls|export-profiles|remove-duplicate-users|clean|remove-duplicate-roles|reset-catalog-search|backup|delete-all-users|restore|repair-acls|nessie-maintenance) [args...]


--help, -hDisplays 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>.


backupBacks up Dremio metadata and user-uploaded files.
cleanCleans Dremio metadata.
delete-all-usersDeletes all internal Dremio users.
delete-user-homespaceDeletes the user's home space.
encryptEncrypt a user-supplied string.
export-profilesExports profiles of jobs from Dremio.
nessie-maintenanceRuns embedded Nessie repository maintenance tasks.
optimize-aclsOptimizes access control lists of sources, spaces, and datasets.
recommend-reflectionsRecommend reflections.
remove-duplicate-rolesRemoves duplicate roles from Dremio.
remove-duplicate-usersRemoves duplicate users from Dremio.
reset-catalog-searchResets index to recover catalog search.
repair-aclsRepairs access control lists of sources, spaces, and datasets.
restoreRestores Dremio metadata and user-uploaded files.
set-passwordSets passwords for Dremio users (non-LDAP).
upgradeUpgrades 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:

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:

  • INFO (default)
  • WARN

To set the log verbosity (default: INFO), provide the verbose level by running the following:

Set log verbosity

For More Information