Change Control Group (Q1ACHGCGA) API
- Kathy Kurth
- Peter Lafler
The (Q1ACHGCGA), Change Control Group Attributes API
Required Parameter Group:
| 1 | Control group name | Input | Char(10) |
| 2 | Attribute information | Input | Char(*) |
| 3 | Length of attribute information | Input | Binary(4) |
| 4 | Format of attribute information | Input | Char(8) |
| 5 | Error Code | I/O | Char(*) |
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
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(40) | Backup control group devices |
| 40 | 32 | CHAR(10) | Backup control group full media policy |
| 50 | 3C | CHAR(10) | Backup control group incremental media policy |
| 60 | 40 | CHAR(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.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(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.
| *NONE | Specifies 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. |
| *MEDCLS | Specifies 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. |
| *BKUPCY | The value of the BRMS backup policy will be used on the backup. The other 3 device name fields must be blank. |
| *SYSPCY | The value of the BRMS system policy will be used on the backup. The other 3 device name fields must be blank. |
| device-name-n | The 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.
| *BKUPCY | The value of the BRMS backup policy will be used on the backup. |
| *SYSPCY | The value of the BRMS system policy will be used on the backup. |
| Media policy name | The 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.
| *BKUPCY | The value of the BRMS backup policy will be used on the backup. |
| *SYSPCY | The value of the BRMS system policy will be used on the backup. |
| Media policy name | The name of the media policy to use on the backup. |
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF3CF1 E | Error code parameter not valid. |
| CPF24B4 E | Server error while addressing parameter list. |
| CPF5222 E | Name is not valid. |
| CPF9800 E | All CPF98xx messages could be signaled (xx range is 01 to FF). |
| BRM1199 E | Special values and device names cannot be mixed. |
| BRM1243 E | Duplicate devices not allowed. |
| BRM1437 E | Save to savefile must be *YES in policy * if device is *NONE. |
| BRM1430 E | Device * not found. |
| BRM1881 E | Device * not compatible with media policy *. |
| BRM3011 E | Multiple *MEDCLS not allowed. |
| BRM3C1E E | Required parameter omitted. |
| BRM3C4B E | Value not valid for field at offset *. |
| BRM3C4C E | Value not valid for field at offset * |
| BRM3C91 E | Product feature required. |
| BRM3C99 E | Unexpected condition with * API. Reason *. |
| BRM402A E | BRMS product initialization required. |
| BRM4040 E | Access denied for user *. |
| BRM4104 E | Control group * not found. |
| BRM4108 E | Format name * not correct. |
Privacy Policy | Cookie Policy | Impressum
From time to time, this website may contain technical inaccuracies and we do not warrant the accuracy of any posted information.
Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective owners.