Version 2 Release 4 z/OS - IBMfile/izua700_v2r4.pdf · 2020-05-29 · Summary of changes made in...

z/OSVersion 2 Release 4

IBM z/OS Management FacilityProgramming Guide

IBM

SC27-8420-40

Note

Before using this information and the product it supports, read the information in “Notices” on page923.

This edition applies to Version 2 Release 4 of z/OS (5650-ZOS) and to all subsequent releases and modifications untilotherwise indicated in new editions.

Last updated: 2020-07-29© Copyright International Business Machines Corporation 2013, 2020.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp.

Contents

Figures................................................................................................................. ix

Tables.............................................................................................................. xxix

About this document..........................................................................................xlixWho should use this document................................................................................................................xlixWhere to find more information............................................................................................................... xlix

How to send your comments to IBM....................................................................... liIf you have a technical problem...................................................................................................................li

Summary of changes............................................................................................liiiSummary of changes for z/OSMF Programming Guide for Version 2 Release 4 (V2R4).......................... liiiSummary of changes made in z/OSMF Version 2 Release 3, as updated June 2019............................... lvSummary of changes made in z/OSMF Version 2 Release 3, as updated March 2019.............................lvSummary of changes made in z/OSMF Version 2 Release 3, as updated December 2018..................... lviSummary of changes made in z/OSMF Version 2 Release 3, as updated August 2018..........................lviiSummary of changes made in z/OSMF Version 2 Release 3, as updated July 2018.............................. lviiSummary of changes made in z/OSMF Version 2 Release 3, as updated June 2018............................. lviiSummary of changes made in z/OSMF Version 2 Release 3, as updated March 2018............................lixSummary of changes made in z/OSMF Version 2 Release 3, as updated December 2017..................... lixSummary of changes made in z/OS Version 2 Release 3, as updated October 2017...............................lxSummary of changes made in z/OS Version 2 Release 3...........................................................................lxSummary of changes made in z/OSMF Version 2 Release 2, as updated April 2017.............................. lxiSummary of changes made in z/OSMF Version 2 Release 2, as updated March 2017...........................lxiiSummary of changes made in z/OSMF Version 2 Release 2, as updated December 2016.................... lxiiSummary of changes made in z/OSMF Version 2 Release 2, as updated September 2016..................lxiiiSummary of changes made in z/OSMF Version 2 Release 2, as updated June 2016............................ lxivSummary of changes made in z/OSMF Version 2 Release 2, as updated March 2016...........................lxvChanges made in z/OSMF Version 2 Release 2, SC27-8420-00............................................................. lxvChanges made in z/OSMF Version 2 Release 1, SA32-1066-04............................................................ lxviChanges made in z/OSMF Version 2 Release 1, SA32-1066-03........................................................... lxviiChanges made in z/OSMF Version 2 Release 1, SA32-1066-02.......................................................... lxviiiChanges made in z/OSMF Version 2 Release 1, SA32-1066-01............................................................ lxixFor z/OSMF Version 2 Release 1, SA32-1066-00.................................................................................... lxxInformation applicable to all releases..................................................................................................... lxxi

Chapter 1. Using the z/OSMF REST services........................................................... 1Application Linking Manager interface services..........................................................................................6

Event types, requestors, and handlers shipped with z/OSMF.............................................................. 9Register an event type..........................................................................................................................23Register an event handler.................................................................................................................... 25Obtain a list of all tasks that are eligible to be handlers..................................................................... 28Obtain a list of handlers for an event type...........................................................................................29Unregister an event handler.................................................................................................................30Unregister an event type...................................................................................................................... 31

Application server routing services........................................................................................................... 32Retrieve data from an application server............................................................................................ 34Update data for an application server................................................................................................. 39

iii

Delete data from an application server............................................................................................... 41Cloud provisioning services.......................................................................................................................45

Resource pool services........................................................................................................................ 49Resource management services..........................................................................................................75Software services template services.................................................................................................141Published software service template services..................................................................................226Software services instance services..................................................................................................256Software service instance name services......................................................................................... 323

Data persistence services....................................................................................................................... 332Persist user or application data......................................................................................................... 334Retrieve persisted user or application data...................................................................................... 336Delete persisted user or application data......................................................................................... 338

Multisystem routing services.................................................................................................................. 340Retrieve data from one or more systems.......................................................................................... 345Update data for one or more systems............................................................................................... 352Delete data from one or more systems............................................................................................. 358Authenticate with a secondary z/OSMF instance............................................................................. 364Authenticate with an HTTP proxy server...........................................................................................366

MVS subsystem services......................................................................................................................... 367List MVS subsystems......................................................................................................................... 368

