HELPLIB.HLB  —  RMU72  Dump  Backup File, Command Qualifiers

1  –  Active IO

    Active_IO=max-reads

    Specifies the maximum number of read operations from the
    backup file that the RMU Dump Backup_File command will attempt
    simultaneously. The value of the Active_IO qualifier can range
    from 1 to 5. The default value is 3. Values larger than 3 might
    improve performance with multiple tape drives.

2  –  Area

    Area=identity

    Only dump the storage area identified by the specified name or
    ID number. The area name must be the name of a storage area in
    the database root file and the area ID number must be a storage
    area ID number in the database root file. This information is
    contained in the "Database Parameters:" section of the backup
    file which is output at the start of the dump. Snapshot areas are
    not contained in the backup file and cannot be specified. If this
    qualifier is used without the /START and /END qualifiers, all
    page records in the specified storage area will be output.

3  –  Disk File

    Disk_File=[(Reader_Threads=integer)]

    Specifies that you want to dump a multiple disk backup file. This
    is a backup file that was created by the RMU Backup command with
    the Disk_File qualifier.

    The Reader_Threads keyword specifies the number of threads that
    Oracle RMU should use when performing a multithreaded read
    operation from disk files. You can specify no more than one
    reader thread per device specified on the command line (or in the
    command parameter options file). By default, one reader thread is
    used.

    This qualifier and all qualifiers that control tape operations
    (Label, Media_Loader, and Rewind) are mutually exclusive.

4  –  Encrypt

    Encrypt=({Value=|Name=}[,Algorithm=])

    Specify a key value as a string or, the name of a predefined
    key. If no algorithm name is specified the default is DESCBC.
    For details on the Value, Name and Algorithm parameters see HELP
    ENCRYPT.

    This feature requires the OpenVMS Encrypt product to be installed
    and licensed on this system.

5  –  End

    End=integer

    Only dump pages ending with the specified page number in the
    specified storage area. This qualifier cannot be used unless
    the /AREA qualifier is also specified. If no pages are dumped,
    either the specified page or range of pages does not exist in
    the specified area in the backup file, or this qualifier has been
    used in the same RMU/DUMP/BACKUP command as an /OPTIONS, /SKIP or
    /PROCESS qualifier option that has excluded the specified page or
    range of pages from the dump. If this qualifier is not used with
    the /START qualifier, all page records in the specified storage
    area ending with the specified page number will be output.

    If both the /START and /END qualifiers are specified, the
    starting page number must be less than or equal to the ending
    page number. If the starting page number equals the ending page
    number only the page records for the specified page number are
    dumped. The block header for each block which contains at least
    one of the requested pages is dumped followed by the requested
    page records in that block. The START AREA record is dumped at
    the start of requested page records and the END AREA record is
    dumped at the end of the requested page records. By default, the
    database root parameters are dumped at the very start following
    the dump header.

6  –  Journal

    Journal=file-name

    Allows you improve tape performance by the dump backup file
    operation by specifying the journal file created by the RMU
    Backup command with the Journal qualifier.

    The RMU Backup command with the Journal qualifier creates the
    journal file and writes to it a description of the backup
    operation, including identification of the tape volumes, their
    contents, and the tape drive name.

    The RMU Dump Backup File with the Journal qualifier directs
    the RMU Dump Backup_File command to read the journal file
    and identify the tape volumes when the Label qualifier is not
    specified.

    The journal file must be the one created at the time the backup
    operation was performed. If the wrong journal file is supplied,
    an informational message is generated, and the specified journal
    file is not used to identify the volumes to be processed.

7  –  Label

    Label=(label-name-list)

    Specifies the 1- to 6-character string with which the volumes
    of the backup file have been labeled. The Label qualifier is
    applicable only to tape volumes. You must specify one or more
    label names when you use the Label qualifier.

    You can specify a list of tape labels for multiple tapes. If you
    list multiple tape label names, separate the names with commas,
    and enclose the list of names within parentheses.

    In a normal dump backup operation, the Label qualifier you
    specify with the RMU Dump Backup_File command should be the same
    Label qualifier as you specified with the RMU Backup command that
    backed up your database.

    If no label is specified, the system will internally generate one
    consisting of the first six characters in the backup-file-spec
    parameter.

    See the Oracle Rdb Guide to Database Maintenance for information
    on tape label processing.

    The Label qualifier can be used with indirect file references.
    See Indirect-Command-Files for more information.

