Print Report using BRM (PRTRPTBRM)

Where allowed to run: All environments (*ALL)
Threadsafe: No

The Print Report using BRM (PRTRPTBRM) command produces a report based on the Report type. Listed below are the printer files and associated reports that can be produced when the PRTRPTBRM command is processed:

QP1ABS - Backup Statistics Report

To use this command, you must have the Backup Recovery and Media Services for IBM i licensed program installed.

Restriction:

When using special value *OUTFILE for the Output (OUTPUT) parameter, refer to section General Rules for Object Authorities on Commands in Appendix D of the iSeries Security Reference book for the authorities required for the output file and output file library.

Top

Parameters

Keyword	Description	Choices	Notes
TYPE	Report type	BKUSTAT, CTLGRPSTAT	Optional, Positional 1
PERIOD	Time period for report	Single values: *DAYS Other values: Element list	Optional
	Element 1: Start time and date	Element list
	Element 1: Beginning time	Time, *AVAIL
	Element 2: Beginning date	Character value, BEGIN, CURRENT
	Element 2: End time and date	Element list
	Element 1: Ending time	Time, *AVAIL
	Element 2: Ending date	Character value, END, CURRENT
DAYS	Time period in days	1-365, 7	Optional
ASPDEV	Auxiliary storage pool	Character value, ALL, SYSTEM	Optional
LIB	Library	Name, ALL, ALLUSR	Optional
CTLGRP	Control group	Generic name, name, ALL, SYSTEM, BKUGRP, SYSGRP, *NONE	Optional
OUTPUT	Output	PRINT, OUTFILE	Optional
OUTFILE	File to receive output	Qualified object name	Optional
	Qualifier 1: File to receive output	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
OUTMBR	Output member options	Element list	Optional
	Element 1: Member to receive output	Name, *FIRST
	Element 2: Replace or add records	REPLACE, ADD
FROMSYS	From system	Character value, *LCL	Optional

Top

Report type (TYPE)

Specifies the type of the report you want to print or generate output file.

*BKUSTAT: This report provides summarized information about all objects that have been saved by BRMS within a specified period.
*CTLGRPSTAT: This report provides summarized information about all backup control groups that have been processed by BRMS and meet the selection criteria.

Top

Time period for the report (PERIOD)

Specifies the period of time for which the data are selected for the report. This is dependent on the value specified in the Type (TYPE) parameter.

Single values

*DAYS: Use the Time period in days (DAYS) parameter to select data for the report.

Other values

Element 1: Start Time and date

Element 1: Beginning time

Any items saved on or after the beginning date and time are included in the report. Any items saved after the ending date and time are not included for the report.

*AVAIL

Anytime that is available for the beginning date is included.

begin-time

Specify the beginning time for the specified beginning date that indicates which records should be included.

The time is specified in 24-hour format and can be specified with or without a time separator:

Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh=hours, mm=minutes and ss=seconds. Hours, minutes, and seconds must each be exactly 2 digits (using leading zeros if necessary).
With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.

Element 2: Beginning date

Any items saved on or after the beginning date are included in the report. Any items saved after the beginning date and time are not included for the report.

*BEGIN: Saved items from the beginning of the media content information are included in the report.
*CURRENT: Saved items with a current date creation date and between the specified beginning and ending times (if specified) are included in the report.
begin-date: Specify the beginning date. The date must be specified in the job date format.

Element 2: End time and date

Element 1: Ending time

One of the following is used to specify the ending time before which saved items items are included. Any items created after the specified time and date are not included in the report.

*AVAIL: Any time that is available for the ending time is included.
end-time: Specify the ending time for the specified ending date that indicates which saved items are to be included.

Element 2: Ending date

One of the following is used to specify the ending date on which or before which the items must have been saved. Any save performed after the specified dates are not included in the report.

*END: The saved items to the end of the save information are recovered.
*CURRENT: Saved items whose save date are on or before the current date are included in the report.
end-date: Specify the ending date. The date must be specified in the job date format.

Top

Time period in days (DAYS)

Specifies the number of days from which data is selected. For example, a time period of 7 days would include data in the report from midnight seven days ago through the current date and time. Time period in days can be specified from 1 to 365.

Note: Time period in days is ignored unless *DAYS is specified for the Time period for report (PERIOD) parameter.

7: The default time period in days is seven.
time-period-in-days: Specify the time period in days that you want to use to select data for the report.

Top

Auxiliary storage pool (ASPDEV)

Specifies the name of the auxiliary storage pool or special value to be included in the report or output file. This parameter is ignored when parameter Type (TYPE) is not *BKUSTAT.

*ALL: All auxiliary storage pools are to be included in the report or output file.
*SYSTEM: Only the system (1) auxiliary storage pool is to be included in the report or output file.
ASP-name: Specifies the name of an auxiliary storage pool to be included in the report or output file.
ASP-number: Specifies the number of the system (1) or basic user auxiliary storage pool (2-32) to be included in the report or output file.

Top

Library (LIB)

Specifies which libraries should be included in the report. This parameter is ignored when parameter Type (TYPE) is not *BKUSTAT.