Notification services................................................................................................................................ 370Get all of the notifications received by the current user...................................................................371Send a notification from a z/OSMF task, when the content is the message from the bundle file .. 372Send a notification and mail from a z/OSMF task or z/OSMF user................................................... 375Send a notification from a third party product.................................................................................. 377

Software management services..............................................................................................................380List the software instances defined to z/OSMF.................................................................................382Retrieve the properties of a software instance................................................................................. 384List the data sets included in a software instance............................................................................ 390Add a new software instance.............................................................................................................395Export a defined software instance...................................................................................................402Modify the properties of a software instance....................................................................................407Load the products, features, and FMIDs for a software instance.....................................................413Delete a software instance................................................................................................................ 418Add a new portable software instance..............................................................................................420

Topology services.................................................................................................................................... 422List the systems defined to z/OSMF.................................................................................................. 424List the groups defined to z/OSMF.................................................................................................... 426List the systems included in a group................................................................................................. 428List the sysplexes defined to z/OSMF................................................................................................431List the systems included in a sysplex.............................................................................................. 433List the systems included in a CPC.................................................................................................... 435

TSO/E address space services................................................................................................................ 438Start or reconnect to a TSO/E address space................................................................................... 442Start an application in a TSO/E address space................................................................................. 446Send messages to a TSO/E address space....................................................................................... 448Send messages to an application...................................................................................................... 450Ping a TSO/E address space.............................................................................................................. 451Receive messages from a TSO/E address space.............................................................................. 453Receive messages from an application............................................................................................. 454End a TSO/E address space............................................................................................................... 455

WLM resource pooling services...............................................................................................................457Prime a WLM resource pool............................................................................................................... 458Delete a WLM resource pool.............................................................................................................. 460Construct a WLM service definition................................................................................................... 461Construct a WLM service definition with remove and install............................................................463

RMF metering services............................................................................................................................ 465Get metered data............................................................................................................................... 466

iv

Get DDS server time data...................................................................................................................468z/OS console services..............................................................................................................................470

Issue a command...............................................................................................................................472Get a command response..................................................................................................................489Get the detect result for unsolicited messages................................................................................ 495

z/OS data set and file REST interface..................................................................................................... 502List the z/OS data sets on a system...................................................................................................508List the members of a z/OS data set..................................................................................................511Retrieve the contents of a z/OS data set or member........................................................................513Write data to a z/OS data set or member.......................................................................................... 518Create a sequential and partitioned data set....................................................................................523Delete a sequential and partitioned data set.................................................................................... 526Delete a partitioned data set member.............................................................................................. 527z/OS Data set and member utilities...................................................................................................529Access Method Services Interface.................................................................................................... 533List the files and directories of a UNIX file path................................................................................534Retrieve the contents of a z/OS UNIX file......................................................................................... 539Write data to a z/OS UNIX file............................................................................................................542Create a UNIX file or directory...........................................................................................................545Delete a UNIX file or directory...........................................................................................................547z/OS UNIX file utilities........................................................................................................................549List z/OS UNIX Filesystems............................................................................................................... 554Create a z/OS UNIX zFS filesystem................................................................................................... 556Delete z/OS UNIX zFS Filesystem..................................................................................................... 557Mount a UNIX file system.................................................................................................................. 558Unmount a UNIX file system..............................................................................................................560JSON document specifications for z/OS data set and file REST interface requests........................561Error reporting categories..................................................................................................................571

z/OS jobs REST interface.........................................................................................................................578Obtain the status of a job...................................................................................................................583List the jobs for an owner, prefix, or job ID....................................................................................... 585List the spool files for a job................................................................................................................ 588Retrieve the contents of a job spool file............................................................................................ 590Submit a job........................................................................................................................................593Hold a job............................................................................................................................................598Release a job...................................................................................................................................... 600Change the job class.......................................................................................................................... 602Cancel a job........................................................................................................................................ 604Cancel a job and purge its output...................................................................................................... 606JSON document specifications for z/OS jobs REST interface requests........................................... 608Error reporting categories..................................................................................................................615

z/OSMF information retrieval service......................................................................................................626Retrieve z/OSMF information.............................................................................................................627

z/OSMF settings services........................................................................................................................ 629Persist z/OSMF settings for a user or plug-in....................................................................................631Retrieve persisted z/OSMF settings data.......................................................................................... 633Delete persisted z/OSMF settings data............................................................................................. 634

z/OSMF system variable services............................................................................................................635Create or update system variables....................................................................................................637Get system variables..........................................................................................................................638Import system variables.................................................................................................................... 640Export system variables.....................................................................................................................641Delete system variables.....................................................................................................................643

z/OSMF web token authentication services........................................................................................... 644Obtain a web token for user authentication......................................................................................645Delete the authentication tokens for this user..................................................................................646

z/OSMF workflow services...................................................................................................................... 647Create a workflow.............................................................................................................................. 650