8  –  Librarian

    Librarian=options

    Use the Librarian qualifier to restore files from data archiving
    software applications that support the Oracle Media Management
    interface. The file name specified on the command line identifies
    the stream of data to be retrieved from the Librarian utility. If
    you supply a device specification or a version number it will be
    ignored.

    Oracle RMU supports retrieval using the Librarian qualifier only
    for data that has been previously stored by Oracle RMU using the
    Librarian qualifer.

    The Librarian qualifier accepts the following options:

    o  Reader_Threads=n

       Use the Reader_Threads option to specify the number of backup
       data streams to read from the Librarian utility. The value of
       n can be from 1 to 99. The default is one reader thread. The
       streams are named BACKUP_FILENAME.EXT, BACKUP_FILENAME.EXT02,
       BACKUP_FILENAME.EXT03, up to BACKUP_FILENAME.EXT99. BACKUP_
       FILENAME.EXT is the backup file name specified in the RMU
       Backup command.

       The number of reader threads specified for a database restore
       from the Librarian utility should be equal to or less than the
       number of writer threads specified for the database backup.
       If the number of reader threads exceeds the number of writer
       threads, the number of reader threads is set by Oracle RMU
       to be equal to the number of data streams actually stored
       in the Librarian utility by the backup. If the number of
       reader threads specified for the restore is less than the
       number of writer threads specified for the backup, Oracle RMU
       will partition the data streams among the specified reader
       threads so that all data streams representing the database are
       restored.

       The Volumes qualifier cannot be used with the Librarian
       qualifer. Oracle RMU sets the volume number to be the actual
       number of data streams stored in the specified Librarian
       utility.

    o  Trace_file=file-specification

       The Librarian utility writes trace data to the specified file.

    o  Level_Trace=n

       Use this option as a debugging tool to specify the level of
       trace data written by the Librarian utility. You can use a
       pre-determined value of 0, 1, or 2, or a higher value defined
       by the Librarian utility. The pre-determined values are :

       -  Level 0 traces all error conditions. This is the default.

       -  Level 1 traces the entry and exit from each Librarian
          function.

       -  Level 2 traces the entry and exit from each Librarian
          function, the value of all function parameters, and the
          first 32 bytes of each read/write buffer, in hexadecimal.

    o  Logical_Names=(logical_name=equivalence-value,...)

       You can use this option to specify a list of process logical
       names that the Librarian utility can use to specify catalogs
       or archives where Oracle Rdb backup files are stored,
       Librarian debug logical names, and so on. See the specific
       Librarian documentation for the definition of logical names.
       The list of process logical names is defined by Oracle RMU
       prior to the start of any Oracle RMU command that accesses the
       Librarian utility.

    The following OpenVMS logical names must be defined for use with
    a Librarian utility before you execute an Oracle RMU backup or
    restore operation. Do not use the Logical_Names option provided
    with the Librarian qualifier to define these logical names.

    o  RMU$LIBRARIAN_PATH

       This logical name must be defined so that the shareable
       Librarian image can be loaded and called by Oracle RMU backup
       and restore operations. The translation must include the file
       type (for example, .exe), and must not include a version
       number. The shareable Librarian image must be an installed
       (known) image. See the Librarian implementation documentation
       for the name and location of this image and how it should be
       installed. For a parallel RMU backup, define RMU$LIBRARIAN_
       PATH as a system-wide logical name so that the multiple
       processes created by a parallel backup can all translate the
       logical.

       $ DEFINE /SYSTEM /EXECUTIVE_MODE -
       _$ RMU$LIBRARIAN_PATH librarian_shareable_image.exe

    o  RMU$DEBUG_SBT

       This logical name is not required. If it is defined, Oracle
       RMU will display debug tracing information messages from
       modules that make calls to the Librarian shareable image.
       For a parallel RMU backup, the RMU$DEBUG_SBT logical should
       be defined as a system logical so that the multiple processes
       created by a parallel backup can all translate the logical.

    The following lines are from a backup plan file created by the
    RMU Backup/Parallel/Librarian command:

        Backup File = MF_PERSONNEL.RBF
        Style = Librarian
        Librarian_trace_level = #
        Librarian_logical_names = (-
                 logical_name_1=equivalence_value_1, -
                 logical_name_2=equivalence_value_2)
        Writer_threads = #

    The "Style = Librarian" entry specifies that the backup is going
    to a Librarian utility. The "Librarian_logical_names" entry is
    a list of logical names and their equivalence values. This is an
    optional parameter provided so that any logical names used by a
    particular Librarian utility can be defined as process logical
    names before the backup or restore operation begins. For example,
    some Librarian utilities provide support for logical names for
    specifying catalogs or debugging.

    You cannot use device specific qualifiers such as Rewind,
    Density, or Label with the Librarian qualifier because the
    Librarian utility handles the storage meda, not Oracle RMU.

