Change Control Group (Q1ACHGCGA) API

The (Q1ACHGCGA), Change Control Group Attributes  API



  Required Parameter Group:
 

1Control group nameInputChar(10)
2Attribute informationInputChar(*)
3Length of attribute informationInputBinary(4)
4Format of attribute informationInputChar(8)
5Error CodeI/OChar(*)


Program: QBRM/Q1ACHGCGA
  Default Public Authority: *USE

  Threadsafe: No 
 

The Change Control Group Attributes (Q1ACHGCGA) API is used to enable users to change programmatically the control group attributes.


Authorities and Locks

None


Required Parameter Group

Control group name: INPUT, CHAR(10); Specifies the name of the control group that is being created.

Attribute information: INPUT, CHAR(*); The attributes of the control group. The format of the control group information is specified in the control group format name parameter.

Length of attribute information: INPUT, BINARY(4); The number of bytes that the calling program provides for the attribute information format.

Format of attribute information: INPUT, CHAR(8); The format of the attribute information parameter. The possible format names include:

CGBI0100, See Attribute information formats below for a description of this format.  

Error code: I/O, CHAR(*); The structure in which to return error information. For the format of the structure, see the Error code parameter section below.


CGBI0100 Attribute information formats

OffsetTypeField
DecHex
00CHAR(40)Backup control group devices
4032CHAR(10)Backup control group full media policy
503CCHAR(10)Backup control group incremental media policy
6040CHAR(4)Reserved


 

Attribute information format field descriptions:

Backup control group devices. Specifies an array of device names associated with this object. The array is limited to a maximum of four device names. The default value is *BKUPCY, if all the device names are blanks.

OffsetTypeField
DecHex
00CHAR(10)Device n

Note: These fields repeat for each device name The device names must be 10 characters. The number of device names in the array is 4 for a total of 40 characters. For unused device names, the 10-byte field must be set to blanks.



*NONESpecifies no devices will be used. The media policy is set to use save files instead of devices. This special value must be first in the array. The other 3 device name fields must be blank.
*MEDCLSSpecifies the device(s) are determined from the media class attribute of the media policies assigned to this control group. 
Restrictions: Can only have multiple *MEDCLS if no parallel or virtual device is being used on the backup. Multiple *MEDCLS will be used as a way to cascade the serial backup to other devices.
*BKUPCYThe value of the BRMS backup policy will be used on the backup. The other 3 device name fields must be blank.
*SYSPCYThe value of the BRMS system policy will be used on the backup. The other 3 device name fields must be blank.
device-name-nThe name of the device object. 
Restrictions: Can only have 1 device if a virtual device is being used and not using parallel backups.

Backup control group full media policy. Specifies the name of the media policy for full backups.

*BKUPCYThe value of the BRMS backup policy will be used on the backup.
*SYSPCYThe value of the BRMS system policy will be used on the backup.
Media policy nameThe name of the media policy to use on the backup.


Backup control group incremental media policy. Specifies the name of the media policy for incremental backups.

*BKUPCYThe value of the BRMS backup policy will be used on the backup.
*SYSPCYThe value of the BRMS system policy will be used on the backup.
Media policy nameThe name of the media policy to use on the backup.


Error Messages

The following messages may be sent from this function:

Message IDError Message Text
CPF3CF1 EError code parameter not valid.
CPF24B4 EServer error while addressing parameter list.
CPF5222 EName is not valid.
CPF9800 EAll CPF98xx messages could be signaled (xx range is 01 to FF).
BRM1199 ESpecial values and device names cannot be mixed.
BRM1243 EDuplicate devices not allowed.
BRM1437 ESave to savefile must be *YES in policy * if device is *NONE.
BRM1430 EDevice * not found.
BRM1881 EDevice * not compatible with media policy *.
BRM3011 EMultiple *MEDCLS not allowed.
BRM3C1E ERequired parameter omitted.
BRM3C4B EValue not valid for field at offset *.
BRM3C4C EValue not valid for field at offset *
BRM3C91 EProduct feature required.
BRM3C99 EUnexpected condition with * API. Reason *.
BRM402A EBRMS product initialization required.
BRM4040 EAccess denied for user *.
BRM4104 EControl group * not found.
BRM4108 EFormat name * not correct.