v

Get the properties of a workflow....................................................................................................... 658List the workflows for a system or sysplex....................................................................................... 681Start a workflow................................................................................................................................. 683Cancel a workflow.............................................................................................................................. 688Delete a workflow.............................................................................................................................. 690Retrieve a workflow definition........................................................................................................... 691Archive a workflow instance.............................................................................................................. 704List the archived workflows for a system.......................................................................................... 706Get the properties of an archived workflow...................................................................................... 708Delete an archived workflow............................................................................................................. 722

Chapter 2. Creating workflow definitions for z/OS.............................................. 725Terms you should know...........................................................................................................................726The Workflows task schema................................................................................................................... 728Creating the workflow definition file....................................................................................................... 728

Structure of a workflow definition file............................................................................................... 729Creating and viewing the workflow definition file............................................................................. 730Sample XML files for your reference..................................................................................................731References to external files............................................................................................................... 732Defining entities for a workflow.........................................................................................................733Specifying the workflow root element...............................................................................................734Specifying the workflow metadata.................................................................................................... 735Including a manifest of translated text............................................................................................. 738Enabling a workflow definition file for future upgrades....................................................................738Collecting user feedback................................................................................................................... 740

Defining steps for your workflow............................................................................................................ 742Parent steps and leaf steps............................................................................................................... 743Template steps.................................................................................................................................. 744REST steps......................................................................................................................................... 757Calling steps....................................................................................................................................... 762Automated steps................................................................................................................................768Making a step conditional.................................................................................................................. 772runAsUser identity for a step............................................................................................................. 774Using translatable strings.................................................................................................................. 777Using rich translatable strings........................................................................................................... 777

Defining variables for your workflow...................................................................................................... 778Using Velocity templates for variable substitution and other functions.......................................... 778Specifying the variable element and its attributes........................................................................... 780Sub-elements of the variable element.............................................................................................. 781Using the element atCreate to qualify a variable definition .............................................................783How to refer to a variable...................................................................................................................784Workflow internal variables .............................................................................................................. 786System variables................................................................................................................................ 788Array variables................................................................................................................................... 790Caller scope variables........................................................................................................................ 791Providing a workflow variable input file............................................................................................ 792

Workflow XML reference......................................................................................................................... 795

Chapter 3. Creating your own z/OSMF plug-ins................................................... 845Developing web-based applications.......................................................................................................846

Using the z/OSMF core JavaScript APIs............................................................................................846Using the Application Linking Manager JavaScript APIs.................................................................. 857Logging client messages in the z/OSMF log...................................................................................... 867Retrieving files and resources for your application...........................................................................872

Authoring end user assistance................................................................................................................873Creating help plug-ins........................................................................................................................874Adding links to help plug-ins............................................................................................................. 884

vi

Adding your applications to z/OSMF.......................................................................................................885Securing your applications...................................................................................................................... 891

Chapter 4. Preparing software to exploit cloud provisioning................................893

Appendix A. Enabling tracing for the z/OS jobs REST interface............................899

Appendix B. Creating product information files for the Software Managementtask...............................................................................................................901

Appendix C. Understanding the Portable Software Instance descriptor file......... 905

Appendix D. Software Management workflow variables......................................913

Appendix E. Accessibility...................................................................................919Accessibility features.............................................................................................................................. 919Consult assistive technologies................................................................................................................919Keyboard navigation of the user interface..............................................................................................919Dotted decimal syntax diagrams.............................................................................................................919

Notices..............................................................................................................923Terms and conditions for product documentation.................................................................................924IBM Online Privacy Statement................................................................................................................ 925Policy for unsupported hardware............................................................................................................925Minimum supported hardware................................................................................................................925Trademarks..............................................................................................................................................926

Index................................................................................................................ 927

vii

Figures

1. Key components in the application linking process.....................................................................................7

2. Registering an event type: request content............................................................................................... 23

3. Example: Registering an event type........................................................................................................... 24

4. Example: Returned results of a successful event registration.................................................................. 25

5. Example: Returned results of an unsuccessful event registration............................................................ 25

6. Sample response from a successful list tasks request..............................................................................29

7. Example: Handlers enabled for the event type..........................................................................................30

8. Example: Returned results of a successful list handlers request............................................................. 30

9. Example: Returned results of a successful list handlers request............................................................. 30

10. Process for routing requests and responses between application servers............................................ 32

11. Sample request to retrieve wrapped data from an application server....................................................36

12. Sample response for retrieving wrapped data from an application server.............................................37

13. Sample request to retrieve unwrapped data from an application server............................................... 37

14. Sample response for retrieving unwrapped data from an application server.........................................38

15. Sample request to retrieve binary data from an application server........................................................38

16. Sample response for retrieving binary data from an application server................................................. 39

