Managing HVDB Cleanup from the Command Line

Edit online

Use the Manual Database Cleanup Tasks command mode to start one or more cleanup tasks, or check the status of tasks that are in progress.

About this task

Multiple components perform cleanup and archival tasks to remove expired or otherwise unnecessary data from the High-Volume Database (HVDB):

  • User sessions
  • Mobile multi-factor authentication (MMFA)
  • OAuth 2.0
  • Device registration
  • Distributed map
The cleanup and archival tasks that are described in this section apply only to Advanced Access Control and Federation components.
Note: Changes made to advanced configuration properties modify the behavior of cleanup tasks.

These command line modes can be accessed from either a terminal, or SSH session to Verify Identity Access

Procedure

  1. Connect to a command line interface to Verify Identity Access
    • Use a terminal.
    • Use an SSH session.
  2. Select the isam mode command. Then select the aac mode command.
    Note: The help mode commands displays a summary of all the available commands and examples of usage.
  3. The start_tasks command mode can be used to queue one or more cleanup tasks.
    1. Task list should be given as a comma separated list of tasks
    2. valid task names include: mmfaTransactions, mmfaAuthenticators, oauthTokens, dmapCache, deviceRegistrations, and authsvcSessionCache
  4. The task_status command mode can be used to get the status of the HVDB cleanup tasks.
  5. The cancel_tasks command mode can be used to cancel any queued HVDB cleanup tasks.
    Note: The cancel_tasks command does not stop any cleanup tasks that are already running. If a task needs to be stopped, administrators can use the lmi restart command mode to restart the management interface.