-
Notifications
You must be signed in to change notification settings - Fork 8
/
command.spec
413 lines (413 loc) · 14.3 KB
/
command.spec
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
{
"attributes": [
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Managed Object Type of the entity on which this Command is associated.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": null,
"max_value": null,
"min_length": null,
"min_value": null,
"name": "assocEntityType",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Associated Entity Type"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Parameters to be supplied for execution of this command. This should be the ID of the object supplying parameters.",
"exposed": true,
"filterable": true,
"format": "free",
"max_length": 1023,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "associatedParam",
"orderable": false,
"read_only": false,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Associated Parameter"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Type of the object which supplies parameters for this command. For NSG_APPLY_PATCH command this should be NSG_PATCH_PROFILE. For NSG_DELETE_PATCH it should be PATCH",
"exposed": true,
"filterable": true,
"format": null,
"max_length": 255,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "associatedParamType",
"orderable": false,
"read_only": false,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Associated Parameter Type"
},
{
"allowed_chars": null,
"allowed_choices": [
"NSG_APPLY_PATCH",
"NSG_DELETE_PATCH",
"NSG_DOWNLOAD_OS_IMAGE",
"NSG_REBOOT",
"NSG_RENEW_CERT",
"NSG_UPDATE_INFO",
"NSG_UPGRADE_TO_IMAGE",
"NSG_OVERLAY_SYSLOG_CONTAINER_START",
"NSG_OVERLAY_SYSLOG_CONTAINER_RESTART",
"NSG_OVERLAY_SYSLOG_CONTAINER_STOP",
"NSG_CONTAINER_TEST_SUITE_RUN",
"NSG_CONTAINER_UNDERLAY_TEST",
"UNKNOWN"
],
"autogenerated": false,
"channel": null,
"creation_only": true,
"default_order": false,
"default_value": "UNKNOWN",
"deprecated": false,
"description": "Specifies the type of command that is stated for execution on the system receiving the operation request. A request for download, a request for upgrade, a request for revocation, ...",
"exposed": true,
"filterable": true,
"format": null,
"max_length": null,
"max_value": null,
"min_length": null,
"min_value": null,
"name": "command",
"orderable": true,
"read_only": false,
"required": true,
"subtype": null,
"transient": false,
"type": "enum",
"unique": false,
"uniqueScope": null,
"userlabel": "Command Requested"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": true,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Informative details on what command is to be executed. It complements the commandType attribute. An example of a value could be a URL, a version number, a UUID of another object, ...",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 1023,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "commandInformation",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Command Information"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Details about the command execution as reported directly from the NSG independent of status codes.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 1023,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "detail",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Detail"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": true,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "A string representing the detailed status of the operation that was triggered by the execution of the Command instance.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 255,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "detailedStatus",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": true,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Detailed Status"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": true,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": "0",
"deprecated": false,
"description": "A numerical code mapping to a list of detailed statuses that can apply to a Command instance.",
"exposed": true,
"filterable": true,
"format": null,
"max_length": null,
"max_value": 65535,
"min_length": null,
"min_value": 0,
"name": "detailedStatusCode",
"orderable": true,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "integer",
"unique": false,
"uniqueScope": null,
"userlabel": "Detailed Status Code"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "Full command including parameters that is to be executed.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 1023,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "fullCommand",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Full Command"
},
{
"allowed_chars": null,
"allowed_choices": [
"ABANDON",
"UNSPECIFIED"
],
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": "UNSPECIFIED",
"deprecated": false,
"description": "Operator specified action which overrides the normal life cycle of a command.",
"exposed": true,
"filterable": true,
"format": null,
"max_length": null,
"max_value": null,
"min_length": null,
"min_value": null,
"name": "override",
"orderable": true,
"read_only": false,
"required": false,
"subtype": null,
"transient": false,
"type": "enum",
"unique": false,
"uniqueScope": null,
"userlabel": "Override"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "JSON string detailing the progress of the command execution on Gateway.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 1023,
"max_value": null,
"min_length": 0,
"min_value": null,
"name": "progress",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Progress"
},
{
"allowed_chars": null,
"allowed_choices": [
"ABANDONED",
"COMPLETED",
"FAILED",
"RUNNING",
"SKIPPED",
"STARTED",
"UNKNOWN"
],
"autogenerated": true,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": "UNKNOWN",
"deprecated": false,
"description": "The status of the Command from a VSD perspective.",
"exposed": true,
"filterable": true,
"format": null,
"max_length": null,
"max_value": null,
"min_length": null,
"min_value": null,
"name": "status",
"orderable": true,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "enum",
"unique": false,
"uniqueScope": null,
"userlabel": "Status"
},
{
"allowed_chars": null,
"allowed_choices": null,
"autogenerated": false,
"channel": null,
"creation_only": false,
"default_order": false,
"default_value": null,
"deprecated": false,
"description": "A generated summary for the action giving some general context on the command executed.",
"exposed": true,
"filterable": false,
"format": "free",
"max_length": 255,
"max_value": null,
"min_length": 1,
"min_value": null,
"name": "summary",
"orderable": false,
"read_only": true,
"required": false,
"subtype": null,
"transient": false,
"type": "string",
"unique": false,
"uniqueScope": null,
"userlabel": "Summary"
}
],
"children": [],
"model": {
"allowed_job_commands": null,
"create": null,
"delete": true,
"description": "A Command represents an operation that needs to be executed on an entity (NSG, Gateway, ...) which requires little processing by VSD, but may result in a long activity on the external entity. An example would be to trigger an action on VSD so that a Gateway download a new image. VSDs handling of the request is limited to generating a message to be sent to the device on which the download process is expected. The device then acts on the request and proceeds with the download... That may be a long process. The commands API is similar to the Jobs API with regards to triggering operations on objects.",
"entity_name": "Command",
"extends": [
"@audited",
"@base"
],
"get": true,
"package": "operation",
"resource_name": "commands",
"rest_name": "command",
"root": null,
"template": false,
"update": true,
"userlabel": "Command"
}
}