17. Sample request to update data on an application server........................................................................41

18. Sample response for updating data on an application server................................................................. 41

19. Sample request to delete data from an application server..................................................................... 43

20. Sample response for deleting data from an application server...............................................................44

21. Cloud Provisioning Summary....................................................................................................................45

22. Sample request to obtain an IP address, with the request body............................................................ 55

23. Sample request to release an IP address, with the request body.......................................................... 58

ix

24. Sample request to obtain a port, with request body............................................................................... 62

25. Sample request to release a port, with the request body....................................................................... 64

26. Sample request to obtain a SNA application name, with request body..................................................67

27. Sample request to release a SNA application name................................................................................69

28. Sample request to add a classification rule............................................................................................. 71

29. Sample request to remove a classification rule....................................................................................... 73

30. Response from a get data set attributes request.................................................................................... 75

31. Sample request to get data set attributes................................................................................................75

32. Sample request to get a domain...............................................................................................................82

33. Sample request to list domains................................................................................................................ 86

34. Sample request to create a tenant........................................................................................................... 91

35. Sample request to get a tenant................................................................................................................ 95

36. Sample request to list tenants............................................................................................................... 102

37. Sample request to delete a tenant.........................................................................................................104

38. Sample request to assign CPU properties to a tenant, with the request body..................................... 106

39. Sample request to assign memory capping properties to a tenant, with the request body................ 108

40. Sample request to assign a solution ID, with the request body............................................................109

41. Sample request to disable CPU capping................................................................................................ 110

42. Sample request to disable memory capping......................................................................................... 112

43. Sample request to disable metering...................................................................................................... 113

44. Sample request to enable CPU capping.................................................................................................115

45. Sample request to enable memory capping.......................................................................................... 116

46. Sample request to enable metering.......................................................................................................117

47. Sample request to add consumers to a tenant, with the request body................................................ 119

48. Sample request to remove tenant consumer, with the request body...................................................120

x

49. Sample request to add tenant description, with the request body.......................................................122

50. Sample request to add tenant groups, with the request body..............................................................123

51. Sample request to remove tenant groups, with the request body........................................................125

52. Sample request to get a resource pool.................................................................................................. 130

53. Sample request to list resource pools................................................................................................... 136

54. Sample request to update security state, with the request body......................................................... 138

55. Sample request to get security profile information............................................................................... 141

56. Sample request to create a standard software services template....................................................... 154

57. Sample response body........................................................................................................................... 155

58. Sample request to create a composite software services template.....................................................155

59. Sample response body for a composite template................................................................................. 155

60. Sample request to create a new version of a software services template........................................... 162


62. Sample request to create a new verison of a composite software services template......................... 163

63. Sample request to create a new software services template based on an existing one, withrequest body............................................................................................................................................ 165


65. Sample request to modify a software services template...................................................................... 171

66. Sample request to modify a composite software services template....................................................172

67. Sample request to delete a software services template.......................................................................173

68. Sample request to retrieve a standard software services template..................................................... 186

69. Sample request to retrieve a composite software services template.................................................. 187

70. Sample request to retrieve software services template documentation..............................................190

71. Sample request to retrieve prompt variables........................................................................................ 192

72. Response body for the GET prompt variables request..........................................................................192

73. Sample request to retrieve prompt variables, composite template..................................................... 192

xi

74. Response body for the GET prompt variables request, composite template.......................................193

75. Sample request to retrieve source information..................................................................................... 195

76. Response body for the get source request............................................................................................ 195

77. Sample request to retrieve source information for a composite template...........................................195

78. Response body for the get source request for a composite template..................................................196

79. Sample request to list software services templates............................................................................. 200

80. Sample request to publish a software services template..................................................................... 204

81. Sample request to test a standard software services template........................................................... 207


83. Sample request to test a composite software services template.........................................................207


85. Sample request to refresh a software services template......................................................................209

86. Sample request to archive a software services template..................................................................... 210

87. Sample request to add an approval record for a software services template......................................212


89. Sample request to get an approval record for a software services template.......................................214


91. Sample request to list the approval records for a software services template.................................... 216


93. Sample request to approve an approval record for a software services template...............................219

94. Sample request to perform batch approval for a software services template..................................... 220

95. Sample request to perform batch rejection of approvals for a software services template................220

96. Sample request to perform batch approval and rejection of approvals for a software servicestemplate................................................................................................................................................... 221

97. Sample request to reject an approval record for a software services template...................................222

98. Sample request to delete an approval record for a software services template..................................223

xii

99. Sample request to indicate security is complete for a software services template.............................224

100. Sample request to run a software services template..........................................................................230

101. Sample response body......................................................................................................................... 230

102. Sample request to test a composite software services template.......................................................230


