Contents

Figures
Tables
About this book
Who this book is for
What you need to know to understand this book
How to use this book
Appendixes
Summary of changes
Changes for this edition (SC34-6598-00)
Changes to PCF commands and responses
Changes to the MQAI
Changes to make this manual easier to use
Programmable Command Formats
Introduction to Programmable Command Formats
The problem PCF commands solve
What PCFs are
Other administration interfaces
WebSphere MQ for iSeries
WebSphere MQ for z/OS
MQSeries for Compaq NonStop Kernel, V5.1
WebSphere MQ for Windows, UNIX systems and HP OpenVMS
The WebSphere MQ Administration Interface (MQAI)
Using Programmable Command Formats
PCF command messages
How to issue PCF command messages
Message descriptor for a PCF command
Sending user data
Responses
Message descriptor for a response
Standard responses
OK response
Error response
Data response
Extended responses
Extended responses to Inquire commands
Extended responses to commands other than Inquire
Extended responses to commands using CommandScope
Rules for naming WebSphere MQ objects
Name lengths
Generic values
Authority checking for PCF commands
WebSphere MQ for iSeries
WebSphere MQ for Windows, and UNIX systems
WebSphere MQ for HP OpenVMS and Compaq NonStop Kernel
WebSphere MQ for z/OS
Definitions of the Programmable Command Formats
How the definitions are shown
Commands
Responses
Parameters and response data
Constants
Informational messages
Error codes
PCF commands and responses in groups
Authentication Information commands
Authority Record commands
CF commands
Channel commands
Cluster commands
Connection commands
Escape command
Namelist commands
Process commands
Queue commands
Queue Manager commands
Security commands
Service commands
Storage class commands
System commands
Data responses to commands
Definitions of Programmable Command Formats
Backup CF Structure
Required parameters
Optional parameters
Change, Copy, and Create Authentication Information Object
Required parameters (Change authentication information)
Required parameters (Copy authentication information)
Required parameters (Create authentication information)
Optional parameters
Change, Copy, and Create CF Structure
Required parameters (Change and Create CF Structure)
Required parameters (Copy CF Structure)
Optional parameters
Change, Copy and Create Channel
Required parameters (Change, Create Channel)
Required parameters (Copy Channel)
Optional parameters
Error codes
Change, Copy, and Create Channel Listener
Required parameters (Change and Create Channel Listener)
Required parameters (Copy Channel Listener)
Optional parameters
Change, Copy, and Create Namelist
Required parameter (Change and Create Namelist)
Required parameters (Copy Namelist)
Optional parameters
Change, Copy, and Create Process
Required parameters (Change and Create Process)
Required parameters (Copy Process)
Optional parameters
Change, Copy, and Create Queue
Required parameters (Change and Create Queue)
Required parameters (Copy Queue)
Required parameters (all commands)
Optional parameters
Error codes
Change Queue Manager
Optional parameters
Error codes
Change Security
Optional parameters
Change, Copy, and Create Service
Required parameter (Change and Create Service)
Required parameters (Copy Service)
Optional parameters
Change, Copy, and Create Storage Class
Required parameters (Change and Create Storage Class)
Required parameters (Copy Storage Class)
Optional parameters
Clear Queue
Required parameters
Optional parameters
Error codes
Delete Authentication Information Object
Required parameters
Optional parameters
Delete Authority Record
Required parameters
Optional parameters
Error codes
Delete CF Structure
Required parameters
Delete Channel
Required parameters
Optional parameters
Error codes
Delete Channel Listener
Required parameters
Delete Namelist
Required parameters
Optional parameters
Delete Process
Required parameters
Optional parameters
Delete Queue
Required parameters
Optional parameters
Error codes
Delete Service
Required parameters
Delete Storage Class
Required parameters
Optional parameters
Escape
Required parameters
Error codes
Escape (Response)
Parameters
Inquire Archive
Optional parameters
Inquire Archive (Response)
Response data - archive parameter information
Response data - tape unit status information
Inquire Authentication Information Object
Required parameters
Optional parameters
Inquire Authentication Information Object (Response)
Response data
Inquire Authentication Information Object Names
Required parameters
Optional parameters
Inquire Authentication Information Object Names (Response)
Response data
Inquire Authority Records
Required parameters
Optional parameters
Error codes
Inquire Authority Records (Response)
Response data
Inquire Authority Service
Required parameters
Optional parameters
Error codes
Inquire Authority Service (Response)
Response data
Inquire CF Structure
Required parameters
Optional parameters
Inquire CF Structure (Response)
Response data
Inquire CF Structure Names
Required parameters
Inquire CF Structure Names (Response)
Response data
Inquire CF Structure Status
Required parameters
Optional parameters
Inquire CF Structure Status (Response)
Response data
Inquire Channel
Required parameters
Optional parameters
Error codes
Inquire Channel (Response)
Response data
Inquire Channel Initiator
Optional parameters
Inquire Channel Initiator (Response)
Response data - channel initiator information
Response data - listener information
Inquire Channel Listener
Required parameters
Optional parameters
Inquire Channel Listener (Response)
Response data
Inquire Channel Listener Status
Required parameters
Optional parameters
Error codes
Inquire Channel Listener Status (Response)
Response data
Inquire Channel Names
Required parameters
Optional parameters
Error codes
Inquire Channel Names (Response)
Response data
Inquire Channel Status
Required parameters
Optional parameters
Error codes
Inquire Channel Status (Response)
Response data
Inquire Cluster Queue Manager
Required parameters
Optional parameters
Inquire Cluster Queue Manager (Response)
Response data
Inquire Connection
Required parameters
Optional parameters
Error codes
Inquire Connection (Response)
Response data
Inquire Entity Authority
Required parameters
Optional parameters
Error codes
Inquire Entity Authority (Response)
Response data
Inquire Group
Inquire Group (Response)
Response data relating to the queue manager
Response data relating to obsolete DB2(R) messages
Inquire Log
Optional parameters
Inquire Log (Response)
Response data - log parameter information
Response data - to log status information
Inquire Namelist
Required parameters
Optional parameters
Inquire Namelist (Response)
Response data
Inquire Namelist Names
Required parameters
Optional parameters
Inquire Namelist Names (Response)
Response data
Inquire Process
Required parameters
Optional parameters
Inquire Process (Response)
Response data
Inquire Process Names
Required parameters
Optional parameters
Inquire Process Names (Response)
Response data
Inquire Queue
Required parameters
Optional parameters
Error codes
Inquire Queue (Response)
Response data
Inquire Queue Manager
Optional parameters
Inquire Queue Manager (Response)
Response data
Inquire Queue Manager Status
Optional parameters
Inquire Queue Manager Status (Response)
Response data
Inquire Queue Names
Required parameters
Optional parameters
Inquire Queue Names (Response)
Response data
Inquire Queue Status
Required parameters
Optional parameters
Error codes
Inquire Queue Status (Response)
Response data if StatusType is MQIACF_Q_STATUS
Response data if StatusType is MQIACF_Q_HANDLE
Inquire Security
Optional parameters
Inquire Security (Response)
Response data
Inquire Service
Required parameters
Optional parameters
Inquire Service (Response)
Response data
Inquire Service Status
Required parameters
Optional parameters
Error codes
Inquire Service Status (Response)
Response data
Inquire Storage Class
Required parameters
Optional parameters
Inquire Storage Class (Response)
Response data
Inquire Storage Class Names
Required parameters
Optional parameters
Inquire Storage Class Names (Response)
Response data
Inquire System
Optional parameters
Inquire System (Response)
Response data
Inquire Usage
Optional parameters
Inquire Usage (Response)
Response data if UsageType is MQIACF_USAGE_PAGESET
Response data if UsageType is MQIACF_USAGE_BUFFER_POOL
Response data if UsageType is MQIACF_USAGE_DATA_SET
Move Queue
Required parameters
Optional parameters
Ping Channel
Required parameters
Optional parameters
Error codes
Ping Queue Manager
Recover CF Structure
Required parameters
Optional parameters
Refresh Cluster
Required parameters
Optional parameters
Refresh Queue Manager
Required parameters
Optional parameters
Refresh Security
Optional parameters
Reset Channel
Required parameters
Optional parameters
Error codes
Reset Cluster
Required parameters
Optional parameters
Error codes
Reset Queue Manager
Required parameters
Error codes
Reset Queue Statistics
Required parameters
Optional parameters
Error codes
Reset Queue Statistics (Response)
Response data
Resolve Channel
Required parameters
Optional parameters
Error codes
Resume Queue Manager
Required parameters
Optional parameters
Resume Queue Manager Cluster
Required parameters
Optional parameters
Error codes
Reverify Security
Required parameters
Optional parameters
Set Archive
Required parameters
Optional parameters
Set Authority Record
Required parameters
Optional parameters
Error codes
Set Log
Required parameters
Optional parameters
Set System
Required parameters
Optional parameters
Start Channel
Required parameters
Optional parameters
Error codes
Start Channel Initiator
Required parameters
Optional parameters
Error codes
Start Channel Listener
Optional parameters
Error codes
Start Service
Required parameters
Error codes
Stop Channel
Required parameters
Optional parameters
Error codes
Stop Channel Initiator
Optional parameters
Stop Channel Listener
Required parameters
Optional parameters
Error codes
Stop Connection
Required parameters
Stop Service
Required parameters
Error codes
Suspend Queue Manager
Required parameters
Optional parameters
Suspend Queue Manager Cluster
Required parameters
Optional parameters
Error codes
Structures used for commands and responses
How the structures are shown
Data types
Initial values and default structures
Usage notes
MQCFH - PCF header
Fields
Language declarations
MQCFBF - PCF byte string filter parameter
Fields
Language declarations
MQCFBS -- PCF byte string parameter
Fields
Language declarations
MQCFIF - PCF integer filter parameter
Fields
Language declarations
MQCFIL - PCF integer list parameter
Fields
Language declarations
MQCFIN - PCF integer parameter
Fields
Language declarations
MQCFSF - PCF string filter parameter
Fields
Language declarations
MQCFSL - PCF string list parameter
Fields
Language declarations
MQCFST - PCF string parameter
Fields
Language declarations
Example of using PCFs
Enquire local queue attributes
Program listing
Message Queuing Administration Interface
Introduction to the WebSphere MQ Administration Interface (MQAI)
MQAI concepts and terminology
Use of the MQAI
How do I use the MQAI?
Overview
Building your MQAI application
Using data bags
Types of data bag
Creating and deleting data bags
Deleting data bags
Types of data item
Adding data items to bags
Adding an inquiry command to a bag
Changing information within a bag
Counting data items
Deleting data items
Deleting data items from a bag using the mqDeleteItem call
Clearing a bag using the mqClearBag call
Truncating a bag using the mqTruncateBag call
Inquiring within data bags
System items
Configuring WebSphere MQ using mqExecute
Sending administration commands to the command server
Example code
Hints and tips for configuring WebSphere MQ
Exchanging data between applications
Converting bags and buffers
Putting and receiving data bags
Sending PCF messages to a specified queue
Receiving PCF messages from a specified queue
MQAI reference
mqAddBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddByteString
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddByteStringFilter
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddInquiry
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
Supported INQUIRE command codes
mqAddInteger
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddInteger64
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddIntegerFilter
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddString
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqAddStringFilter
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqBagToBuffer
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqBufferToBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqClearBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqCountItems
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqCreateBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqDeleteBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqDeleteItem
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqExecute
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqGetBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqInquireBag
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireByteString
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireByteStringFilter
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireInteger
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireInteger64
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireIntegerFilter
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireItemInfo
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireString
Syntax
Parameters
C language invocation
Visual Basic invocation
mqInquireStringFilter
Syntax
Parameters
C language invocation
Visual Basic invocation
mqPad
Syntax
Parameters
Usage notes
C language invocation
mqPutBag
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetByteString
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetByteStringFilter
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetInteger
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetInteger64
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetIntegerFilter
Syntax
Parameters
C language invocation
Visual Basic invocation
mqSetString
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqSetStringFilter
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
mqTrim
Syntax
Parameters
Usage notes
C language invocation
mqTruncateBag
Syntax
Parameters
Usage notes
C language invocation
Visual Basic invocation
MQAI Selectors
User selectors
System selectors
Examples of using the MQAI
Creating a local queue (amqsaicq.c)
Inquiring about queues and printing information (amqsailq.c)
Displaying events using an event monitor (amqsaiem.c)
Advanced topics
Indexing
Data conversion
Use of the message descriptor
Appendixes
Appendix. Notices
Trademarks
Index