9  –  Media Loader

    Media_Loader
    Nomedia_Loader

    Use the Media_Loader qualifier to specify that the tape device
    from which the backup file is being read has a loader or stacker.
    Use the Nomedia_Loader qualifier to specify that the tape device
    does not have a loader or stacker.

    By default, if a tape device has a loader or stacker, Oracle
    RMU should recognize this fact. However, occasionally Oracle RMU
    does not recognize that a tape device has a loader or stacker.
    Therefore, when the first tape has been read, Oracle RMU issues a
    request to the operator for the next tape, instead of requesting
    the next tape from the loader or stacker. Similarly, sometimes
    Oracle RMU behaves as though a tape device has a loader or
    stacker when actually it does not.

    If you find that Oracle RMU is not recognizing that your tape
    device has a loader or stacker, specify the Media_Loader
    qualifier. If you find that Oracle RMU expects a loader or
    stacker when it should not, specify the Nomedia_Loader qualifier.

10  –  Options

    Options=options-list

    Specifies the type of information and level of detail the output
    will include. If you do not specify the Options qualifier or if
    you specify the Options=Normal qualifier, the backup file will
    be read, but dump output is not generated. This is useful for
    confirming that the backup file is structured correctly and
    the media is readable for the RMU Restore command. However,
    this command does not indicate if the data in a backup file is
    corrupted, nor does it guarantee that a restore operation will
    succeed.

    If you specify more than one option, you must separate the
    options with a comma, and enclose the options-list parameter
    within parentheses. Eight types of output are available:

    o  Records

       Dumps the backup file record structure.

    o  Blocks

       Dumps the backup file block structure.

    o  Data

       The Data option can be used with either the Records option,
       the Blocks option, or both. When specified with the Records
       and Blocks options, the Data option dumps the contents of the
       backup file's records and blocks. When you do not specify the
       Data option, the Records and Blocks options dump the backup
       file's record structure and block structure only, not their
       contents.

    o  Journal

       Dumps the contents of the journal file.

       Use the Journal option of the RMU Dump Backup_File command to
       direct Oracle RMU to dump the journal file created with the
       RMU Backup command with the Journal qualifier. The RMU Backup
       command with the Journal qualifier creates a journal file
       to which it writes a description of the backup operation,
       including identification of the tape volumes and their
       contents. You can use the output of the RMU Dump Backup_File
       with the Journal qualifier to identify the contents of each of
       the tapes that comprises the backup file.

    o  Root

       Dumps the database root file contents as recorded in the
       backup file. This includes a dump of the database backup
       header information.

    o  Normal

       The backup file will be read, but no dump output is generated.
       This is useful to verify the integrity of the backup file
       format and to detect media errors.

    o  Full

       Specifying the Full option is the same as specifying the Root,
       Records, and Blocks options. Includes a dump of the database
       backup header information. The contents of the backup file's
       record structure and block structure are not dumped when the
       Full option is specified.

    o  Debug

       Specifying the Debug option is the same as specifying the
       Root, Records, Blocks, Full, and Data options. The contents
       of the backup file's header, record structure, and block
       structure are dumped when the Debug option is specified.

