Performs various roll-forward recovery activities, depending on the qualifier you supply.

Syntax

rfutil -help db-name -C qualifier 
     [ [-userid username[-password password]]|
       [ -U username -P password ]]
         [-Passphrase] [-Pin]

Parameters

-help
Displays syntax for utility and specified subcommands. If the syntax displayed ends with ellipses, type the command shown followed by -help to view subcommand syntax.
db-name
Specifies the name of the database you are using.
-C
Specifies a particular utility or function when you use the RFUTIL command.
qualifier
Specifies the qualifier that you want to use. You can supply the qualifiers listed in Table 1.
-userid username[-password passwd] -U username -P passwd

A pair of username and password parameters are used together to support a common user authentication model to specify the user ID and password when connecting to an OpenEdge RDBMS. OpenEdge authenticates the user ID and password against the user accounts defined by the authentication system configured for the user's security domain.

Use username and password parameters to identify an authenticated Database Administrator.

If you do not specify a user ID and password for a database connection, OpenEdge assigns user ID of the OS process as the default user ID.

For more information on authentication systems and security domains, see OpenEdge Getting Started: Identity Management.

-Passphrase

For encryption-enabled databases only, directs RFUTIL to prompt for a passphrase to authenticate the keystore. Utilities that open the database must authenticate as the key store user, at a minimum. Utilities that modify encryption policies (such as enabling or disabling encryption of after-image files) must authenticate as the keystore admin. For more information on the keystore passphrase, see Database keystore.

If your database is enabled for TDE and configured for manual start, you must specify -Passphrase every time the database is opened.

Note:
  • The -passphrase parameter is required for every utility that modifies encryption policies on databases enabled with TDE
  • RFUTIL and its qualifiers support the use of internationalization startup parameters such as -cpinternal codepage and -cpstream codepage. See Database server internationalization parameters for a description of database-related internationalization startup parameters.
-Pin
After you enable HSM as a secondary authentication requirement for a TDE-enabled database, both passphrase and PIN are required to authenticate the keystore. The -Pin qualifier never applies for a remote connection.

The following table lists the RFUTIL qualifiers. See the appropriate section for each of the qualifiers for more detailed information.

Table 1. RFUTIL utility qualifiers
Qualifier Description
AIARCHIVER DISABLE Disables the AI File Management Utility.
AIARCHIVER ENABLE Enables the AI File Management Utility.
AIARCHIVER END Shuts down the AI File Management Utility daemon.
AIARCHIVER SETDIR Changes the archive destination directory list for the AI File Management Utility daemon.
AIARCHIVER SETINTERVAL Changes the value of the archive interval for the AI File Management Utility daemon.
AIARCHIVE EXTENT Manually archives the specified AI extent when AI File Management Utility is not running.
AIMAGE AIOFF Disables after-imaging for a database during maintenance.
AIMAGE BEGIN Enables after-imaging for a database.
AIMAGE END Disables after-imaging for a database.
AIMAGE EXTENT EMPTY Marks an AI extent as empty and informs the database manager that the indicated AI extent has been manually backed up and is now free for reuse.
AIMAGE EXTENT FULL Displays the path name of the oldest filled file.
AIMAGE EXTENT LIST Displays information about extents.
AIMAGE EXTRACT Extracts the active blocks of an AI extent and writes them to a file.
AIMAGE NEW Switches after-imaging to the next AI extent.
AIMAGE QUERY Queries an AI extent for status.
AIMAGE SCAN Scans AI files and displays information for the files.
AIMAGE SUMMARY Scans an AI file and displays information from its first and last block.
AIMAGE TRUNCATE Truncates all of the variable-length AI extents and optionally sets the AI block size with the After-image Block Size (-aiblocksize) parameter.
AIVERIFY PARTIAL Verifies the AI extent by validating AI files before they are applied. This verification focuses on the AI block and the rlnote structure (note headers), while providing additional information in error messages that specify issues found in the AI extent.
AIVERIFY FULL Verifies the full AI extent, including verification of note data members.
MARK BACKEDUP Marks the database file, indicating that you have just completed a backup of the database.
ROLL FORWARD Reconstructs a database by applying all notes stored in the AI file to that database.
ROLL FORWARD OPLOCK Enforces a protection mechanism during the roll forward process, to prevent interruption to the target database before the final roll forward session is completed.
ROLL FORWARD RETRY Restarts the roll-forward operation on the AI extent that was in the process of rolling forward. The retry operation finds the transaction in process at the time of failure and resumes rolling forward.
ROLL OPUNLOCK Cancels the roll forward protection established by ROLL FORWARD OPLOCK.
SEQUENCE Updates the after-image sequence number of a database.
Note: You cannot use RFUTIL against a database in single-user mode.

The RFUTIL entries that follow describe each of these qualifiers.