The pdbkupls command displays information about backup files acquired by pdcopy (such as a list of RDAREAs and the backup acquisition date and time).

Use the pdbkupls command:

• When you want to check the contents of a backup (for example, to determine what is included in the most recent backup)
• When you want to retain the acquired backup information as history

HiRDB administrator

pdbkupls -b {backup-file-name[,backup-file-name]... |policy-name} [-k {u|i|n}] [-o backup-information-output-file-name] [-c] [-a] [-s progress-message-output-interval] [-U {backup-search-condition-start-date_time,backup-search-condition-end-date_time |,backup-search-condition-end-date_time}]

• -b {backup-file-name[,backup-file-name]...|policy-name}

Specifies the names of the backup files.

When backup-file-name[,backup-file-name]... is specified:

<path name> ((up to 1023 bytes))

Specifies file names or the names of HiRDB files.

If you specify a file name, also specify -k u; if you specify a HiRDB file name, also specify -k i.

When policy-name is specified:

<identifier> ((up to 128 bytes))

Specifies a NetBackup policy name. In this case, also specify -k n.

Rules

1. If a host name is specified, an error results.
2. Multiple file names can be specified only if the backup consists of multiple files. When the backup does not consist of multiple files, all file names after the first one specified are ignored. If the backup consists of multiple files, only one file is specified, and the -a option is also specified, the command terminates with an error.

• -k {u|i|n}

Specifies the type of backup file.

u:

Regular file.

i:

HiRDB file.

n:

Backup file acquired using NetBackup.

• -o backup-information-output-file-name <path name> ((up to 1023 bytes))

Specifies a file to which the backup file information is to be output. When this option is omitted, the backup file information is output to the standard output.

• -c

Specifies that the backup file information is to be output in CSV format. When this option is omitted, the backup file information is output to the standard output.

• -a

Specifies that all information is to be output.

When this option is omitted, the command outputs the HiRDB identifier, backup acquisition mode, backup acquisition time, and whether or not a log point information file was specified.

• -s progress-message-output-interval <unsigned integer> ((1-1024))

Specifies that progress messages are to be output during execution of the pdbkupls command, and specifies the message output interval in terms of the amount of backup file data to be processed in each interval (in gigabytes). For example, when -s 100 is specified, a progress message is displayed after each 100 gigabytes of data has been processed.

Note that this option is applicable only when the -a option is specified.

• -U {backup-search-condition-start-date_time,backup-search-condition-end-date_time|,backup-search-condition-end-date_time}

Specifies a time period when only backup information acquired during the specified period under the specified policy is to be included in the output backup information. This option is applicable only when the NetBackup linkage facility is used (-k n is specified). When the NetBackup linkage facility is not used, this option is ignored, if specified.

If backup-search-condition-start-date_time and backup-search-condition-end-date_time are both specified, the most recent backup acquired during the specified period is used. If only backup-search-condition-end-date_time is specified, the backup that was current at the specified time is used.

Rules

• When this option is omitted, the command uses the most recent backup among the backups acquired under the specified policy.
• You can use the bpimagelist command (with the -policy option specified) to check backup acquisition dates/times.
• When you specify a backup-search-condition-start-date_time or backup-search-condition-end-date_time, specify an underscore (_) between the date and the time, as shown below. If the time is omitted, 000000 is assumed as the start time and 235959 is assumed as the end time.
  

  -U YYYYMMDD[_hhmmss],YYYYMMDD[_hhmmss]

YYYY: Year <unsigned integer> ((1990-2037))

Specifies the year.

MM: Month <unsigned integer> ((01-12))

DD: Date <unsigned integer> ((01-31))

hh: Hour <unsigned integer> ((00-23))

mm: Minute <unsigned integer> ((00-59))

ss: Second <unsigned integer> ((00-59))

To specify the end date/time only, specify the comma (,) and then the end date/time.

1. You can execute the pdbkupls command whether or not HiRDB is active.
2. Execute the pdbkupls command at the server machine where the host containing the backup files is located. If you use NetBackup, execute the command at the server machine that contains the host to which backup files were output during execution of pdcopy.
3. The pdbkupls command can process only backup files acquired by pdcopy. If any other backup file is specified, the command results in an error.
4. To use NetBackup, you must have JP1/VERITAS NetBackup Agent for HiRDB License; for details, see the JP1/VERITAS NetBackup v4.5 Agent for HiRDB License Description and User's Guide.
5. A differential backup file cannot be specified. If a differential backup file is specified, an error results.

1. For the pdbkupls command, return code 0 indicates normal termination, and return code 12 indicates abnormal termination. If the return code is 12, see the previous message and eliminate the cause of the error.
2. If utf-8 is selected as the character encoding in the pdntenv command, a BOM is not added to a file that is output by pdbkupls.

The following conventions apply to the output format:

1. (linefeed) indicates a linefeed code (CR+LF).
2. If there is no output information, the command outputs * for the item in the standard format and nothing in the CSV format (2 consecutive commas are displayed).
3. rr...r through uu...u are output for each RDAREA, in ascending order of the RDAREA IDs (in which case, (linefeed) and <<RDAREA information>> are also output for each RDAREA).
4. When data is output to the backup information output file, EOF is displayed in the row immediately following the last data.
5. A linefeed is performed after each 1,024 bytes of data (not including linefeed codes).

The following shows the output formats:

• When the -a option is omitted

Standard format:

<<System information>>(linefeed) <HiRDB system id> : aaaa(linefeed) (linefeed) <<Backup file information>>(linefeed) <Backup mode> : dd...d(linefeed) <Backup start Time> : ee...e(linefeed) <Logpoint information Y/N> : g(linefeed)

CSV format:

aaaa,dd...d,ee...e,g(linefeed)

Explanation

For details about aaaa through g, see the description for When the -a option is specified.

• When the -a option is specified

Standard format:

<<System information>>(linefeed) <HiRDB system id> : aaaa(linefeed) (linefeed) <<Backup file information>>(linefeed) <Backup file count> : bbbb(linefeed) <Backup file name> : cc...c(linefeed) <Backup mode> : dd...d(linefeed) <Backup start time> : ee...e(linefeed) <Backup end time> : ff...f(linefeed) <Logpoint information Y/N> : g(linefeed) <Get RDAREA's count> : hhhh(linefeed) <Get RDAREA's list> : ii...i(linefeed) <Errskip Y/N> : j(linefeed) <Replica RDAREA generation No> : kk(linefeed) <Server name> : ll...l(linefeed) <Server RUNID> : mm...m(linefeed) <Server group name> : nn...n(linefeed) <Server block No> : oo...o(linefeed) <Server generation No> : pp(linefeed) <Server Log start time> : qq...q(linefeed) (linefeed) <<RDAREA information>>(linefeed) <RDAREA name> : rr...r(linefeed) <RDAREA id> : ss...s(linefeed) <RDAREA kind> : tt...t(linefeed) <RDAREA last LSN> : uu...u(linefeed) :

CSV format:

aaaa,bbbb,cc...c,dd...d,ee...e,ff...f,g,hhhh,ii...i,j,kk,ll...l,mm...m,nn...n, oo...o,pp,qq...q,rr...r,ss...s,tt...t,uu...u ...

Explanation

aaaa

Identifier of the HiRDB used to acquire the backup (1 to 4 characters).

bbbb

Number of backup files specified in the -b option (1 to 4 decimal digits).

cc...c

Names of the backup files specified in the -b option (maximum of 1,023 characters). Backup file names are output in the order specified in the -b option of pdcopy, separated by the comma.

dd...d

Value of the -M option when the backup was acquired (1 to 10 characters).

For -M x or -M r, the value is EXCLUSIVE; for -M s, the value is SHARED.

ee...e

Time the first record was written during backup acquisition (YYYY-MM-DD hh:mm:ss).

ff...f

Time the last record was written during backup acquisition (YYYY-MM-DD hh:mm:ss).

g

Whether or not a log point information file was created during backup acquisition (1 character).

If a log point information file was created, the value is Y; if not, the value is N.

hhhh

Number of RDAREAs stored in the backup files (1 to 4 decimal digits).

ii...i

Name of each RDAREA stored in the backup file (1 to 30 characters). Multiple RDAREA names are separated by the comma and output in ascending order of the RDAREA IDs used during backup acquisition.

j

Whether or not the -J option was specified during backup acquisition (1 character).

If the -J option was specified, the value is Y; if not, the value is N.

kk

The value 0 is always displayed.

ll...l

Name of the server that contains the RDAREAs (1 to 8 characters).

mm...m

Log server run ID (information used by the system) (8 hexadecimal characters).

nn...n

Log group name (information used by the system) (1 to 8 characters).

oo...o

Block number (8 hexadecimal characters).

pp

Generation number (1 to 2 decimal digits).

qq...q

Time at which use of the system log file began (YYYY-MM-DD hh:mm:ss).

rr...r

Name of an RDAREA (1 to 30 characters).

ss...s

RDAREA ID (1 to 8 decimal digits).

tt...t

RDAREA type (1 to 15 characters):

MASTERDIRECTORY: Master directory RDAREA

DATADIRECTORY: Data directory RDAREA

DATADICTIONARY: Data dictionary RDAREA

SYSTEM_LOB: Data dictionary LOB RDAREA

USER: User RDAREA

USER_LOB: User LOB RDAREA

REG: Registry RDAREA

REG_LOB: Registry LOB RDAREA

uu...u

RDAREA update sequence number (information used by the system) (17 characters).