104. Sample request to get a standard software services template.......................................................... 243

105. Sample request to get consumer documentation for a software services template......................... 245

106. Sample request to get the prompt variables for a published software service template.................. 248

107. Sample request to retrieve prompt variables, composite template................................................... 249

108. Response body for the GET prompt variables request, composite template.....................................250

109. Sample request to list all published software service templates....................................................... 255

110. Response body for the GET request.................................................................................................... 255

111. Sample request to create a software services instance......................................................................268

112. Sample request for a composite.......................................................................................................... 269

113. Sample request to get software services instance properties............................................................278

114. Sample request to list software services instances............................................................................ 284

115. Sample response from a list software services instances request ....................................................285

116. Sample request to get software services instance variables..............................................................288

117. Sample response from a get software services instance variables request ......................................289

118. Sample request to get software services instance variables in key-value format............................. 291

119. Sample response from a get key-value variables request ................................................................. 291

120. Sample request to update a software services instance property..................................................... 297

121. Sample request to update variables for a software services instance............................................... 299

122. Sample request to delete a software services instance......................................................................301

123. Sample request to resume a provisioning workflow for a software services instance...................... 303

xiii

124. Sample request to perform an action against a software services instance variables...................... 306

125. Sample response from a get software services instance variables request ......................................306

126. Sample request to resume ann action workflow for a software services instance............................ 308

127. Sample request to retry a provisioning workflow for a software services instance...........................310

128. Sample request to retry an action workflow for a software services instance...................................312

129. Sample request to get software services instance actions.................................................................316

130. Sample response for performed actions .............................................................................................316

131. Sample request to list performed actions........................................................................................... 320

132. Sample response from a list actions request ..................................................................................... 320

133. Sample request to delete a response for a performed action ............................................................322

134. Sample request to create SSINs.......................................................................................................... 326

135. Sample request to list SSINs................................................................................................................328

136. Sample request to create a variable name.......................................................................................... 330

137. Sample request to create a variable name.......................................................................................... 332

138. Sample JSON structure for persisted data.......................................................................................... 335

139. Sample request to persist user-specific data......................................................................................336

140. Sample response from a request to persist user-specific data.......................................................... 336


142. Sample request to retrieve persisted data.......................................................................................... 338

143. Sample response from a request to retrieve persisted data...............................................................338


145. Sample request to delete persisted data.............................................................................................340

146. Sample response from a request to delete persisted data................................................................. 340

147. Example sysplex and system configuration.........................................................................................341

148. Sample request to retrieve data from one system.............................................................................. 347

xiv

149. Sample response from a request to retrieve data from one system.................................................. 347

150. Sample request to retrieve data from a list of systems.......................................................................347

151. Sample response from a request to retrieve data from a list of systems...........................................348

152. Sample request to retrieve data from all the systems in a group....................................................... 348

153. Sample response from a request to retrieve data from all the systems in a group........................... 349

154. Sample request to retrieve data from all the systems in a sysplex.................................................... 350

155. Sample response from a request to retrieve data from all the systems in a sysplex.........................350

156. Sample request to retrieve data from all the systems in a CPC..........................................................351

157. Sample response from a request to retrieve data from all the systems in a CPC.............................. 351

158. Sample request to update data for one system.................................................................................. 354

159. Sample response from a request to update data for one system.......................................................354

160. Sample request to update data for a list of systems...........................................................................354

161. Sample response from a request to update data for a list of systems............................................... 355

162. Sample request to update data for all the systems in a group........................................................... 355

163. Sample response from a request to update data for all the systems in a group................................356

164. Sample request to update data for all the systems in a sysplex.........................................................356

165. Sample response from a request to update data for all the systems in a sysplex............................. 357

166. Sample request to update data for all the systems in a CPC.............................................................. 357

167. Sample response from a request to update data for all the systems in a CPC...................................358

168. Sample request to delete data from one system................................................................................ 360

169. Sample response from a request to delete data from one system.....................................................360

170. Sample request to delete data from a list of systems.........................................................................361

171. Sample response from a request to delete data from a list of systems............................................. 361

172. Sample request to delete data from all the systems in a group......................................................... 361

173. Sample response from a request to delete data from all the systems in a group..............................362

xv

174. Sample request to delete data from all the systems in a sysplex...................................................... 362

175. Sample response from a request to delete data from all the systems in a sysplex...........................363

176. Sample request to delete data from all the systems in a CPC............................................................ 363

177. Sample response from a request to delete data from all the systems in a CPC.................................364

178. Successful response when authenticating with a system...................................................................365

179. Response when the authentication request fails................................................................................ 365

180. Sample request to authenticate with a system................................................................................... 365

181. Successful response when authenticating with an HTTP proxy server.............................................. 367

182. Sample response when the authentication request fails....................................................................367