*ALL: All the libraries in the auxiliary storage pools (ASPs) specified for the ASP device (ASPDEV) parameter are included.
*ALLUSR: All user libraries in the auxiliary storage pools (ASPs) specified for the ASP device (ASPDEV) parameter are included.
name: Specify the name of the library to be included in the report.

Top

Control group (CTLGRP)

Specifies which backup control group should be included in the report. This parameter is ignored when parameter Type (TYPE) is not *CTLGRPSTAT. Note: Backups produced by running STRBKUBRM commands will be included in the report for all values except *NONE.

*ALL: All backups produced by running STRBKUBRM will be included in this report. Note: The output generated by CTLGRP(*NONE) will not be included in this report.
*SYSTEM: Backups produced by the *SYSTEM control group will be included in the report.
*BKUGRP: Backups produced by the *BKUGRP control group will be included in the report.
*SYSGRP: Backups produced by the *SYSGRP control group will be included in the report.
*NONE: Backups produced by running SAVxxxBRM commands will be summarized in the report. This includes SAVxxxBRM commands that were associated with a control group.
generic name: Specify the generic name of the control group to be included in the report.. A generic name is a character string that contains one or more characters followed by an asterisk (*). If an * is not specified with the name, the name is assumed to be a complete control group name.
name: Specify the name of the control group to be included in the report.

Top

Output (OUTPUT)

Specifies whether the output is to be printed with the job's spooled output or directed to a database file.

*PRINT: The output is printed with the job's spooled output.
*OUTFILE: The output is directed to the database file specified on the File to receive output (OUTFILE) parameter.

Top

File to receive output (OUTFILE)

Specifies the qualified name of the database file receiving the output when *OUTFILE is specified for the Output (OUTPUT) parameter. If the file does not exist, this command creates a database file in the specified library. New files are created using database file QA1ABS in library QBRM with the format name QA1ABS as the model.

Qualifier 1: File to receive output

database-file-name: Specifies the name of the database file receiving the output from the command. If this file does not exist, it is created in the specified library.

Qualifier 2: Library

*LIBL: All libraries in the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is used to locate the file. If no library is specified as the current library for the job, QGPL is used.
library-name: The specified library is used to locate the file.

Top

Output member options (OUTMBR)

Specifies the name of the database file member receiving the output of the command when *OUTFILE is specified for the Output (OUTPUT) parameter.

Element 1: Member to receive output

*FIRST: The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the member is created with the name of the file specified on the File to receive output (OUTFILE) parameter and the record options.
member-name: Specifies the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the member is created.
If the member exists, the user can add records to the end of the existing member or clear the existing member and add the records.

Element 2: Replace or add records

*REPLACE: The existing records in the specified database file member are replaced by the new records.
*ADD: The new records are added to the existing information in the specified database file member.

Top

From system (FROMSYS)

Specifies the system name and network identification of the system whose information will be used to produce the report.

Note: Use the Display Network Attributes (DSPNETA) command to view the system network attributes.

Note: The BRMS Network feature (Option 1) is required to use this value if a value other than *LCL is specified.

*LCL: Specifies that the from-system is the local system. BRMS uses the Default local location name (LCLLOCNAME) network attribute and not the System name (SYSNAME) network attribute to determine the current system name. In most cases, the systems have the same value specified for LCLLOCNAME as for SYSNAME.
location-name: Specifies the Default local location name (LCLLOCNAME) network attribute of the remote system for the network operation. The current system Local network ID (LCLNETID) network attribute is used to connect with the remote system.
network-id.location-name: Specifies the Local network ID (LCLNETID) and the Default local location name (LCLLOCNAME) network attributes of the remote system for the network operation. Specify these values using the format nnnnnnnn.cccccccc where nnnnnnnn is the LCLNETID and cccccccc is the LCLLOCNAME.

Top

Examples

Example 1: Print the Backup Statistics Report

PRTRPTBRM TYPE(*BKUSTAT) PERIOD((*AVAIL *BEGIN)) ASPDEV(*ALL)
          OUTPUT(*PRINT)

This command produces a backup statistic report which will summarize information about all objects that have been saved by BRMS within the specified period and which includes the system (1) and basic user (2-32) auxiliary storage pools as well as any auxiliary storage pool devices.

Example 2: Generate the Backup Statistics Report

PRTRPTBRM TYPE(*BKUSTAT) PERIOD((*AVAIL *BEGIN)) ASPDEV(*ALL)
          OUTPUT(*OUTFILE) OUTFILE(QTEMP/BKUSTAT)

This command retrieves information about all objects that have been saved by BRMS within the specified period which includes the system (1) and basic user (2-32) auxiliary storage pools as well as any auxiliary storage pool devices. A summary of the information is placed in the first member in data base file BKUSTAT in library QTEMP.

Top

Error messages

*ESCAPE Messages

BRM1917: Feature not installed.
BRM1921: Feature not licensed.
BRM40A2: BRMS product initialization required.
CPF9800: All CPF98xx messages could be signaled. xx is from 01 to FF.

Top