The base administration fields, that are common to all administration messages, are:
Table 3. Administration actions
Administration action | Purpose |
---|---|
MQE_ADMIN_ACTION_CREATE | Create a new instance of a managed resource. |
MQE_ADMIN_ACTION_DELETE | Delete an existing managed resource |
MQE_ADMIN_ACTION_INQUIRE | Inquire on one or more characteristics of a managed resource |
MQE_ADMIN_ACTION_INQUIREALL | Inquire on all characteristics of a managed resource |
MQE_ADMIN_ACTION_UPDATE | Update one or more characteristics of a managed resource |
All resources do not necessarily implement these actions. For instance, it is not possible to create a queue manager using an administration message. Specific administration messages can extend the base set to provide additional actions that are specific to a resource.
Each common action provides a function that sets the
MQE_ADMIN_ACTION field:
Table 4. Setting the administration action field
Administration action | Setting function |
---|---|
MQE_ADMIN_ACTION_CREATE | mqeAdminMsg_create(parameters) |
MQE_ADMIN_ACTION_DELETE | mqeAdminMsg_delete(parameters) |
MQE_ADMIN_ACTION_INQUIRE | mqeAdminMsg_inquire(parameters) |
MQE_ADMIN_ACTION_INQUIREALL | mqeAdminMsg_inquireAll(parameters) |
MQE_ADMIN_ACTION_UPDATE | mqeAdminMsg_update(parameters) |
MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms
This field determines how many times an action can be retried if the initial action fails. The retry occurs either the next time that the queue manager restarts or at the next interval set on the administration queue.
A set of functions are available for setting some of the request
fields:
Table 5. Setting administration request fields
Administration action | Field type | Set and get functions |
---|---|---|
MQE_ADMIN_PARAMS | MQeFields | mqeAdminMsg_getInputFields( MQeAdminMsgHndl hMsgObj , MQeExceptBlock * pErrStruct , MQeFieldsHndl * phFields) |
MQE_ADMIN_ACTION | int | mqeAdminMsg_setAction( MQeAdminMsgHndl hMsgObj, MQeExceptBlock * pErrStruct, MQEINT32 action) |
MQE_ADMIN_TARGET_QMGR | ascii | mqeAdminMsg_setTargetQMgr( MQeAdminMsgHndl hMsgObj, MQeExceptBlock * pErrStruct, MQECONST MQeStringHndl hName) |
MQE_ADMIN_MAXATTEMPTS | int | mqeAdminMsg_setMaxAttempts( MQeAdminMsgHndl hMsgObj, MQeExceptBlock * pErrStruct, MQEINT32 maxAttempts) |