-
Notifications
You must be signed in to change notification settings - Fork 594
/
zowe.schema.json
350 lines (350 loc) · 19.2 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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$version": "1.0",
"type": "object",
"description": "Zowe configuration",
"properties": {
"profiles": {
"type": "object",
"description": "Mapping of profile names to profile configurations",
"patternProperties": {
"^\\S*$": {
"type": "object",
"description": "Profile configuration object",
"properties": {
"type": {
"description": "Profile type",
"type": "string",
"enum": [
"zosmf",
"tso",
"ssh",
"base"
]
},
"properties": {
"description": "Profile properties object",
"type": "object"
},
"profiles": {
"description": "Optional subprofile configurations",
"type": "object",
"$ref": "#/properties/profiles"
},
"secure": {
"description": "Secure property names",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
"allOf": [
{
"if": {
"properties": {
"type": false
}
},
"then": {
"properties": {
"properties": {
"title": "Missing profile type"
}
}
}
},
{
"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."
},
"password": {
"type": "string",
"description": "Mainframe (z/OSMF) password, which can be the same as your TSO password."
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject self-signed certificates.",
"default": true
},
"certFile": {
"type": "string",
"description": "The file path to a certificate file to use for authentication"
},
"certKeyFile": {
"type": "string",
"description": "The file path to a certificate key file to use for authentication"
},
"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."
},
"protocol": {
"type": "string",
"description": "The protocol used (HTTP or HTTPS)",
"default": "https",
"enum": [
"http",
"https"
]
},
"encoding": {
"type": "string",
"description": "The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-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": []
},
"secure": {
"items": {
"enum": [
"user",
"password"
]
}
}
}
}
},
{
"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."
},
"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."
},
"handshakeTimeout": {
"type": "number",
"description": "How long in milliseconds to wait for the SSH handshake to complete."
}
},
"required": []
},
"secure": {
"items": {
"enum": [
"user",
"password",
"keyPassphrase"
]
}
}
}
}
},
{
"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."
},
"password": {
"type": "string",
"description": "Password to authenticate to service on the mainframe."
},
"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."
},
"certFile": {
"type": "string",
"description": "The file path to a certificate file to use for authentication"
},
"certKeyFile": {
"type": "string",
"description": "The file path to a certificate key file to use for authentication"
}
},
"required": []
},
"secure": {
"items": {
"enum": [
"user",
"password",
"tokenValue"
]
}
}
}
}
}
]
}
}
},
"defaults": {
"type": "object",
"description": "Mapping of profile types to default profile names",
"properties": {
"zosmf": {
"description": "Default zosmf profile",
"type": "string"
},
"tso": {
"description": "Default tso profile",
"type": "string"
},
"ssh": {
"description": "Default ssh profile",
"type": "string"
},
"base": {
"description": "Default base profile",
"type": "string"
}
}
},
"autoStore": {
"type": "boolean",
"description": "If true, values you enter when prompted are stored for future use"
}
}
}