11  –  Output

    Output=file-name

    Specifies the name of the file where output will be sent. The
    default is SYS$OUTPUT. The default output file type is .lis, if
    you specify a file name.

12  –  Process

    Process=process-list

    Specifies a list of keywords that determines how much of the
    backup file is to be dumped. If you specify more than one type
    of process-list option, separate the options with a comma, and
    enclose the process-list parameter within parentheses. You can
    specify the following three items in the process-list parameter:

    o  Volumes=integer

       The number of volumes to dump, starting at the position
       specified in the Skip qualifier for volumes. This option is
       ignored if the backup file does not reside on tape.

    o  Blocks=integer

       The number of blocks to dump, starting at the position
       specified in the Skip qualifier for blocks. This option is
       ignored if the backup file does not reside on tape.

    o  Records=integer

       The number of records to dump, starting at the position
       specified in the Skip qualifier for records. This option is
       valid regardless of whether the backup file resides on tape or
       disk.

13  –  Prompt

    Prompt=Automatic
    Prompt=Operator
    Prompt=Client

    Specifies where server prompts are to be sent. When you specify
    Prompt=Automatic, prompts are sent to the standard input device,
    and when you specify Prompt=Operator, prompts are sent to the
    server console. When you specify Prompt=Client, prompts are sent
    to the client system.

14  –  Restore Options

    Restore_Options=file-name

    Generates an options file designed to be used with the Options
    qualifier of the RMU Restore command.

    The Restore_Options file is created after the root information
    has been read from the backup file.

    By default, a Restore_Options file is not created. If you
    specify the Restore_Options qualifier and a file, but not a file
    extension, Oracle RMU uses an extension of .opt by default.

15  –  Rewind

    Rewind
    Norewind

    Specifies that the magnetic tape that contains the backup file
    will be rewound before processing begins. The Norewind qualifier
    is the default.

    The Rewind and Norewind qualifiers are applicable only to tape
    devices. You should use these qualifiers only when the target
    device is a tape device.

    See the Oracle Rdb Guide to Database Maintenance for information
    on tape label processing.

16  –  Skip

    Skip=skip-list

    Specifies a list of keywords that determines where the output
    display begins. The keywords indicate the position in the backup
    file from which to start the dump. If you specify more than one
    type of Skip position, separate the options with a comma, and
    enclose the skip-list parameter in parentheses. You can specify
    the following three items in the skip-list parameter:

    o  Volumes=integer

       The number of volumes to ignore before starting. This option
       is ignored if the backup file does not reside on tape.

    o  Blocks=integer

       The number of blocks to ignore before starting. This option is
       ignored if the backup file does not reside on tape.

    o  Records=integer

       The number of records to ignore before starting. This option
       is valid regardless of whether the backup file resides on tape
       or disk.

17  –  Start

    Start=integer

    Only dump pages starting with the specified page number in the
    specified storage area. This qualifier cannot be used unless
    the /AREA qualifier is also specified. If no pages are dumped,
    either the specified page or range of pages does not exist in
    the specified area in the backup file, or this qualifier has been
    used in the same RMU/DUMP/BACKUP command as an /OPTIONS, /SKIP or
    /PROCESS qualifier option that has excluded the specified page or
    range of pages from the dump. If this qualifier is not used with
    the /END qualifier, all page records in the specified storage
    area starting with the specified page number will be output.

    If both the /START and /END qualifiers are specified, the
    starting page number must be less than or equal to the ending
    page number. If the starting page number equals the ending page
    number only the page records for the specified page number are
    dumped. The block header for each block which contains at least
    one of the requested pages is dumped followed by the requested
    page records in that block. The START AREA record is dumped at
    the start of requested page records and the END AREA record is
    dumped at the end of the requested page records. By default, the
    database root parameters are dumped at the very start following
    the dump header.
Close Help