183. Sample request to authenticate with an HTTP proxy server...............................................................367

184. List MVS subsystems............................................................................................................................ 369

185. Sample request to retrieve a list of software instances...................................................................... 384

186. Sample response from a request to retrieve a list of software instances.......................................... 384

187. Sample request to retrieve the properties of a software instance..................................................... 390

188. Sample response from a request to retrieve the properties of a software instance..........................390

189. Request content to authenticate with a secondary z/OSMF instance and an HTTP proxy server.....391

190. Sample request to list the data sets included in a software instance................................................ 394

191. Sample response for a list data sets request...................................................................................... 394

192. Sample request to obtain the status of a list data sets request......................................................... 395

193. Sample get status response when the list data sets request is in progress.......................................395

194. Sample get status response when the list data sets request is complete......................................... 395

195. Adding a software instance: request content......................................................................................397

196. Sample request to add a software instance........................................................................................ 401

197. Sample request.....................................................................................................................................405

198. Sample response.................................................................................................................................. 405

xvi

199. Sample response.................................................................................................................................. 405

200. Sample response.................................................................................................................................. 406

201. Modifying a software instance: request content................................................................................. 408

202. Sample request to modify a software instance................................................................................... 413

203. Sample response for a modify software instance request..................................................................413

204. Request content to authenticate with a secondary z/OSMF instance and an HTTP proxy server.....414

205. Sample request to retrieve the product, feature, and FMID information for a software instance.....417

206. Sample response for a retrieve product, feature, and FMID information request............................. 417

207. Sample request to obtain the status of a retrieve product, feature, and FMID information request 418

208. Sample get status response when the retrieve product, feature, and FMID information requestis in progress............................................................................................................................................ 418

209. Sample get status response when the retrieve product, feature, and FMID information requestis complete...............................................................................................................................................418

210. Sample request to delete a software instance.................................................................................... 419

211. Sample response for a delete software instance request...................................................................420

212. Adding a portable software instance: request content....................................................................... 420

213. Sample request to add a portable software instance......................................................................... 422

214. Sample request to retrieve a list of systems....................................................................................... 426

215. Sample response from a request to retrieve a list of systems............................................................426

216. Sample request to retrieve a list of groups..........................................................................................428

217. Sample response from a request to retrieve a list of groups.............................................................. 428

218. Sample request to retrieve a list of systems included in a group....................................................... 430

219. Sample response from a request to retrieve a list of systems included in a group............................431

220. Sample request to retrieve a list of sysplexes..................................................................................... 432

221. Sample response from a request to retrieve a list of sysplexes......................................................... 433

222. Sample request to retrieve a list of systems included in a sysplex.................................................... 435

223. Sample response from a request to retrieve a list of systems included in a sysplex.........................435

xvii

224. Sample request to retrieve a list of systems included in a CPC.......................................................... 437

225. Sample response from a request to retrieve a list of systems included in a CPC.............................. 438

226. Sample request to create a new TSO/E address space on the local system......................................444

227. Sample response from create TSO/E address space request on the local system............................444

228. Sample request to create a new TSO/E address space on a remote system..................................... 445

229. Sample response from create TSO/E address space request on a remote system........................... 445

230. Sample request to reconnect to an existing TSO/E address space on the local system ...................445

231. Sample response from a reconnect to TSO/E address space request on the local system...............445

232. Sample request to reconnect to an existing TSO/E address space on a remote system...................446

233. Sample response from a reconnect to TSO/E address space request on a remote system.............. 446

234. Starting an application: example of the request content.................................................................... 447

235. Sample request to start an application in a TSO/E address space..................................................... 448

236. Sample response from a start an application in a TSO/E address space request..............................448

237. Sample request to send a message to a TSO/E address space.......................................................... 450

238. Sample response from send message to TSO/E address space request........................................... 450

239. Sample request to send a message to an application.........................................................................451

240. Sample response from send message to an application request....................................................... 451

241. Sample request to ping a TSO/E address space..................................................................................452

242. Sample response from ping TSO/E address space request................................................................ 452

243. Sample request to receive a message from a TSO/E address space..................................................453

244. Sample response from receive message from a TSO/E address space request................................ 454

245. Sample request to receive messages from an application................................................................. 455

246. Sample response for request to receive messages from an application............................................455

247. Sample request to logoff a TSO/E address space............................................................................... 456

248. Sample response for logoff a TSO/E address space request.............................................................. 456

xviii

249. Sample request to cancel a TSO/E address space.............................................................................. 456

250. Sample response for a cancel TSO/E address space request.............................................................457

251. Sample request to issue a prime WRP request................................................................................... 460


253. Sample request to issue a delete WLM resource pool request...........................................................461


255. Sample request to construct a service definition based on the current installed definition............. 463


