Reconstructs a database by applying to that database all notes stored in the AI file.

Syntax

rfutil db-name -C roll forward [ verbose ]
      [    endtime yyyy:mm:dd:hh:mm:ss| endtrans transaction-number]
      [ -B n][ -r ]{-a ai-name|-ailist listfile}[ -HSMLibrary library_path -Pin {-HSMSlotID slot_number | -HSMLabel token_label}]

Parameters

db-name

Specifies the database you are using.

verbose

Produces information for every note in the AI area.

-a ai-name

Identifies the AI area of the specified database.

-ailist listfile

Identifies a file containing a list of AI area files. The listfile file must be structured as follows:

• Specify one AI file per line
• AI file names can be fully specified absolute file name or a relative file name relative to the working directory where RFUTIL is executed
• Lines that begin with a colon (:), hash mark (#), or asterisk (*) are treated as comments and skipped over for parsing

endtime

Specifies to roll forward to a certain time. You must specify the ending time as a string of digits and separate the date and time components with a colon. Transactions are included in the partial roll forward only if they end before the specified time. For example, to roll forward to 5:10 PM on July 18, 2002, type 2002:07:18:17:10:00. For RFUTIL to include a transaction in this partial roll forward, the transaction must have ended on or before 2002:07:18:17:09:59.

endtrans

Specifies to roll forward up to but not including the transaction beginning that contains the transaction-number. For example, if you specify endtrans 1000, RFUTIL rolls forward the AI area to transaction 999. If you want to include transaction 1000, you must specify endtrans 1001.

-B n

Specifies the number of database buffers. The single-user default value is 20.

-r

Indicates that buffered I/O will be used.

-HSMLibrary library-path

Specifies the location of the HSM client library, which must be an absolute path. This library is loaded at runtime and must be secured by the server administrator. For OpenEdge Replication, this location must be the same for the source and target machines because this record is replicated. Symlinks are disallowed because they are a security vulnerability. If you specify a library, you must also specify the PIN. The library must meet the requirements in the Notes section.

The location of the library in the database is controlled by EnableHSM, a PROUTIL EPOLICY MANAGE option that requires the TDE Admin passphrase to operate.

-Pin

Required with the library path to authenticate the keystore after you enable HSM as a secondary authentication requirement for a TDE-enabled database, The -Pin qualifier never applies for a remote connection.

-HSMSlotID slot-number

Specifies the numeric ID of the HSM device token as seen by the server HSM client library. This Slot ID is used to locate and connect to a specific HSM device token on the server.

This slot is stored in a special area block for the encryption area that must be retrievable at all times to open the keystore.

-HSMLabel label-name

Specifies an HSM admin assigned tag in the HSM device token, which is unique among all HSM tokens. Instead of using an HSM Slot ID, you can use this token to locate and connect to the assigned HSM token of your database. This label must be retrievable at all times to open the keystore.

If the system crashes while you are running the ROLL FORWARD operation, restore your database files again and rerun the ROLL FORWARD operation.

The ROLL FORWARD qualifier displays the following information:

• The start and end dates of the AI area being applied to the database
• The number of completed transactions reapplied to the database
• The number of transactions that were active after all AI notes were applied

The ROLL FORWARD qualifier fails if:

• You omit the After-image Filename (-a) or AI List (-ailist) parameter
• It cannot open the AI area
• You name the wrong AI area
• The database was opened before all AI extents were applied

Notes

• The ROLL FORWARD qualifier always disables after-imaging for the database before beginning the roll-forward operation. After the roll-forward has completed, you must re-enable it with the AIMAGE BEGIN qualifier if you want continued AI protection.
• You must apply all AI extents associated with the database in the same sequence they were generated before you can use the database.
• The optional parameters, HSMLibrary, HSMSlotID, and HSMLabel authorize keystore access for a newly-created keystore copied after an EnableHSM or DisableHSM operation. After the HSM feature is enabled internally on the hot standby database, the parameter is no longer required. For more information, see Perform roll-forward recovery on encryption-enabled databases and Enable HSM support for a TDE enabled database.
• The HSM library must meet one or both platform-specific requirements:
  • On Linux:

    • The library must be in one of these four directories: /lib, /usr/lib,/lib64,/usr/lib64.

    • The file and group owner are both root.

  • On Windows:

    • The library is in C:\Program Files, C:\Windows, C:\Windows\System32, or anywhere below those folders.

    • The owner of the library is the Administrator or SYSTEM account.