forked from dkelosky/master-the-mainframe-zowe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathzowe.schema.json
793 lines (793 loc) · 48.5 KB
/
zowe.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
{
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"$version": 1,
"type": "object",
"description": "config",
"properties": {
"profiles": {
"type": "object",
"description": "named profiles config",
"patternProperties": {
"^\\S*$": {
"type": "object",
"description": "a profile",
"properties": {
"type": {
"description": "the profile type",
"type": "string"
},
"properties": {
"description": "the profile properties",
"type": "object"
},
"profiles": {
"description": "additional sub-profiles",
"type": "object",
"$ref": "#/properties/profiles"
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "zosmf"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "z/OSMF Profile",
"description": "z/OSMF Profile",
"properties": {
"host": {
"type": "string",
"description": "The z/OSMF server host name."
},
"port": {
"type": "number",
"description": "The z/OSMF server port.",
"default": 443
},
"user": {
"type": "string",
"description": "Mainframe (z/OSMF) user name, which can be the same as your TSO login.",
"secure": true
},
"password": {
"type": "string",
"description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"basePath": {
"type": "string",
"description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer."
},
"encoding": {
"type": "number",
"description": "The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is 1047."
},
"responseTimeout": {
"type": "number",
"description": "The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600"
}
},
"required": []
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "tso"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "TSO Profile",
"description": "z/OS TSO/E User Profile",
"properties": {
"account": {
"type": "string",
"description": "Your z/OS TSO/E accounting information."
},
"characterSet": {
"type": "string",
"description": "Character set for address space to convert messages and responses from UTF-8 to EBCDIC.",
"default": "697"
},
"codePage": {
"type": "string",
"description": "Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.",
"default": "1047"
},
"columns": {
"type": "number",
"description": "The number of columns on a screen.",
"default": 80
},
"logonProcedure": {
"type": "string",
"description": "The logon procedure to use when creating TSO procedures on your behalf.",
"default": "IZUFPROC"
},
"regionSize": {
"type": "number",
"description": "Region size for the TSO/E address space.",
"default": 4096
},
"rows": {
"type": "number",
"description": "The number of rows on a screen.",
"default": 24
}
},
"required": []
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "ssh"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "z/OS SSH Profile",
"description": "z/OS SSH Profile",
"properties": {
"host": {
"type": "string",
"description": "The z/OS SSH server host name."
},
"port": {
"type": "number",
"description": "The z/OS SSH server port.",
"default": 22
},
"user": {
"type": "string",
"description": "Mainframe user name, which can be the same as your TSO login."
},
"password": {
"type": "string",
"description": "Mainframe password, which can be the same as your TSO password.",
"secure": true
},
"privateKey": {
"type": "string",
"description": "Path to a file containing your private key, that must match a public key stored in the server for authentication"
},
"keyPassphrase": {
"type": "string",
"description": "Private key passphrase, which unlocks the private key.",
"secure": true
},
"handshakeTimeout": {
"type": "number",
"description": "How long in milliseconds to wait for the SSH handshake to complete."
}
},
"required": []
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "idms"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "CA IDMS Profile",
"description": "Persistent information pertaining to CA IDMS",
"properties": {
"host": {
"type": "string",
"description": "The API ML server host name."
},
"port": {
"type": "number",
"description": "The API ML server port.",
"default": 443
},
"user": {
"type": "string",
"description": "Mainframe (z/OSMF) user name, which can be the same as your TSO login.",
"secure": true
},
"password": {
"type": "string",
"description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"tokenType": {
"type": "string",
"description": "The token type for z/OSMF returned in the HTTP Cookie header, for example: 'LtpaToken2'. The existence of a 'tokenType' indicates that basic authentication will not be used after a token has been obtained."
},
"tokenValue": {
"type": "string",
"description": "The token value associated with the token type.",
"secure": true
}
},
"required": [
"host"
]
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "endevor"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "The CA Endevor SCM endevor profile",
"description": "The CA Endevor SCM endevor profile schema, where you specify your endevor session information and credentials",
"properties": {
"host": {
"type": "string",
"description": "The hostname of the endevor session"
},
"port": {
"type": "number",
"description": "The port number of the endevor session"
},
"user": {
"type": "string",
"description": "The username of the endevor session",
"secure": true
},
"password": {
"type": "string",
"description": "The password of the user",
"secure": true
},
"protocol": {
"type": "string",
"description": "The protocol used for connecting to CA Endevor SCM Rest API",
"default": "http",
"enum": [
"http",
"https"
]
},
"basePath": {
"type": "string",
"description": "The base path used for connecting to CA Endevor SCM Rest API",
"default": "EndevorService/rest"
},
"rejectUnauthorized": {
"type": "boolean",
"description": "If set, the server certificate is verified against the list of supplied CAs"
}
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "endevor-location"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "The CA Endevor SCM element inventory location specification profile",
"description": "The CA Endevor SCM element location, where you specify your working environment, system and subsystem",
"properties": {
"instance": {
"type": "string",
"description": "The STC/datasource of the session"
},
"environment": {
"type": "string",
"description": "The CA Endevor SCM environment where your project resides",
"default": "DEV"
},
"system": {
"type": "string",
"description": "The CA Endevor SCM system where the element resides"
},
"subsystem": {
"type": "string",
"description": "The CA Endevor SCM subsystem where your element resides"
},
"type": {
"type": "string",
"description": "Name of the CA Endevor SCM element's type"
},
"stageNumber": {
"type": "string",
"description": "The CA Endevor SCM stage where your project resides",
"enum": [
"1",
"2"
]
},
"comment": {
"type": "string",
"description": "The CA Endevor SCM comment you want to use when performing an action"
},
"ccid": {
"type": "string",
"description": "The CA Endevor SCM CCID you want to use when performing an action"
},
"maxrc": {
"type": "number",
"description": "The return code of CA Endevor SCM that defines a failed action",
"default": 12
}
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "rse"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "IBM RSE API Zowe Profile",
"description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.",
"properties": {
"host": {
"type": "string",
"description": "The z/OS host name running the Zowe REST API."
},
"port": {
"type": "number",
"description": "The server port used by the REST REST API."
},
"user": {
"type": "string",
"description": "The user name for the Zowe REST API operations.",
"secure": true
},
"password": {
"type": "string",
"description": "The password of the user for the Zowe REST API operations.",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"basePath": {
"type": "string",
"description": "The base path of the API for the REST API operations.",
"secure": true
},
"protocol": {
"type": "string",
"description": "http or https, the default, depending whether a TLS handshake is required to access REST API.",
"default": "https",
"secure": true
}
},
"required": [
"host"
]
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "mq"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "CLI profile for MQ",
"description": "An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface",
"properties": {
"host": {
"type": "string",
"description": "The MQ Rest server host name"
},
"port": {
"type": "number",
"description": "Port number of your MQ REST API server"
},
"user": {
"type": "string",
"description": "User name to authenticate to your MQ REST API server",
"secure": true
},
"password": {
"type": "string",
"description": "Password to authenticate to your MQ REST API server",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": false
},
"protocol": {
"type": "string",
"description": "Specifies the MQ protocol (http or https).",
"default": "http",
"enum": [
"http",
"https"
]
}
},
"required": [
"host",
"port",
"user",
"password"
]
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "jclcheck"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "JCLCheck Profile",
"description": "A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.",
"properties": {
"host": {
"type": "string",
"description": "Host name of the JCLCheck API service that is running on the mainframe system."
},
"port": {
"type": "number",
"description": "Port for the JCLCheck API service that is running on the mainframe system."
},
"user": {
"type": "string",
"description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.",
"secure": true
},
"password": {
"type": "string",
"description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.",
"secure": true
},
"basePath": {
"type": "string",
"description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer."
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"protocol": {
"type": "string",
"description": "Specifies protocol to use for JCLCheck connection (http or https).",
"default": "https",
"enum": [
"http",
"https"
]
},
"jclcheckOptions": {
"type": "string",
"description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response."
}
},
"required": []
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "qwikref"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "Qwikref Profile",
"description": "A Qwikref profile is required to issue commands in the jcl command group that interact with Qwikref. The Qwikref profile contains your host and port for the Qwikref instance of your choice.",
"properties": {
"host": {
"type": "string",
"description": "Host name of the Qwikref API service that is running on the mainframe system."
},
"port": {
"type": "number",
"description": "Port for the Qwikref API service that is running on the mainframe system."
},
"user": {
"type": "string",
"description": "User name for authenticating connections to the Qwikref API service that is running on the mainframe system.",
"secure": true
},
"password": {
"type": "string",
"description": "Password for authenticating connections to the Qwikref API service that is running on the mainframe system.",
"secure": true
},
"basePath": {
"type": "string",
"description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer."
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"protocol": {
"type": "string",
"description": "Specifies protocol to use for Qwikref connection (http or https).",
"default": "https",
"enum": [
"http",
"https"
]
}
},
"required": []
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "ebg"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "CA Endevor Bridge for Bridge Profile",
"description": "An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.",
"properties": {
"protocol": {
"type": "string",
"description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: http",
"enum": [
"http",
"https"
]
},
"host": {
"type": "string",
"description": "The Endevor Bridge for Git hostname."
},
"port": {
"type": "number",
"description": "The Endevor Bridge for Git port."
},
"user": {
"type": "string",
"description": "Endevor Bridge for Git username (your git username).",
"secure": true
},
"token": {
"type": "string",
"description": "Git personal access token (it can be obtained from your Git Enterprise Server).",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates. \n\nDefault value: false"
}
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "zftp"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "Configuration profile for z/OS FTP",
"description": "Configuration profile for z/OS FTP",
"properties": {
"host": {
"type": "string",
"description": "The hostname or IP address of the z/OS server to connect to."
},
"port": {
"type": "number",
"description": "The port of the z/OS FTP server.",
"default": 21
},
"user": {
"type": "string",
"description": "Username for authentication on z/OS",
"secure": true
},
"password": {
"type": "string",
"description": "Password to authenticate to FTP.",
"secure": true
},
"secureFtp": {
"type": [
"boolean",
"null"
],
"description": "Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.",
"default": true
},
"rejectUnauthorized": {
"type": [
"boolean",
"null"
],
"description": "Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance."
},
"servername": {
"type": [
"string",
"null"
],
"description": "Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely"
},
"connectionTimeout": {
"type": "number",
"description": "How long (in milliseconds) to wait for the control connection to be established.",
"default": 10000
}
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "base"
}
}
},
"then": {
"properties": {
"properties": {
"type": "object",
"title": "Base Profile",
"description": "Base profile that stores values shared by multiple service profiles",
"properties": {
"host": {
"type": "string",
"description": "Host name of service on the mainframe."
},
"port": {
"type": "number",
"description": "Port number of service on the mainframe."
},
"user": {
"type": "string",
"description": "User name to authenticate to service on the mainframe.",
"secure": true
},
"password": {
"type": "string",
"description": "Password to authenticate to service on the mainframe.",
"secure": true
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"tokenType": {
"type": "string",
"description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'."
},
"tokenValue": {
"type": "string",
"description": "The value of the token to pass to the API.",
"secure": true
}
},
"required": []
}
}
}
}
]
}
}
},
"defaults": {
"type": "object",
"description": "default profiles config",
"patternProperties": {
"^\\S*$": {
"type": "string",
"description": "the type"
}
}
},
"secure": {
"type": "array",
"description": "secure properties",
"items": {
"type": "string",
"description": "path to a property"
}
}
}
}