257. Sample request to construct a service definition by removing the classification rule, theninstalling the new service definition........................................................................................................465


259. Sample request to get metered data................................................................................................... 468

260. Sample response.................................................................................................................................. 468

261. Sample request to get DDS server time data.......................................................................................469

262. Sample response.................................................................................................................................. 470

263. Sample request to issue a command synchronously.......................................................................... 487


265. Sample request to issue a command and detect a keyword.............................................................. 488


267. Sample request to issue a system command asynchronously........................................................... 488


269. Sample request to issue an s PEGASUS command synchronously and detect the keywordPEGASUS.................................................................................................................................................. 488


271. Sample request to issue an s PEGASUS command asynchronously and detect the keywordXIAOX....................................................................................................................................................... 489


xix

273. Sample request to get the response for a system command that was issued asynchronously........ 495

274. Sample response body for a get command response request............................................................495

275. Sample request to get the detect result.............................................................................................. 501

276. Sample response body for a get detect result request....................................................................... 501

277. Sample request to get the detect result.............................................................................................. 501

278. Sample response body for a successful get detect result request.....................................................502

279. Example: list all of the data sets.......................................................................................................... 510

280. Example: List all of the cataloged data sets with specified base attributes.......................................510

281. Example: List all of the members of a data set....................................................................................512

282. Example: List all of the members of a data set with specified base attributes.................................. 513

283. Example: Returned contents of the SMFPRM00 member of sys1.parmlib........................................ 517

284. Example: Returned contents of the SMFPRM00 member of sys1.parmlib........................................ 517

285. Example: Retrieve the contents of a sequential data set....................................................................518

286. Example: Request header for a write request to the SMFPRM00 member of sys1.parmlib..............521

287. Example: Request body for a write request to the SMFPRM00 member of sys1.parmlib.................522

288. Example: Contents of a sequential data set........................................................................................ 523

289. Example: Contents of a member of data set with regular expression................................................ 523

290. Example: Create a data set ..................................................................................................................525

291. Example: Create data set..................................................................................................................... 525

292. Example: Create PDSE data set........................................................................................................... 526

293. Example: Delete a data set ..................................................................................................................527

294. Example: Delete uncataloged data set................................................................................................ 527

295. Example: Delete a member of a cataloged partitioned data set.........................................................528

296. Example: Delete a member of an uncataloged partitioned data set.................................................. 529

297. 'rename' request...................................................................................................................................529

xx

298. 'copy' request....................................................................................................................................... 529

299. ''hmigrate' , 'hrecall', or 'hdelete' request........................................................................................... 529

300. Example: Rename MY.OLD.DSN to MY.NEW.DSN............................................................................... 533

301. Example: copy member MYMEM1 from MY.OLD.DSN to MY.NEW.DSN(MYMEM2)........................... 533

302. IDCAMS Access Methods Services...................................................................................................... 534

303. Example: Returned list of UNIX files and directories in path /usr...................................................... 538

304. Example: Returned list of UNIX files ...................................................................................................538

305. Example: List UNIX files with more query parameters. ......................................................................539

306. Example: Response body for a GET request to the UNIX file /etc/inetd.conf.................................... 542

307. Example: Request body for a PUT request to the UNIX file /etc/inetd.conf.......................................544

308. Example: Create a UNIX file................................................................................................................. 547

309. Example: Create a UNIX directory....................................................................................................... 547

310. Example: Delete a UNIX file................................................................................................................. 548

311. Example: Delete a UNIX directory....................................................................................................... 549

312. Example: Rename a UNIX file.............................................................................................................. 554

313. List UNIX Filesystems...........................................................................................................................555

314. Create UNIX Filesystems..................................................................................................................... 557

315. Delete UNIX Filesystems......................................................................................................................558

316. Example: Mount a UNIX file system.....................................................................................................560

317. Example: Unmount a UNIX file system................................................................................................561

318. Format of resource URLs for z/OS jobs REST interface.......................................................................579

319. Example: Returned job status.............................................................................................................. 585

320. Example: Returned status for an active step.......................................................................................585

321. Example: Returned list of the jobs for a specific owner and job name prefix.....................................588

322. Example: Returned list of spool files................................................................................................... 589

xxi

323. Example: Returned spool file content..................................................................................................592

324. Example: Returned spool file content (a range of records).................................................................593

325. Example: Returned job content (the job JCL)...................................................................................... 593

326. Example: Returned results of a job submission.................................................................................. 597

327. Example: Returned results of a job hold request................................................................................ 600

328. Example: Returned results of a job release request........................................................................... 602

329. Example: Returned results of a job class change................................................................................604

330. Example: Returned results of a job cancellation................................................................................. 606

331. Example: Results of a job delete request............................................................................................ 608

332. Sample request to retrieve z/OSMF information................................................................................. 629

