Programmable Command Formats and Administration Interface

  1. Programmable Command Formats and Administration Interface
  2. About this book
  3. Who this book is for
  4. What you need to know to understand this book
  5. How to use this book
  6. Appendixes
  7. Summary of changes
  8. Changes for this edition (SC34-6598-01)
  9. Changes for the previous edition (SC34-6598-00)
  10. Changes to PCF commands and responses
  11. Changes to the MQAI
  12. Changes to make this manual easier to use
  13. Programmable Command Formats
  14. Introduction to Programmable Command Formats
  15. The problem PCF commands solve
  16. What PCFs are
  17. Other administration interfaces
  18. WebSphere MQ for iSeries
  19. i5/OS Control Language (CL)
  20. WebSphere MQ Commands (MQSC)
  21. WebSphere MQ for z/OS
  22. MQSeries for Compaq NonStop Kernel, V5.1
  23. WebSphere MQ for Windows, UNIX systems and HP OpenVMS
  24. WebSphere MQ commands (MQSC)
  25. Control commands
  26. WebSphere MQ Explorer - WebSphere MQ for Windows and WebSphere MQ for Linux (x86 platform)
  27. The WebSphere MQ Administration Interface (MQAI)
  28. Using Programmable Command Formats
  29. PCF command messages
  30. How to issue PCF command messages
  31. Message descriptor for a PCF command
  32. Sending user data
  33. Responses
  34. Message descriptor for a response
  35. Standard responses
  36. OK response
  37. Error response
  38. Data response
  39. Extended responses
  40. Extended responses to Inquire commands
  41. Extended responses to commands other than Inquire
  42. Extended responses to commands using CommandScope
  43. Rules for naming WebSphere MQ objects
  44. Name lengths
  45. Reserved object names
  46. Generic values
  47. Authority checking for PCF commands
  48. WebSphere MQ for iSeries
  49. WebSphere MQ for Windows, and UNIX systems
  50. WebSphere MQ for HP OpenVMS and Compaq NonStop Kernel
  51. WebSphere MQ for z/OS
  52. Definitions of the Programmable Command Formats
  53. How the definitions are shown
  54. Commands
  55. Responses
  56. Parameters and response data
  57. Constants
  58. Informational messages
  59. Error codes
  60. Error codes applicable to all commands
  61. PCF commands and responses in groups
  62. Authentication Information commands
  63. Authority Record commands
  64. CF commands
  65. Channel commands
  66. Cluster commands
  67. Connection commands
  68. Escape command
  69. Namelist commands
  70. Process commands
  71. Queue commands
  72. Queue Manager commands
  73. Security commands
  74. Service commands
  75. Storage class commands
  76. System commands
  77. Data responses to commands
  78. Definitions of Programmable Command Formats
  79. Backup CF Structure
  80. Required parameters
  81. Optional parameters
  82. Change, Copy, and Create Authentication Information Object
  83. Required parameters (Change authentication information)
  84. Required parameters (Copy authentication information)
  85. Required parameters (Create authentication information)
  86. Optional parameters
  87. Change, Copy, and Create CF Structure
  88. Required parameters (Change and Create CF Structure)
  89. Required parameters (Copy CF Structure)
  90. Optional parameters
  91. Change, Copy and Create Channel
  92. Required parameters (Change, Create Channel)
  93. Required parameters (Copy Channel)
  94. Optional parameters
  95. Error codes
  96. Change, Copy, and Create Channel Listener
  97. Required parameters (Change and Create Channel Listener)
  98. Required parameters (Copy Channel Listener)
  99. Optional parameters
  100. Change, Copy, and Create Namelist
  101. Required parameter (Change and Create Namelist)
  102. Required parameters (Copy Namelist)
  103. Optional parameters
  104. Change, Copy, and Create Process
  105. Required parameters (Change and Create Process)
  106. Required parameters (Copy Process)
  107. Optional parameters
  108. Change, Copy, and Create Queue
  109. Required parameters (Change and Create Queue)
  110. Required parameters (Copy Queue)
  111. Required parameters (all commands)
  112. Optional parameters
  113. Error codes
  114. Change Queue Manager
  115. Optional parameters
  116. Error codes
  117. Change Security
  118. Optional parameters
  119. Change, Copy, and Create Service
  120. Required parameter (Change and Create Service)
  121. Required parameters (Copy Service)
  122. Optional parameters
  123. Change, Copy, and Create Storage Class
  124. Required parameters (Change and Create Storage Class)
  125. Required parameters (Copy Storage Class)
  126. Optional parameters
  127. Clear Queue
  128. Required parameters
  129. Optional parameters
  130. Error codes
  131. Delete Authentication Information Object
  132. Required parameters
  133. Optional parameters
  134. Delete Authority Record
  135. Required parameters
  136. Optional parameters
  137. Error codes
  138. Delete CF Structure
  139. Required parameters
  140. Delete Channel
  141. Required parameters
  142. Optional parameters
  143. Error codes
  144. Delete Channel Listener
  145. Required parameters
  146. Delete Namelist
  147. Required parameters
  148. Optional parameters
  149. Delete Process
  150. Required parameters
  151. Optional parameters
  152. Delete Queue
  153. Required parameters
  154. Optional parameters
  155. Error codes
  156. Delete Service
  157. Required parameters
  158. Delete Storage Class
  159. Required parameters
  160. Optional parameters
  161. Escape
  162. Required parameters
  163. Error codes
  164. Escape (Response)
  165. Parameters
  166. Inquire Archive
  167. Optional parameters
  168. Inquire Archive (Response)
  169. Response data - archive parameter information
  170. Response data - tape unit status information
  171. Inquire Authentication Information Object
  172. Required parameters
  173. Optional parameters
  174. Inquire Authentication Information Object (Response)
  175. Response data
  176. Inquire Authentication Information Object Names
  177. Required parameters
  178. Optional parameters
  179. Inquire Authentication Information Object Names (Response)
  180. Response data
  181. Inquire Authority Records
  182. Required parameters
  183. Optional parameters
  184. Error codes
  185. Inquire Authority Records (Response)
  186. Response data
  187. Inquire Authority Service
  188. Required parameters
  189. Optional parameters
  190. Error codes
  191. Inquire Authority Service (Response)
  192. Response data
  193. Inquire CF Structure
  194. Required parameters
  195. Optional parameters
  196. Inquire CF Structure (Response)
  197. Response data
  198. Inquire CF Structure Names
  199. Required parameters
  200. Inquire CF Structure Names (Response)
  201. Response data
  202. Inquire CF Structure Status
  203. Required parameters
  204. Optional parameters
  205. Inquire CF Structure Status (Response)
  206. Response data
  207. Inquire Channel
  208. Required parameters
  209. Optional parameters
  210. Error codes
  211. Inquire Channel (Response)
  212. Response data
  213. Inquire Channel Initiator
  214. Optional parameters
  215. Inquire Channel Initiator (Response)
  216. Response data - channel initiator information
  217. Response data - listener information
  218. Inquire Channel Listener
  219. Required parameters
  220. Optional parameters
  221. Inquire Channel Listener (Response)
  222. Response data
  223. Inquire Channel Listener Status
  224. Required parameters
  225. Optional parameters
  226. Error codes
  227. Inquire Channel Listener Status (Response)
  228. Response data
  229. Inquire Channel Names
  230. Required parameters
  231. Optional parameters
  232. Error codes
  233. Inquire Channel Names (Response)
  234. Response data
  235. Inquire Channel Status
  236. Required parameters
  237. Optional parameters
  238. Error codes
  239. Inquire Channel Status (Response)
  240. Response data
  241. Inquire Cluster Queue Manager
  242. Required parameters
  243. Optional parameters
  244. Inquire Cluster Queue Manager (Response)
  245. Response data
  246. Inquire Connection
  247. Required parameters
  248. Optional parameters
  249. Error codes
  250. Inquire Connection (Response)
  251. Response data
  252. Inquire Entity Authority
  253. Required parameters
  254. Optional parameters
  255. Error codes
  256. Inquire Entity Authority (Response)
  257. Response data
  258. Inquire Group
  259. Inquire Group (Response)
  260. Response data relating to the queue manager
  261. Response data relating to obsolete DB2 messages
  262. Inquire Log
  263. Optional parameters
  264. Inquire Log (Response)
  265. Response data - log parameter information
  266. Response data - to log status information
  267. Inquire Namelist
  268. Required parameters
  269. Optional parameters
  270. Inquire Namelist (Response)
  271. Response data
  272. Inquire Namelist Names
  273. Required parameters
  274. Optional parameters
  275. Inquire Namelist Names (Response)
  276. Response data
  277. Inquire Process
  278. Required parameters
  279. Optional parameters
  280. Inquire Process (Response)
  281. Response data
  282. Inquire Process Names
  283. Required parameters
  284. Optional parameters
  285. Inquire Process Names (Response)
  286. Response data
  287. Inquire Queue
  288. Required parameters
  289. Optional parameters
  290. Error codes
  291. Inquire Queue (Response)
  292. Response data
  293. Inquire Queue Manager
  294. Optional parameters
  295. Inquire Queue Manager (Response)
  296. Response data
  297. Inquire Queue Manager Status
  298. Optional parameters
  299. Inquire Queue Manager Status (Response)
  300. Response data
  301. Inquire Queue Names
  302. Required parameters
  303. Optional parameters
  304. Inquire Queue Names (Response)
  305. Response data
  306. Inquire Queue Status
  307. Required parameters
  308. Optional parameters
  309. Error codes
  310. Inquire Queue Status (Response)
  311. Response data if StatusType is MQIACF_Q_STATUS
  312. Response data if StatusType is MQIACF_Q_HANDLE
  313. Inquire Security
  314. Optional parameters
  315. Inquire Security (Response)
  316. Response data
  317. Inquire Service
  318. Required parameters
  319. Optional parameters
  320. Inquire Service (Response)
  321. Response data
  322. Inquire Service Status
  323. Required parameters
  324. Optional parameters
  325. Error codes
  326. Inquire Service Status (Response)
  327. Response data
  328. Inquire Storage Class
  329. Required parameters
  330. Optional parameters
  331. Inquire Storage Class (Response)
  332. Response data
  333. Inquire Storage Class Names
  334. Required parameters
  335. Optional parameters
  336. Inquire Storage Class Names (Response)
  337. Response data
  338. Inquire System
  339. Optional parameters
  340. Inquire System (Response)
  341. Response data
  342. Inquire Usage
  343. Optional parameters
  344. Inquire Usage (Response)
  345. Response data if UsageType is MQIACF_USAGE_PAGESET
  346. Response data if UsageType is MQIACF_USAGE_BUFFER_POOL
  347. Response data if UsageType is MQIACF_USAGE_DATA_SET
  348. Move Queue
  349. Required parameters
  350. Optional parameters
  351. Ping Channel
  352. Required parameters
  353. Optional parameters
  354. Error codes
  355. Ping Queue Manager
  356. Recover CF Structure
  357. Required parameters
  358. Optional parameters
  359. Refresh Cluster
  360. Required parameters
  361. Optional parameters
  362. Refresh Queue Manager
  363. Required parameters
  364. Optional parameters
  365. Refresh Security
  366. Optional parameters
  367. Reset Channel
  368. Required parameters
  369. Optional parameters
  370. Error codes
  371. Reset Cluster
  372. Required parameters
  373. Optional parameters
  374. Error codes
  375. Reset Queue Manager
  376. Required parameters
  377. Error codes
  378. Reset Queue Statistics
  379. Required parameters
  380. Optional parameters
  381. Error codes
  382. Reset Queue Statistics (Response)
  383. Response data
  384. Resolve Channel
  385. Required parameters
  386. Optional parameters
  387. Error codes
  388. Resume Queue Manager
  389. Required parameters
  390. Optional parameters
  391. Resume Queue Manager Cluster
  392. Required parameters
  393. Optional parameters
  394. Error codes
  395. Reverify Security
  396. Required parameters
  397. Optional parameters
  398. Set Archive
  399. Required parameters
  400. Optional parameters
  401. Set Authority Record
  402. Required parameters
  403. Optional parameters
  404. Error codes
  405. Set Log
  406. Required parameters
  407. Optional parameters
  408. Set System
  409. Required parameters
  410. Optional parameters
  411. Start Channel
  412. Required parameters
  413. Optional parameters
  414. Error codes
  415. Start Channel Initiator
  416. Required parameters
  417. Optional parameters
  418. Error codes
  419. Start Channel Listener
  420. Optional parameters
  421. Error codes
  422. Start Service
  423. Required parameters
  424. Error codes
  425. Stop Channel
  426. Required parameters
  427. Optional parameters
  428. Error codes
  429. Stop Channel Initiator
  430. Optional parameters
  431. Stop Channel Listener
  432. Required parameters
  433. Optional parameters
  434. Error codes
  435. Stop Connection
  436. Required parameters
  437. Stop Service
  438. Required parameters
  439. Error codes
  440. Suspend Queue Manager
  441. Required parameters
  442. Optional parameters
  443. Suspend Queue Manager Cluster
  444. Required parameters
  445. Optional parameters
  446. Error codes
  447. Structures for commands and responses
  448. How the structures are shown
  449. Data types
  450. Initial values and default structures
  451. Usage notes
  452. MQCFH - PCF header
  453. Fields
  454. Language declarations
  455. C language declaration
  456. COBOL language declaration
  457. PL/I language declaration (z/OS only)
  458. System/390 assembler-language declaration (z/OS only)
  459. Visual Basic language declaration (Windows only)
  460. RPG language declaration (iSeries only)
  461. MQCFBF - PCF byte string filter parameter
  462. Fields
  463. Language declarations
  464. C language declaration
  465. COBOL language declaration
  466. PL/I language declaration (z/OS only)
  467. System/390 assembler-language declaration (z/OS only)
  468. Visual Basic language declaration (Windows only)
  469. RPG language declaration (iSeries only)
  470. MQCFBS - PCF byte string parameter
  471. Fields
  472. Language declarations
  473. C language declaration
  474. COBOL language declaration
  475. PL/I language declaration (z/OS only)
  476. System/390 assembler-language declaration (z/OS only)
  477. Visual Basic language declaration (Windows only)
  478. RPG language declaration (iSeries only)
  479. MQCFIF - PCF integer filter parameter
  480. Fields
  481. Language declarations
  482. C language declaration
  483. COBOL language declaration
  484. PL/I language declaration (z/OS only)
  485. System/390 assembler-language declaration (z/OS only)
  486. Visual Basic language declaration (Windows only)
  487. RPG language declaration (iSeries only)
  488. MQCFIL - PCF integer list parameter
  489. Fields
  490. Language declarations
  491. C language declaration
  492. COBOL language declaration
  493. PL/I language declaration (z/OS only)
  494. System/390 assembler-language declaration (z/OS only)
  495. Visual Basic language declaration (Windows only)
  496. RPG language declaration (iSeries only)
  497. MQCFIN - PCF integer parameter
  498. Fields
  499. Language declarations
  500. C language declaration
  501. COBOL language declaration
  502. PL/I language declaration (z/OS only)
  503. System/390 assembler-language declaration (z/OS only)
  504. Visual Basic language declaration (Windows only)
  505. RPG language declaration (iSeries only)
  506. MQCFSF - PCF string filter parameter
  507. Fields
  508. Language declarations
  509. C language declaration
  510. COBOL language declaration
  511. PL/I language declaration (z/OS only)
  512. System/390 assembler-language declaration (z/OS only)
  513. Visual Basic language declaration (Windows only)
  514. RPG language declaration (iSeries only)
  515. MQCFSL - PCF string list parameter
  516. Fields
  517. Language declarations
  518. C language declaration
  519. COBOL language declaration
  520. PL/I language declaration (z/OS only)
  521. System/390 assembler-language declaration (z/OS only)
  522. Visual Basic language declaration (Windows only)
  523. RPG language declaration (iSeries only)
  524. MQCFST - PCF string parameter
  525. Fields
  526. Language declarations
  527. C language declaration
  528. COBOL language declaration
  529. PL/I language declaration (z/OS only)
  530. System/390 assembler-language declaration (z/OS only)
  531. Visual Basic language declaration (Windows only)
  532. RPG language declaration (iSeries only)
  533. PCF example
  534. Inquire local queue attributes
  535. Program listing
  536. Message Queuing Administration Interface
  537. Introduction to the WebSphere MQ Administration Interface (MQAI)
  538. MQAI concepts and terminology
  539. Use of the MQAI
  540. How do I use the MQAI?
  541. Overview
  542. Building your MQAI application
  543. Using data bags
  544. Types of data bag
  545. Creating and deleting data bags
  546. Deleting data bags
  547. Types of data item
  548. Adding data items to bags
  549. Adding an inquiry command to a bag
  550. Filtering and querying data items
  551. Changing information within a bag
  552. Counting data items
  553. Deleting data items
  554. Deleting data items from a bag using the mqDeleteItem call
  555. Clearing a bag using the mqClearBag call
  556. Truncating a bag using the mqTruncateBag call
  557. Inquiring within data bags
  558. System items
  559. Configuring WebSphere MQ using mqExecute
  560. Sending administration commands to the command server
  561. Example code
  562. Hints and tips for configuring WebSphere MQ
  563. Exchanging data between applications
  564. Converting bags and buffers
  565. Putting and receiving data bags
  566. Sending PCF messages to a specified queue
  567. Receiving PCF messages from a specified queue
  568. MQAI reference
  569. mqAddBag
  570. Syntax
  571. Parameters
  572. Usage notes
  573. C language invocation
  574. Visual Basic invocation
  575. mqAddByteString
  576. Syntax
  577. Parameters
  578. Usage notes
  579. C language invocation
  580. Visual Basic invocation
  581. mqAddByteStringFilter
  582. Syntax
  583. Parameters
  584. Usage notes
  585. C language invocation
  586. Visual Basic invocation
  587. mqAddInquiry
  588. Syntax
  589. Parameters
  590. Usage notes
  591. C language invocation
  592. Visual Basic invocation
  593. Supported INQUIRE command codes
  594. mqAddInteger
  595. Syntax
  596. Parameters
  597. Usage notes
  598. C language invocation
  599. Visual Basic invocation
  600. mqAddInteger64
  601. Syntax
  602. Parameters
  603. Usage notes
  604. C language invocation
  605. Visual Basic invocation
  606. mqAddIntegerFilter
  607. Syntax
  608. Parameters
  609. Usage notes
  610. C language invocation
  611. Visual Basic invocation
  612. mqAddString
  613. Syntax
  614. Parameters
  615. Usage notes
  616. C language invocation
  617. Visual Basic invocation
  618. mqAddStringFilter
  619. Syntax
  620. Parameters
  621. Usage notes
  622. C language invocation
  623. Visual Basic invocation
  624. mqBagToBuffer
  625. Syntax
  626. Parameters
  627. Usage notes
  628. C language invocation
  629. Visual Basic invocation
  630. mqBufferToBag
  631. Syntax
  632. Parameters
  633. Usage notes
  634. C language invocation
  635. Visual Basic invocation
  636. mqClearBag
  637. Syntax
  638. Parameters
  639. Usage notes
  640. C language invocation
  641. Visual Basic invocation
  642. mqCountItems
  643. Syntax
  644. Parameters
  645. Usage notes
  646. C language invocation
  647. Visual Basic invocation
  648. mqCreateBag
  649. Syntax
  650. Parameters
  651. Usage notes
  652. C language invocation
  653. Visual Basic invocation
  654. mqDeleteBag
  655. Syntax
  656. Parameters
  657. Usage notes
  658. C language invocation
  659. Visual Basic invocation
  660. mqDeleteItem
  661. Syntax
  662. Parameters
  663. Usage notes
  664. C language invocation
  665. Visual Basic invocation
  666. mqExecute
  667. Syntax
  668. Parameters
  669. Usage notes
  670. C language invocation
  671. Visual Basic invocation
  672. mqGetBag
  673. Syntax
  674. Parameters
  675. Usage notes
  676. C language invocation
  677. Visual Basic invocation
  678. mqInquireBag
  679. Syntax
  680. Parameters
  681. C language invocation
  682. Visual Basic invocation
  683. mqInquireByteString
  684. Syntax
  685. Parameters
  686. C language invocation
  687. Visual Basic invocation
  688. mqInquireByteStringFilter
  689. Syntax
  690. Parameters
  691. C language invocation
  692. Visual Basic invocation
  693. mqInquireInteger
  694. Syntax
  695. Parameters
  696. C language invocation
  697. Visual Basic invocation
  698. mqInquireInteger64
  699. Syntax
  700. Parameters
  701. C language invocation
  702. Visual Basic invocation
  703. mqInquireIntegerFilter
  704. Syntax
  705. Parameters
  706. C language invocation
  707. Visual Basic invocation
  708. mqInquireItemInfo
  709. Syntax
  710. Parameters
  711. C language invocation
  712. Visual Basic invocation
  713. mqInquireString
  714. Syntax
  715. Parameters
  716. C language invocation
  717. Visual Basic invocation
  718. mqInquireStringFilter
  719. Syntax
  720. Parameters
  721. C language invocation
  722. Visual Basic invocation
  723. mqPad
  724. Syntax
  725. Parameters
  726. Usage notes
  727. C language invocation
  728. mqPutBag
  729. Syntax
  730. Parameters
  731. C language invocation
  732. Visual Basic invocation
  733. mqSetByteString
  734. Syntax
  735. Parameters
  736. C language invocation
  737. Visual Basic invocation
  738. mqSetByteStringFilter
  739. Syntax
  740. Parameters
  741. C language invocation
  742. Visual Basic invocation
  743. mqSetInteger
  744. Syntax
  745. Parameters
  746. C language invocation
  747. Visual Basic invocation
  748. mqSetInteger64
  749. Syntax
  750. Parameters
  751. C language invocation
  752. Visual Basic invocation
  753. mqSetIntegerFilter
  754. Syntax
  755. Parameters
  756. C language invocation
  757. Visual Basic invocation
  758. mqSetString
  759. Syntax
  760. Parameters
  761. Usage notes
  762. C language invocation
  763. Visual Basic invocation
  764. mqSetStringFilter
  765. Syntax
  766. Parameters
  767. Usage notes
  768. C language invocation
  769. Visual Basic invocation
  770. mqTrim
  771. Syntax
  772. Parameters
  773. Usage notes
  774. C language invocation
  775. mqTruncateBag
  776. Syntax
  777. Parameters
  778. Usage notes
  779. C language invocation
  780. Visual Basic invocation
  781. MQAI Selectors
  782. User selectors
  783. System selectors
  784. Examples of using the MQAI
  785. Creating a local queue (amqsaicq.c)
  786. Inquiring about queues and printing information (amqsailq.c)
  787. Displaying events using an event monitor (amqsaiem.c)
  788. Advanced topics
  789. Indexing
  790. Data conversion
  791. Use of the message descriptor
  792. Notices
  793. Trademarks