(applies
to user profile calling the API and user
profile to run the exit program)
(applies to user profile calling the API and user
profile to run the exit program)(applies to user profile to run the exit program)Configuration Object Authority| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Cluster resource group name | Input | Char(10) |
| 4 | Configuration object entry information | Input | Char(*) |
| 5 | Format name | Input | Char(8) |
| 6 | Results information | Input | Char(30) |
| 7 | Error code | I/O | Char(*) |
The Change Cluster Resource Group Device Entry (QcstChgClusterResourceGroupDev) API changes information about one or more configuration objects in a device cluster resource group. The entry being changed is found by searching the current entries for a matching configuration object name and configuration object type.
If an exit program is specified for the cluster resource group, the cluster resource group exit program is called with an action code of Change Device Entry (19) on all active nodes in the recovery domain. The cluster resource group status is set to Change Device Entry Pending (610). If the exit program completes successfully, the cluster resource group status is reset to its value at the time the API was called. If the exit program fails and the cluster resource group cannot be restored to its original condition, the cluster resource group status is set to Indoubt (30).
This API requires:
Restriction: This API cannot be called from a cluster resource group exit program.
The program that calls this API must be running under a user profile with *IOSYSCFG special authority.
(applies
to user profile calling the API and user
profile to run the exit program) (applies to user profile calling the API and user
profile to run the exit program)(applies to user profile to run the exit program)Configuration Object AuthorityA unique string or handle that identifies this API call. It is used to associate this call to any responses placed on the user queue specified in the results information parameter.
The name of the cluster to which the cluster resource group belongs.
The name of the cluster resource group which is to be changed.
Detailed information about the configuration object entries to be changed. For more information, see Device Resiliency (RGDH0100 Format).
The content and format of the device information. The possible format names are:
| RGDH0100 | This format describes the resilient device. |
This parameter identifies a qualified user queue field and is followed by a reserved field.
Qualified user queue: Completion information is returned to this user queue, which exists on the node from which the API was called, after the function has completed. See the Usage Notes section of this API for a description of the data that is placed on this queue. This is a 20-character field. The first 10 characters contain the user queue name, and the second 10 characters contain the user queue library name. No special values are supported. QTEMP, *LIBL, *CURLIB are not valid library names. The attributes of this user queue must be keyed.
Reserved: The last 10 characters of the 30-character results information are reserved. Each character in this field must be set to hexadecimal zero.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to configuration object array |
| 4 | 4 | BINARY(4) | Number of entries in configuration object array |
| 8 | 8 | BINARY(4) | Length of configuration object array entry |
| 12 | C | BINARY(4) | Offset to additional fields |
| 16 | 10 | BINARY(4) | Length of additional fields |
| * | * | Array (*) of CHAR(36) | Configuration object array |
| These fields repeat, in the order listed, for each device. | CHAR(10) | Configuration object name | |
| CHAR(2) | Reserved | ||
| BINARY(4) | Configuration object type | ||
| BINARY(4) | Configuration object online | ||
| CHAR(16) | Server takeover IP address | ||
Configuration object array. This array identifies the resilient devices.
Configuration object name. The name of the auxiliary storage pool device description which is in the cluster resource group.
Configuration object online. Vary the configuration object on and start the server takeover IP address or leave the configuration object varied off and the server takeover IP address inactive when a device is switched from one node to another with the Initiate SwitchOver (QcstInitiateSwitchOver) API or when it is failed over to a backup node. For secondary auxiliary storage pools, only a value of 2 is valid. If cluster resource services cannot determine if this value is correct for a device entry because the auxiliary storage pool is not yet created, any errors will be detected when the cluster resource group is started. A value of 2 cannot be specified for any other device type. Possible values are:
| -1 | Configuration object online is not changed. |
| 0 | Do not vary the configuration object on and do not start the server takeover IP address. |
| 1 | Vary the configuration object on and start the server takeover IP address. |
| 2 | Perform the same action for a secondary auxiliary storage pool as is specified for the primary. |
Configuration object type. This specifies the type of configuration object specified with configuration object name. Possible values are:
| 1 | Device description |
Length of additional fields. The length in bytes of additional fields. This must be set to hexadecimal zero. It will be used in a future release if more fields are needed in the RGDH0100 format.
Length of configuration object array entry. This specifies the length of an entry in the configuration object array.
Number of entries in configuration object array. The number of entries in the configuration object array. This number must be greater than zero and less than or equal to 256.
Offset to additional fields. The byte offset from the beginning of this parameter to additional fields. This must be set to hexadecimal zero. It will be used in a future release if more fields are needed in the RGDH0100 format.
Offset to configuration object array. The byte offset from the beginning of this parameter to the configuration object array field.
Reserved. Must contain hexadecimal zeroes.
Server takeover IP address. This is a takeover IP address for servers associated with the relational database name in the device description for an auxiliary storage pool. This field is optional and can only be specified for a primary auxiliary storage pool. If specified, the address must be represented in dotted decimal format and be a null-terminated string. The specified address must exist on all nodes in the recovery domain if the cluster resource group is active. If not specified, or for a secondary and UDFS auxiliary storage pool, this field must be set to *NONE and be left justified. If the current cluster version is 2 and the length of configuration object array entry specified includes the server takeover IP address, this field must be set to hexadecimal zeroes. Valid special values for this field are:
| *SAME | The server takeover IP address does not change. This must be left justified. |
| *NONE | There is no server takeover IP address associated with the relational database name in the device description for an auxiliary storage pool. This must be left justified. |
| Message ID | Error Message Text |
|---|---|
| CPCBB01 C | Cluster Resource Services API &1 completed. |
| CPF18BA D | Error occurred with subsystem. |
| CPF2113 E | Cannot allocate library &1. |
| CPF2204 D | User profile &1 not found. |
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPF9801 D | Object &2 in library &3 not found. |
| CPF9802 D | Not authorized to object &2 in &3. |
| CPF9803 D | Cannot allocate object &2 in library &3. |
| CPF9804 D | Object &2 in library &3 damaged. |
| CPF9810 D | Library &1 not found. |
| CPFBB0F D | Cluster resource group &1 does not exist in cluster &2. |
| CPFBB17 D | &1 API cannot be processed in cluster &2. |
| CPFBB18 D | Request &1 is not allowed for cluster resource group &2. |
| CPFBB2C D | Attributes of exit program &1 in library &2 are not valid. |
| CPFBB2D D | Timeout detected while waiting for a response. |
| CPFBB2E D | Job submission failed for cluster resource group &1 in cluster &2. |
| CPFBB32 D | Attributes of user queue &1 in library &2 are not valid. |
| CPFBB35 D | The user profile name &1 is not valid for this request. |
| CPFBB38 D | Library name &1 is not allowed for this request. |
| CPFBB39 D | The current user does not have IOSYSCFG special authority. |
| CPFBB46 D | Cluster Resource Services internal error. |
| CPFBB9A D | Online value not valid for device &1. |
| CPFBBA6 E | Server takeover IP address cannot be associated with device subtype &1. |
| CPIBB10 D | Cluster resource group exit program &1 in library &2 on node &3 failed. |
| Message ID | Error Message Text |
|---|---|
| CPF2113 E | Cannot allocate library &1. |
| CPF2204 E | User profile &1 not found. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF980C E | Object &1 in library &2 cannot be in an independent auxiliary storage pool. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB0F E | Cluster resource group &1 does not exist in cluster &2. |
| CPFBB26 E | Cluster Resource Services not active or not responding. |
| CPFBB2C E | Attributes of exit program &1 in library &2 are not valid. |
| CPFBB32 E | Attributes of user queue &1 in library &2 not valid. |
| CPFBB35 E | The user profile name &1 is not valid for this request. |
| CPFBB38 E | Library name &1 is not allowed for this request. |
| CPFBB39 E | Current user does not have IOSYSCFG special authority. |
| CPFBB43 E | Invalid format name &1 for cluster resource group type &2. |
| CPFBB44 E | &1 API cannot be called from a cluster resource group exit program. |
| CPFBB5F E | Number of configuration object entries not valid. |
| CPFBB60 E | Offset to configuration object array is not valid. |
| CPFBB61 E | Configuration object &1 specified more than once in configuration object array. |
| CPFBB63 E | The value specified for the field at offset &1 of configuration object array entry &2 is not valid. |
| CPFBB6B E | Request not valid for type &1 cluster resource group. |
| CPFBB6D E | Configuration object &1 not in cluster resource group &2. |
| CPFBB70 E | API request &1 not compatible with current cluster version. |
| CPFBBA5 E | Server takeover IP address &1 specified more than once in the configuration object array. |
| TCP1901 D | Internet address &1 not valid. |
| Top | Cluster APIs | APIs by category |