333. Sample request to persist user-specific z/OSMF settings data.......................................................... 632

334. Sample request to retrieve persisted z/OSMF settings data...............................................................634

335. Sample response from a request to retrieve persisted z/OSMF settings data................................... 634

336. Sample request to delete persisted z/OSMF settings data.................................................................635

337. Sample request to create system variables........................................................................................ 638

338. Sample request body for a create system variables request..............................................................638

339. Sample request to get system variables..............................................................................................639

340. Sample response from a get system variables request...................................................................... 640

341. Sample request to import system variables........................................................................................ 641

342. Sample request body for an import system variables request........................................................... 641

343. Sample request to export system variables........................................................................................ 642

344. Sample request body for an export system variables request............................................................643

345. Sample request to delete system variables.........................................................................................644

346. Sample request body for a delete system variables request..............................................................644

347. Obtain a JSON Web Token for user authentication............................................................................. 646

xxii

348. Delete the JSON Web Tokens for this user..........................................................................................647

349. Sample request to create a workflow.................................................................................................. 657

350. Sample response from a create workflow request..............................................................................657

351. Sample request to get workflow properties........................................................................................ 677

352. Sample response from a get workflow properties request (Part 1 of 3)............................................ 678



355. Sample request to list workflows.........................................................................................................683

356. Sample response from a list workflows request................................................................................. 683

357. Sample request to start a workflow..................................................................................................... 688

358. Sample response from a start workflow request................................................................................ 688

359. Sample request to cancel a workflow..................................................................................................689

360. Sample response from a cancel workflow request............................................................................. 690

361. Sample request to delete a workflow.................................................................................................. 691

362. Sample response from a delete workflow request..............................................................................691

363. Sample request to get a workflow definition.......................................................................................701

364. Sample response from a get workflow definition request (Part 1 of 3).............................................. 701



367. Sample request to archive a workflow.................................................................................................705

368. Sample response from an archive workflow request.......................................................................... 705

369. Sample request to list archived workflows..........................................................................................707

370. Sample response from a list archived workflows request.................................................................. 708

371. Sample request to get archived workflow properties......................................................................... 721

372. Sample response from a get archived workflow properties request..................................................722

xxiii

373. Sample request to delete an archived workflow................................................................................. 723

374. Sample response from a delete archived workflow request...............................................................723

375. General metadata for a workflow.........................................................................................................736

376. You can define various questions for step owners to answer.............................................................741

377. How feedback questions can be included in the steps in your workflow...........................................742

378. This sample step submits a REXX exec for immediate processing.................................................... 753

379. Sample REST step definition with substitution variables and property mapping variables...............761

380. Example: Defining a called workflow on the step element tag........................................................... 768

381. You can designate a step as automated by adding the autoEnable element to the element tag.............................................................................................................................................. 770

382. Example of a suspend step.................................................................................................................. 771

383. You can designate a step as conditional by adding the condition element to the elementtag.............................................................................................................................................................774

384. You can use variable values in the condition to be satisfied...............................................................774

385. Specifying attributes on the variable element.....................................................................................781

386. Variable definition in this example.......................................................................................................784

387. How the atCreate element is used to specify variable attributes for required and prompt...............784

388. You can use variable values in the condition to be satisfied...............................................................785

389. Example of how a system variable can be used in a workflow step................................................... 789

390. Example of the returned object from the Get system variables service.............................................789

391. Variable substitution for a system variable in the Workflows task customize job statementswindow..................................................................................................................................................... 790

392. Results of variable substitution for a system variable in the Workflows task.................................... 790

393. Example of how an array variable might be used in a workflow step................................................. 791

394. Example of how an array variable might be used in a workflow step................................................. 791

395. Format of a workflow variable input file.............................................................................................. 793

396. Example of a workflow variable input file............................................................................................793

xxiv

397. Using variable substitution in a workflow variable input file...............................................................794

398. How variable substitution in the workflow variable input file works with the Workflows task StepPerform wizard.........................................................................................................................................794

399. Sample JavaScript code for importing and instantiating the global zosmfExternalTools object.......847

400. Syntax to use for the isContentChanged function............................................................................... 848

401. Sample confirmation window for a close task request....................................................................... 849

402. Sample code for the isContentChanged function................................................................................849

403. Syntax to use for the shouldClose function......................................................................................... 850

404. Syntax to use to call the programmaticallyCloseTab function............................................................851

405. Sample code for the programmaticallyCloseTab function....................................

Version 2 Release 4 z/OS - IBMfile/izua700_v2r4.pdf · 2020-05-29 · Summary of changes made in...

Documents

Transcript of Version 2 Release 4 z/OS - IBMfile/izua700_v2r4.pdf · 2020-05-29 · Summary of changes made in...