DFuserdb

DFuserdb — Perform maintenance operations on the user database

Synopsis

DFuserdb [-help] [-fsck] [-reset] [-reset2fa] [-dump2fa] [-stats] [-unlock] [-migrate] [-export filename] [-import filename]

Description

DFuserdb is used to perform maintenance operations such as import/export on the user and role database.

Invoked without arguments DFuserdb works in interactive mode. Allowable commands match the options listed here, but without the leading dash.

Options

-help

print a list of the commands available.

-fsck

perform a consistency check on the database. If there are no consistency errors in the database structure only the message FSCK done will be output. If errors do exist, the database will need to be rebuilt by using the -import option along with a copy of the DFuserdb.log as input.

-reset

used to reset the datafax password and administrator status in cases where it has been accidentally altered.

-reset2fa

clear all of the devices that have been verified with two-factor authentication security codes. This will force all logins that require two-factor authentication to re-acquire and enter security codes during next login.

-dump2fa

list all of the devices that have been recently verified with two-factor authentication security codes.

-stats

display information about the database version and the number of records in the database for each of the indices.

-unlock

reset the database synchronization locks in cases where they may be stuck after system failures.

-migrate

convert a pre-3.8 DFdiscover user and permissions databases to the new database. It must be run as root and can only be run on a newly created database. The -migrate option reads the DFperm file and consults /etc/passwd and the ROUTER_USERS parameter in to create user entries and then traverses all studies listed in , reads the lib/DFaccess_perms and lib/.DFrep_excl files and generates roles, role permissions and user role entries.

-export outfile

export (write) the user and role database information to the argument filename.

-import infile

import (read) user and role database information from the argument filename. The file is expected to be in the DFuserdb.log format. If the entire database is to be rebuilt, the old DFuserdb.log and DFuserdb.idx files should first be removed. In this case, DFuserdb will create a new database and import the file.

Exit Status

DFuserdb exits with one of the following statuses:

0

The command was successful.

2

An error occurred.