Table of Contents (exploded view)
Abstract for MVS Programming: Sysplex Services Reference
Summary of changes
Summary of changes
Summary of changes for z/OS Version 2 Release 1 (V2R1) as updated March 2014
z/OS Version 2 Release 1 summary of changes
How to read syntax diagrams
Symbols
Syntax items
Syntax examples
Specifying a Macro Version Number
How to Request a Macro Version
General Considerations When Using PLISTVER
IHABLDP — Build Dump Parameter List Service
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IHABLDP Version Support
Syntax
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXCARM — Request Automatic Restart Management Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCARM Version Support
Syntax
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCCFCM — Coupling Facility Configuration Management
Description
Recovery Manager Concepts
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXCCREAT — Define a Member to XCF
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCDELET — Change an XCF Member's State to Not-Defined
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCJOIN — Place an XCF Member in the Active State
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCJOIN Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCLEAVE — Place an XCF Member in the Not-Defined State
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCMG — Obtain Tuning and Capacity Planning Data
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCMG Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCMOD — Modify Status-Checking Interval
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCMSGC — XCF Message Control
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Understanding IXCMSGC Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXCMSGI — Receive a Message from Another Member in the XCF Group
IXCMSGIX — Receive a Message from Another Member in the XCF Group
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCMSGIX Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCMSGO — Send a Message to Another Member in the XCF Group
IXCMSGOX — Send a Message to Another Member in the XCF Group
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCMSGOX Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCNOTE — XCF Note Pad Interface
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCNOTE Version Support
Syntax
Parameters
Parameters Common to All Requests
Parameters for REQUEST=NOTEPAD
Parameters for REQUEST=CONNECTION
Parameters for REQUEST=NOTE
Parameters for REQUEST=NOTES
ABEND Codes
Return and Reason Codes
Examples
IXCQUERY — Obtain XCF Information
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCQUERY Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
Example
IXCQUIES — Place an XCF Member in a Quiesced State
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCRECV— Receive Client/Server Information
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCRECV Version Support
Syntax
Parameters
ABEND Codes
Return and Reason Codes
Example
IXCREQ — Format a Request for the XCF Server
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax
Parameters
ABEND Codes
Return and Reason Codes
Example
IXCSEND — Send Client/Server Requests and Responses
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCSEND Version Support
Syntax
Parameters
ABEND Codes
Return and Reason Codes
Examples
IXCSETUS — Update the User State Field
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCSETUS Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCSRVR — Define a Server to XCF
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax
Parameters
ABEND Codes
Return and Reason Codes
Example
IXCSYSCL — Notify the System that Cleanup Has Completed
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXCSYSCL Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXCTERM — Terminate a Member of an XCF Group
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example
IXLALTER — Alter a Coupling Facility Structure
Description
Environment
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Understanding IXLALTER Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLCACHE — Cache Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLCACHE Version Support
IXLCACHE REQUEST=CASTOUT_DATA
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=CASTOUT_DATALIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=CROSS_INVAL
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=CROSS_INVALLIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=DELETE_NAME
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=DELETE_NAMELIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=PROCESS_REFLIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=READ_COCLASS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=READ_COSTATS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=READ_DATA
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=READ_DIRINFO
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=READ_STGSTATS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=REG_NAMELIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=RESET_REFBIT
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=SET_RECLVCTR
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=UNLOCK_CASTOUT
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=UNLOCK_CO_NAME
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=WRITE_DATA
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCACHE REQUEST=WRITE_DATALIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLCONN — Connect to a Coupling Facility Structure
Description
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Understanding IXLCONN Version Support
Syntax Diagram
Parameter Descriptions
Parameters common to all structure types
Parameters for TYPE=CACHE
Parameters for TYPE=LIST
Parameters for TYPE=LOCK
Return and Reason Codes for the IXLCONN macro
IXLCSP — XES Structure Computation Service
Description
Environment
Programming Requirements
Input Register Information
Output Register Information
Performance Implications
Understanding IXLCSP Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLDISC — Disconnecting from a Coupling Facility Structure
Description
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Understanding IXLDISC Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLEERSP — Responding to an Event
Description
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Understanding IXLEERSP Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLFCOMP — Wait for Completion or Obtain Status of an IXLLIST or IXLCACHE Request
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLFORCE — Deleting a Persistent Structure or Failed Connection
Description
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLLIST — List Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLLIST Version Support
Coding Equivalent Functions
IXLLIST REQUEST=DELETE
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=DELETE_ENTRYLIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=DELETE_MULT
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=DEQ_EVENTQ
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=LOCK
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=MONITOR_EVENTQ
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=MONITOR_LIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=MONITOR_SUBLIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=MONITOR_SUBLISTS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=MOVE
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ_EMCONTROLS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ_EQCONTROLS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ_LCONTROLS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ_LIST
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=READ_MULT
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=WRITE
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLIST REQUEST=WRITE_LCONTROLS
Description
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLOCK Services
Description
Environment
Programming Requirements
Restrictions and Limitations
Input Register Information
Output Register Information
Performance Implications
Understanding IXLLOCK Version Support
Syntax Diagram
Parameter Descriptions
REQUEST=OBTAIN
REQUEST=ALTER
REQUEST=RELEASE
REQUEST=PROCESSMULT
ABEND Codes
Return and Reason Codes
IXLLSTC — XES List Structure Control Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLLSTC Version Support
Summary of Version-Dependent Parameter Functions
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLSTE — XES List Structure Single Entry Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLLSTE Version Support
Summary of Version-Dependent Parameter Functions
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLLSTM — XES List Structure Multiple Entry Services
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLLSTM Version Support
Summary of Version-Dependent Parameter Functions
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLMG — Coupling Facility Measurement
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLMG Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLPURGE — Purge Operations to a Coupling Facility
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLREBLD — Rebuilding or Duplexing a Structure
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Understanding IXLREBLD Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLRT — Lock Structure Record Data Processing
Description
Environment
Programming Requirements
Restrictions and Limitations
Input Register Information
Output Register Information
Performance Implications
Understanding IXLRT Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLSYNCH — Synchronous Update to a Lock Structure
Description
Environment
Programming Requirements
Restrictions and Limitations
Input Register Information
Output Register Information
Performance Implications
Understanding IXLSYNCH Version Support
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
IXLUSYNC — Synchronizing Processing for User-Defined Events
Description
Environment
Restrictions
Input Register Information
Output Register Information
Programming Requirements
Performance Implications
Understanding IXLUSYNC Version Support
Syntax Diagram
Parameter Descriptions
Return and Reason Codes
IXLVECTR — Check or Modify Local Cache Vector or List Notification Vector
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return Codes
IXLZSTR — Coupling Facility Structure Data Access Service
Description
Environment
Programming Requirements
Restrictions
Input Register Information
Output Register Information
Performance Implications
Syntax Diagram
Parameter Descriptions
ABEND Codes
Return and Reason Codes
Example