Start Archive using BRM (STRARCBRM)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Start Archive using BRM (STRARCBRM) command selects a control group and begins the archive process. You can start the archive immediately or you can schedule it using the system job scheduler. Processing can be batch or interactive.
Note: The default value for the Option (OPTION) parameter is *REPORT, which produces a report of archive candidates. To perform an archive you must change the OPTION parameter to *ARCHIVE.
To use this command, you must have the Backup Recovery and Media Services for IBM i licensed program installed.
Restrictions:
- The BRMS Advanced feature (Option 2) is required to use this command.
- The special values *LOAD and *EXIT are ignored when you choose the *REPORT option.
- This command should not be used by control group *EXIT item processing as results will be unpredictable.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| CTLGRP | Control group | Name, *ARCGRP | Required, Positional 1 |
| OPTION | Run option | *REPORT, *ARCHIVE | Optional |
| SCDTIME | Schedule time | Decimal number, *IMMED | Optional |
| SBMJOB | Submit to batch | *YES, *NO | Optional |
| JOBD | Job description | Single values: *USRPRF Other values: Qualified object name |
Optional |
| Qualifier 1: Job description | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| JOBQ | Job queue | Single values: *JOBD Other values: Qualified object name |
Optional |
| Qualifier 1: Job queue | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB |
| Top |
Control group (CTLGRP)
Specifies the name of the control group that you want to schedule for archive.
Archive control groups are groups of lists and special values that share common archive characteristics. You can create multiple archive control groups to complete your archive strategy.
This is a required field.
- *ARCGRP
- The default archive control group is processed. The default archive control group is set up in the BRMS archive policy.
- control-group-name
- Specify the name of the archive control group, such as QUARTERLY, that you want to process.
| Top |
Run option (OPTION)
Specifies whether you want to produce a report of candidates for archive or process an archive.
Note: You should always run a report of candidates for archive (*REPORT option) prior to processing the actual archive. The special values *LOAD and *EXIT are not processed when using the *REPORT option.
- *REPORT
- You want to produce the archive candidate reports. There are three archive candidate reports. The reports and the printer file to which they are written are:
- Archive DLO Candidate report - QP1A8ARF
- Archive Object Candidate report - QP1AARC
- Archive Spooled File Candidate report - QP1AOQ
- *ARCHIVE
- You want to process an archive. There are three archive reports. The reports and the printer file to which they are written are:
- DLO Archive report - QP1A8ARF
- Object Archive report - QP1AARC
- Spooled File Archive report - QP1AOQ
| Top |
Schedule time (SCDTIME)
Specifies the time that you want BRMS to begin processing the archive.
- *IMMED
- Archives are to begin immediately.
- schedule-time
- Specify the time in hour and minutes that you want the archive to begin. The time is expressed in 24 hour clock format 'hhmm'.
| Top |
Submit to batch (SBMJOB)
Specifies how you want to process the selected control group.
- *YES
- Submits the processing of the control group to batch. The job is dependent on the job queue and job description specified as subsequent parameters.
- *NO
- Performs the processing of the control group within the current job.
| Top |
Job description (JOBD)
Specifies the job description used with this job.
Single values
- *USRPRF
- The job description in the user profile under which the submitted job runs is used as the job description of the submitted job.
Qualifier 1: Job description
- name
- Specify the name of the job description used for the job.
Qualifier 2: Library
- *LIBL
- The library list is used to locate the job description.
- *CURLIB
- The current library for the job is used to locate the job description. If no library is specified as the current library for the job, QGPL is used.
- name
- Specify the name of the library where the job description is located.
| Top |
Job queue (JOBQ)
Specifies the job queue in which this job is placed.
Single values
- *JOBD
- The submitted job is placed on the job queue named in the specified job description.
Qualifier 1: Job queue
- name
- Specify the name of the job queue on which the submitted job is placed.
Qualifier 2: Library
- *LIBL
- The library list is used to locate the job queue.
- *CURLIB
- The current library for the job is used to locate the job queue. If no library is specified as the current library for the job, QGPL is used.
- name
- Specify the name of the library where the job queue is located.
| Top |
Examples
Example 1: Producing a Report of Archive Candidates
STRARCBRM CTLGRP(ARCH01) SCHTIME(1230)
This command will start processing for archive control group ARCH01 at 12:30 p.m.. A report of all archive candidates is produced.
Example 2: Processing an Archive
STRARCBRM CTLGRP(ARCH01) OPTION(*ARCHIVE) SCHTIME(1230)
This command will start archiving, using archive control group ARCH01, at 12:30 p.m..
| Top |
Error messages
*ESCAPE Messages
- BRM1034
- Control group &1 type &2 canceled.
- BRM1391
- Control group &2 type &3 canceled.
- BRM1393
- Control group &2 type &3 canceled.
- BRM1917
- Feature not installed.
- BRM1921
- Feature not licensed.
- BRM40A2
- BRMS product initialization required.
- CPF3700
- All CPF37xx messages could be signaled. xx is from 01 to FF.
- CPF3800
- All CPF38xx messages could be signaled. xx is from 01 to FF.
- CPF9800
- All CPF98xx messages could be signaled. xx is from 01 to FF.
| Top |