Adding or Removing Object Omits to a BRMS Control Group via the Green Screen

It is possible to omit libraries or objects when running control groups. More information is available here. BRMS also provides the following APIs to add and remove object level omits to control group entries.

Notes:

• For assistance with the use of these APIs, contact Lab Services.

• The limit is 300 omits per control group item omitting objects via the GUI, Q1AADDCGEO API or via the green screen omits.

• At IBM i 7.2 and above you can omit objects from the green screen using an object list. If you use an object list, you can exclude or omit up to 999 items.

Add Control Group Entry Object Omit (Q1AADDCGEO) API

This API will allow a way to programmatically add object omits to a backup entry in a backup control group. Folders are not supported. Only libraries (includes generics), configuration and security data and user authority information for ASPs 2-32.

Required Parameter Group

1. Control group name INPUT CHAR(10) Specifies the name of the control group that is having an object omit added.
2. Control group type INPUT CHAR(10) Specifies what type of control group is to be used. Backup, Archive, or Migration are the 3 types. Only Backup is currently supported. The possible value follows:
   • *BKU A backup control group will be created.
3. Control group entry sequence number INPUT BINARY(4) Indicates which entry is to have objects omitted. The possible values are:
   • 10 -9990 Specifies the entry to use. Type a sequence number from 10 through 9990.
4. Objects to omit library name INPUT CHAR(10) Specifies the name of the library containing the objects to be omitted during the save. The possible values are:
   • *SAVCFG Configuration data is to be omitted from the system or system information save. (*SAVSYS or *SAVSYSINF)
   • *SAVSECDTA Security data is to be omitted from the system or system information save. (*SAVSYS or *SAVSYSINF)
   • *USRASPAUT Omit the BRMS save of the authority information from user auxiliary storage pools (2-32) from the system or system information save. (*SAVSYS or *SAVSYSINF)
   • Library-name The objects are to be omitted from this library. generic*-library-name The objects are to be omitted from these generic libraries.
5. Objects to omit object type INPUT CHAR(10) Specifies the type of objects omitted during the save. (This attribute is available on servers at V5R3 and above.)
   • *ALL All object types are omitted.
   • Object-type Objects of this type are omitted. This can be any valid special value supported by the Object type parameter on the i5/OS save commands.
6. Objects to omit object name INPUT CHAR(10) Specifies the name of the objects omitted during the save. (This attribute is available on servers at V5R3 and above.) The possible values are:
   • *ALL All objects of the specified library and type are omitted.
   • generic*-object-name Objects having this generic name are omitted.
   • object-name Object having this name are omitted.
7. Error code I/O CHAR(*) The structure in which to return error information. For the format of the structure, see the Error Code Parameter topic in the IBM i Knowledge Center.

Remove Control Group Entry Object Omit (Q1ARMVCGEO) API

This API will allow a way to programmatically remove object omits from a backup entry in a backup control group. Folders are not supported. Only libraries (includes generics), configuration and security data and user authority information for ASPs 2-32.

Required Parameter Group

1. Control group name INPUT CHAR(10) Specifies the name of the control group that is having an object omit added.
2. Control group type INPUT CHAR(10) Specifies what type of control group is to be used. Backup, Archive, or Migration are the 3 types. Only Backup is currently supported. The possible value follows.
   • *BKU A backup control group will be created.
3. Control group entry sequence number INPUT BINARY(4) Indicates which entry is to have objects omitted. The possible values are:
   • 10 -9990 Specifies the entry to use. Type a sequence number from 10 through 9990.
4. Error code I/O CHAR(*) The structure in which to return error information. For the format of the structure, see the Error Code Parameter topic in the IBM i Knowledge Center.

Sample programs

The following illustrates called Q1AADDCGEO to create an omit for a data area DA in library OMITLIB, which is in control group TESTOMITS at sequence 20.

PGM
DCL VAR(&SEQ) TYPE(*INT) LEN(4) VALUE(20)
DCL VAR(&ERRCODE) TYPE(*CHAR) LEN(16) VALUE(X'0000000000000000')

CALL PGM(QBRM/Q1AADDCGEO) PARM('TESTOMITS' +

'*BKU      ' &SEQ 'OMITLIB   ' '*DTAARA    ' +

'DA        ' &ERRCODE)               

ENDPGM

The following illustrates called Q1ARMVCGEO to remove an omit for control group TESTOMITS at sequence 20.

PGM
DCL VAR(&SEQ) TYPE(*INT) LEN(4) VALUE(20)
DCL VAR(&ERRCODE) TYPE(*CHAR) LEN(16) VALUE(X'0000000000000000')
CALL PGM(QBRM/Q1ARMVCGEO) PARM('TESTOMITS ' '*BKU ' &SEQ &ERRCODE)
ENDPGM