@itentialopensource/adapter-drivenets_networkorchestrator 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/CALLS.md +11 -11
  2. package/CHANGELOG.md +16 -1
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +31 -22
  6. package/adapter.js +159 -330
  7. package/adapterBase.js +538 -873
  8. package/changelogs/changelog.md +9 -0
  9. package/metadata.json +47 -0
  10. package/package.json +22 -25
  11. package/pronghorn.json +474 -142
  12. package/propertiesSchema.json +453 -40
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +1634 -0
  15. package/report/adapter-openapi.yaml +1181 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1691507572126.json +120 -0
  18. package/report/updateReport1692202569619.json +120 -0
  19. package/report/updateReport1694461740307.json +120 -0
  20. package/report/updateReport1698420931408.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +1 -1
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +306 -109
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +1 -0
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +71 -23
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/taskMover.js +309 -0
  37. package/utils/tbScript.js +3 -10
  38. package/utils/tbUtils.js +2 -3
  39. package/utils/testRunner.js +1 -1
  40. package/utils/troubleshootingAdapter.js +1 -3
  41. package/workflows/README.md +0 -3
package/report/adapter-openapi.json ADDED
@@ -0,0 +1,1634 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "DNOR - Drivenet Orchestration",
5
+ "description": "This is a sample description. You can find out more about the OpenAPI Specification at http://spec.openapis.org/oas/v3.0.3.",
6
+ "contact": {
7
+ "email": "ankit.bhansali@itential.com"
8
+ },
9
+ "version": "1.0.0"
10
+ },
11
+ "servers": [
12
+ {
13
+ "url": "https://localhost",
14
+ "variables": {}
15
+ }
16
+ ],
17
+ "paths": {
18
+ "/nce-management/deploy": {
19
+ "post": {
20
+ "tags": ["NCEManagement"],
21
+ "summary": "deploy",
22
+ "description": "Deploy DNOS to create an NCE.",
23
+ "operationId": "deploy",
24
+ "parameters": [],
25
+ "requestBody": {
26
+ "description": "",
27
+ "content": {
28
+ "application/json": {
29
+ "schema": {
30
+ "example": {
31
+ "name": "NY22C",
32
+ "candidateDNOSYaml": "v13.0",
33
+ "oobIpv4Address": "Acquired",
34
+ "oobIpv4Subnet": 24,
35
+ "oobIpv6Address": "Acquired",
36
+ "oobIpv6Subnet": 127,
37
+ "oobIpv4DefaultGateway": "198.51.100.42",
38
+ "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
39
+ "inBandIpv4Address": "198.51.100.42",
40
+ "inBandIpv4Subnet": 24,
41
+ "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
42
+ "inBandIpv6Subnet": 127,
43
+ "minimumNccs": 2,
44
+ "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
45
+ "configurationData": {
46
+ "filename": "baseConfig.xml",
47
+ "username": "dnroot",
48
+ "configurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
49
+ },
50
+ "formation": {
51
+ "type": "Cluster",
52
+ "specific": "CL-96"
53
+ },
54
+ "nccs": [
55
+ {
56
+ "serialNumber": "string",
57
+ "nccId": 1
58
+ }
59
+ ]
60
+ }
61
+ },
62
+ "example": {
63
+ "name": "NY22C",
64
+ "candidateDNOSYaml": "v13.0",
65
+ "oobIpv4Address": "Acquired",
66
+ "oobIpv4Subnet": 24,
67
+ "oobIpv6Address": "Acquired",
68
+ "oobIpv6Subnet": 127,
69
+ "oobIpv4DefaultGateway": "198.51.100.42",
70
+ "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
71
+ "inBandIpv4Address": "198.51.100.42",
72
+ "inBandIpv4Subnet": 24,
73
+ "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
74
+ "inBandIpv6Subnet": 127,
75
+ "minimumNccs": 2,
76
+ "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
77
+ "configurationData": {
78
+ "filename": "baseConfig.xml",
79
+ "username": "dnroot",
80
+ "configurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
81
+ },
82
+ "formation": {
83
+ "type": "Cluster",
84
+ "specific": "CL-96"
85
+ },
86
+ "nccs": [
87
+ {
88
+ "serialNumber": "string",
89
+ "nccId": 1
90
+ }
91
+ ]
92
+ }
93
+ }
94
+ },
95
+ "required": true
96
+ },
97
+ "responses": {
98
+ "200": {
99
+ "description": "successful operation",
100
+ "headers": {},
101
+ "content": {
102
+ "application/json": {
103
+ "schema": {}
104
+ }
105
+ }
106
+ },
107
+ "403": {
108
+ "description": "operation failed",
109
+ "headers": {},
110
+ "content": {
111
+ "application/json": {
112
+ "schema": {}
113
+ }
114
+ }
115
+ }},
116
+ "deprecated": false
117
+ }
118
+ },
119
+ "/nce-management/{cluster-id}": {
120
+ "put": {
121
+ "tags": ["NCEManagement"],
122
+ "summary": "updateNCEbyClusterID",
123
+ "description": "Edit an existing NCE. If NCE is in 'Waiting for equipment' status all required body fields should be provided as in Create NCE",
124
+ "operationId": "updateNCEbyClusterID",
125
+ "parameters": [
126
+ {
127
+ "name": "cluster-id",
128
+ "in": "path",
129
+ "description": "System-ID of the NCE",
130
+ "required": true,
131
+ "style": "simple",
132
+ "schema": {
133
+ "type": "string",
134
+ "example": {}
135
+ }
136
+ }
137
+ ],
138
+ "requestBody": {
139
+ "description": "",
140
+ "content": {
141
+ "application/json": {
142
+ "schema": {
143
+ "example": {
144
+ "name": "NY22C",
145
+ "inBandIpv4Address": "198.51.100.42",
146
+ "inBandIpv4Subnet": 24,
147
+ "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
148
+ "inBandIpv6Subnet": 127,
149
+ "oobIpv4DefaultGateway": "198.51.100.42",
150
+ "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
151
+ "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
152
+ "formation": {
153
+ "type": "Cluster",
154
+ "specific": "CL-96"
155
+ },
156
+ "targetGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
157
+ "nccs": [
158
+ {
159
+ "serialNumber": "string",
160
+ "nccId": 1
161
+ }
162
+ ]
163
+ }
164
+ },
165
+ "example": {
166
+ "name": "NY22C",
167
+ "inBandIpv4Address": "198.51.100.42",
168
+ "inBandIpv4Subnet": 24,
169
+ "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
170
+ "inBandIpv6Subnet": 127,
171
+ "oobIpv4DefaultGateway": "198.51.100.42",
172
+ "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
173
+ "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
174
+ "formation": {
175
+ "type": "Cluster",
176
+ "specific": "CL-96"
177
+ },
178
+ "targetGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
179
+ "nccs": [
180
+ {
181
+ "serialNumber": "string",
182
+ "nccId": 1
183
+ }
184
+ ]
185
+ }
186
+ }
187
+ },
188
+ "required": true
189
+ },
190
+ "responses": {
191
+ "200": {
192
+ "description": "successful operation",
193
+ "headers": {},
194
+ "content": {
195
+ "application/json": {
196
+ "schema": {}
197
+ }
198
+ }
199
+ },
200
+ "403": {
201
+ "description": "operation failed",
202
+ "headers": {},
203
+ "content": {
204
+ "application/json": {
205
+ "schema": {}
206
+ }
207
+ }
208
+ }},
209
+ "deprecated": false
210
+ },
211
+ "delete": {
212
+ "tags": ["NCEManagement"],
213
+ "summary": "deleteNCEbyClusterID",
214
+ "description": "Remove an NCE from DNOR and delete the DNOS installation on the NCE nodes.",
215
+ "operationId": "deleteNCEbyClusterID",
216
+ "parameters": [
217
+ {
218
+ "name": "cluster-id",
219
+ "in": "path",
220
+ "description": "",
221
+ "required": true,
222
+ "style": "simple",
223
+ "schema": {
224
+ "type": "string",
225
+ "example": {}
226
+ }
227
+ }
228
+ ],
229
+ "responses": {
230
+ "200": {
231
+ "description": "successful operation",
232
+ "headers": {},
233
+ "content": {
234
+ "application/json": {
235
+ "schema": {}
236
+ }
237
+ }
238
+ },
239
+ "403": {
240
+ "description": "operation failed",
241
+ "headers": {},
242
+ "content": {
243
+ "application/json": {
244
+ "schema": {}
245
+ }
246
+ }
247
+ }},
248
+ "deprecated": false
249
+ }
250
+ },
251
+ "/nce-management/download/{cluster-id}": {
252
+ "post": {
253
+ "tags": ["NCEManagement"],
254
+ "summary": "download",
255
+ "description": "Download a newer version of DNOS to the NCE (prior to upgrade).",
256
+ "operationId": "nceManagementDownload",
257
+ "parameters": [
258
+ {
259
+ "name": "cluster-id",
260
+ "in": "path",
261
+ "description": "System-ID of the NCE",
262
+ "required": true,
263
+ "style": "simple",
264
+ "schema": {
265
+ "type": "string",
266
+ "example": {}
267
+ }
268
+ }
269
+ ],
270
+ "requestBody": {
271
+ "description": "Download values",
272
+ "content": {
273
+ "application/json": {
274
+ "schema": {
275
+ "example": { "version": "string", "inBand": false }
276
+ },
277
+ "example": { "version": "string", "inBand": false }
278
+ }
279
+ },
280
+ "required": true
281
+ },
282
+ "responses": {
283
+ "200": {
284
+ "description": "successful operation",
285
+ "headers": {},
286
+ "content": {
287
+ "application/json": {
288
+ "schema": {}
289
+ }
290
+ }
291
+ },
292
+ "403": {
293
+ "description": "failed operation",
294
+ "headers": {},
295
+ "content": {}
296
+ }}
297
+ }
298
+ },
299
+ "/nce-management/upgrade/{cluster-id}": {
300
+ "post": {
301
+ "tags": ["NCEManagement"],
302
+ "summary": "Upgrade",
303
+ "description": "Upgrade the version of DNOS running on an NCE.",
304
+ "operationId": "nceManagementUpgrade",
305
+ "parameters": [
306
+ {
307
+ "name": "cluster-id",
308
+ "in": "path",
309
+ "description": "System-ID of the NCE",
310
+ "required": true,
311
+ "style": "simple",
312
+ "schema": {
313
+ "type": "string",
314
+ "example": {}
315
+ }
316
+ }
317
+ ],
318
+ "requestBody": {
319
+ "description": "Upgrade deatil",
320
+ "content": {
321
+ "application/json": {
322
+ "schema": {
323
+ "example": {}
324
+ },
325
+ "example": {}
326
+ }
327
+ },
328
+ "required": true
329
+ },
330
+ "responses": {
331
+ "200": {
332
+ "description": "successful operation",
333
+ "headers": {},
334
+ "content": {
335
+ "application/json": {
336
+ "schema": {}
337
+ }
338
+ }
339
+ },
340
+ "403": {
341
+ "description": "failed operation",
342
+ "headers": {},
343
+ "content": {}
344
+ }
345
+ },
346
+ "deprecated": false
347
+ }
348
+ },
349
+ "/nce-management/cancel/{cluster-id}": {
350
+ "post": {
351
+ "tags": [
352
+ "NCEManagement"
353
+ ],
354
+ "summary": "Cancel",
355
+ "description": "Cancel the current process running on an NCE",
356
+ "operationId": "nceManagementCancel",
357
+ "parameters": [
358
+ {
359
+ "name": "cluster-id",
360
+ "in": "path",
361
+ "description": "System-ID of the NCE",
362
+ "required": true,
363
+ "style": "simple",
364
+ "schema": {
365
+ "type": "string",
366
+ "example": {}
367
+ }
368
+ }
369
+ ],
370
+ "responses": {
371
+ "200": {
372
+ "description": "successful operation",
373
+ "headers": {},
374
+ "content": {
375
+ "application/json": {
376
+ "schema": {}
377
+ }
378
+ }
379
+ },
380
+ "403": {
381
+ "description": "Cannot cancel process at the current stage",
382
+ "headers": {},
383
+ "content": {
384
+ "application/json": {
385
+ "schema": {}
386
+ }
387
+ }
388
+ },
389
+ "404": {
390
+ "description": "Process not found",
391
+ "headers": {},
392
+ "content": {
393
+ "application/json": {
394
+ "schema": {}
395
+ }
396
+ }
397
+ },
398
+ "500": {
399
+ "description": "Cannot cancel - unknown error",
400
+ "headers": {},
401
+ "content": {
402
+ "application/json": {
403
+ "schema": {}
404
+ }
405
+ }
406
+ }
407
+ },
408
+ "deprecated": false
409
+ }
410
+ },
411
+ "/nce-management/precheck/{cluster-id}": {
412
+ "post": {
413
+ "tags": [
414
+ "NCEManagement"
415
+ ],
416
+ "summary": "Preupgrade validation",
417
+ "description": "Preupgrade validation",
418
+ "operationId": "nceManagementPrecheck",
419
+ "parameters": [
420
+ {
421
+ "name": "cluster-id",
422
+ "in": "path",
423
+ "description": "System-ID of the NCE",
424
+ "required": true,
425
+ "style": "simple",
426
+ "schema": {
427
+ "type": "string",
428
+ "example": {}
429
+ }
430
+ }
431
+ ],
432
+ "responses": {
433
+ "200": {
434
+ "description": "successful operation",
435
+ "headers": {},
436
+ "content": {
437
+ "application/json": {
438
+ "schema": {}
439
+ }
440
+ }
441
+ },
442
+ "403": {
443
+ "description": "Precheck failed",
444
+ "headers": {},
445
+ "content": {
446
+ "application/json": {
447
+ "schema": {}
448
+ }
449
+ }
450
+ }
451
+ },
452
+ "deprecated": false
453
+ }
454
+ },
455
+ "/redundancy/disable": {
456
+ "put": {
457
+ "tags": [
458
+ "Redundancy"
459
+ ],
460
+ "summary": "Disable all DNOR services on a node",
461
+ "description": "Disable DNOR node values",
462
+ "operationId": "redundancyDisable",
463
+ "parameters": [],
464
+ "requestBody": {
465
+ "description": "",
466
+ "content" : {
467
+ "application/json": {
468
+ "schema": {
469
+ "example": {
470
+ "dnorRole": "PRIMARY",
471
+ "addr": "198.51.100.42"
472
+ }
473
+ },
474
+ "example": {
475
+ "dnorRole": "PRIMARY",
476
+ "addr": "198.51.100.42"
477
+ }
478
+ }
479
+ }
480
+ },
481
+ "responses": {
482
+ "200": {
483
+ "description": "successful operation",
484
+ "headers": {},
485
+ "content": {
486
+ "application/json": {
487
+ "schema": {}
488
+ }
489
+ }
490
+ },
491
+ "403": {
492
+ "description": "operation failed",
493
+ "headers": {},
494
+ "content": {
495
+ "application/json": {
496
+ "schema": {}
497
+ }
498
+ }
499
+ }
500
+ },
501
+ "deprecated": false
502
+ }
503
+ },
504
+ "/redundancy/enable": {
505
+ "put": {
506
+ "tags": [
507
+ "Redundancy"
508
+ ],
509
+ "summary": "Enable all DNOR services on a node",
510
+ "description": "Enable DNOR node values",
511
+ "operationId": "redundancyEnable",
512
+ "parameters": [],
513
+ "requestBody": {
514
+ "description": "",
515
+ "content" : {
516
+ "application/json": {
517
+ "schema": {
518
+ "example": {
519
+ "dnorRole": "PRIMARY",
520
+ "addr": "198.51.100.42"
521
+ }
522
+ },
523
+ "example": {
524
+ "dnorRole": "PRIMARY",
525
+ "addr": "198.51.100.42"
526
+ }
527
+ }
528
+ }
529
+ },
530
+ "responses": {
531
+ "200": {
532
+ "description": "successful operation",
533
+ "headers": {},
534
+ "content": {
535
+ "application/json": {
536
+ "schema": {}
537
+ }
538
+ }
539
+ },
540
+ "403": {
541
+ "description": "operation failed",
542
+ "headers": {},
543
+ "content": {
544
+ "application/json": {
545
+ "schema": {}
546
+ }
547
+ }
548
+ }
549
+ },
550
+ "deprecated": false
551
+ }
552
+ },
553
+ "/redundancy": {
554
+ "put": {
555
+ "tags": [
556
+ "Redundancy"
557
+ ],
558
+ "summary": "Manual switchover",
559
+ "description": "Trigger manual switchover on the active DNOR node",
560
+ "operationId": "redundancy",
561
+ "parameters": [],
562
+ "requestBody": {
563
+ "description": "Manual switchover",
564
+ "content" : {
565
+ "application/json": {
566
+ "schema": {
567
+ "example": {}
568
+ },
569
+ "example": {}
570
+ }
571
+ }
572
+ },
573
+ "responses": {
574
+ "200": {
575
+ "description": "successful operation",
576
+ "headers": {},
577
+ "content": {
578
+ "application/json": {
579
+ "schema": {}
580
+ }
581
+ }
582
+ },
583
+ "403": {
584
+ "description": "operation failed",
585
+ "headers": {},
586
+ "content": {
587
+ "application/json": {
588
+ "schema": {}
589
+ }
590
+ }
591
+ }
592
+ },
593
+ "deprecated": false
594
+ }
595
+ },
596
+ "/target-group/groups": {
597
+ "get": {
598
+ "tags": [
599
+ "NCEGroupManagement"
600
+ ],
601
+ "summary": "Get all existing target groups",
602
+ "description": "Get all existing target groups",
603
+ "operationId": "targetGroupGroups",
604
+ "parameters": [],
605
+ "responses": {
606
+ "200": {
607
+ "description": "successful operation",
608
+ "headers": {},
609
+ "content": {
610
+ "application/json": {
611
+ "schema": {}
612
+ }
613
+ }
614
+ },
615
+ "403": {
616
+ "description": "operation failed",
617
+ "headers": {},
618
+ "content": {
619
+ "application/json": {
620
+ "schema": {}
621
+ }
622
+ }
623
+ },
624
+ "500": {
625
+ "description": "unknown error",
626
+ "headers": {},
627
+ "content": {
628
+ "application/json": {
629
+ "schema": {}
630
+ }
631
+ }
632
+ }
633
+ },
634
+ "deprecated": false
635
+ }
636
+ },
637
+ "/target-group/create-group": {
638
+ "post": {
639
+ "tags": [
640
+ "NCEGroupManagement"
641
+ ],
642
+ "summary": "Create new target group",
643
+ "description": "Create new target gorup",
644
+ "operationId": "targetGroupCreateGroup",
645
+ "parameters": [],
646
+ "requestBody": {
647
+ "description": "Target group details",
648
+ "content" : {
649
+ "application/json": {
650
+ "schema": {
651
+ "example": {
652
+ "groupName": "firstGroup",
653
+ "parentGroupId": "firstGroupId"
654
+ }
655
+ },
656
+ "example": {
657
+ "groupName": "firstGroup",
658
+ "parentGroupId": "firstGroupId"
659
+ }
660
+ }
661
+ }
662
+ },
663
+ "responses": {
664
+ "200": {
665
+ "description": "successful operation",
666
+ "headers": {},
667
+ "content": {
668
+ "application/json": {
669
+ "schema": {}
670
+ }
671
+ }
672
+ },
673
+ "403": {
674
+ "description": "operation failed",
675
+ "headers": {},
676
+ "content": {
677
+ "application/json": {
678
+ "schema": {}
679
+ }
680
+ }
681
+ },
682
+ "404": {
683
+ "description": "operation failed - parent group id not found",
684
+ "headers": {},
685
+ "content": {
686
+ "application/json": {
687
+ "schema": {}
688
+ }
689
+ }
690
+ },
691
+ "500": {
692
+ "description": "unknown error",
693
+ "headers": {},
694
+ "content": {
695
+ "application/json": {
696
+ "schema": {}
697
+ }
698
+ }
699
+ }
700
+ },
701
+ "deprecated": false
702
+ }
703
+ },
704
+ "/target-group/update-group/{group-id}": {
705
+ "put": {
706
+ "tags": [
707
+ "NCEGroupManagement"
708
+ ],
709
+ "summary": "Update target group",
710
+ "description": "Update target group",
711
+ "operationId": "targetGroupUpdateGroupGroupID",
712
+ "parameters": [
713
+ {
714
+ "name": "group-id",
715
+ "in": "path",
716
+ "description": "Group id",
717
+ "required": true,
718
+ "style": "simple",
719
+ "schema": {
720
+ "type": "string",
721
+ "example": {}
722
+ }
723
+ }
724
+ ],
725
+ "requestBody": {
726
+ "description": "Target group details",
727
+ "content" : {
728
+ "application/json": {
729
+ "schema": {
730
+ "example": {
731
+ "groupName": "firstGroup",
732
+ "parentGroupId": "firstGroupId"
733
+ }
734
+ },
735
+ "example": {
736
+ "groupName": "firstGroup",
737
+ "parentGroupId": "firstGroupId"
738
+ }
739
+ }
740
+ }
741
+ },
742
+ "responses": {
743
+ "200": {
744
+ "description": "successful operation",
745
+ "headers": {},
746
+ "content": {
747
+ "application/json": {
748
+ "schema": {}
749
+ }
750
+ }
751
+ },
752
+ "403": {
753
+ "description": "operation failed",
754
+ "headers": {},
755
+ "content": {
756
+ "application/json": {
757
+ "schema": {}
758
+ }
759
+ }
760
+ },
761
+ "404": {
762
+ "description": "operation failed - group id/parent group id not found",
763
+ "headers": {},
764
+ "content": {
765
+ "application/json": {
766
+ "schema": {}
767
+ }
768
+ }
769
+ },
770
+ "500": {
771
+ "description": "unknown error",
772
+ "headers": {},
773
+ "content": {
774
+ "application/json": {
775
+ "schema": {}
776
+ }
777
+ }
778
+ }
779
+ },
780
+ "deprecated": false
781
+ }
782
+ },
783
+ "/target-group/target-group/{group-id}": {
784
+ "delete": {
785
+ "tags": [
786
+ "NCEGroupManagement"
787
+ ],
788
+ "summary": "Delete target group by id",
789
+ "description": "Delete target group by id",
790
+ "operationId": "deleteTargetGroupGroupId",
791
+ "parameters": [
792
+ {
793
+ "name": "group-id",
794
+ "in": "path",
795
+ "description": "Group id",
796
+ "required": true,
797
+ "style": "simple",
798
+ "schema": {
799
+ "type": "string",
800
+ "example": {}
801
+ }
802
+ }
803
+ ],
804
+ "responses": {
805
+ "200": {
806
+ "description": "successful operation",
807
+ "headers": {},
808
+ "content": {
809
+ "application/json": {
810
+ "schema": {}
811
+ }
812
+ }
813
+ },
814
+ "403": {
815
+ "description": "operation failed",
816
+ "headers": {},
817
+ "content": {
818
+ "application/json": {
819
+ "schema": {}
820
+ }
821
+ }
822
+ },
823
+ "404": {
824
+ "description": "operation failed - group id not found",
825
+ "headers": {},
826
+ "content": {
827
+ "application/json": {
828
+ "schema": {}
829
+ }
830
+ }
831
+ },
832
+ "500": {
833
+ "description": "unknown error",
834
+ "headers": {},
835
+ "content": {
836
+ "application/json": {
837
+ "schema": {}
838
+ }
839
+ }
840
+ }
841
+ },
842
+ "deprecated": false
843
+ }
844
+ },
845
+ "/task-management/task-executions": {
846
+ "get": {
847
+ "tags": [
848
+ "TaskManagement"
849
+ ],
850
+ "summary": "Get all tasks executions",
851
+ "description": "Get all tasks executions, past and currently running",
852
+ "operationId": "getTaskManagementTaskExecutions",
853
+ "parameters": [],
854
+ "responses": {
855
+ "200": {
856
+ "description": "successful operation",
857
+ "headers": {},
858
+ "content": {
859
+ "application/json": {
860
+ "schema": {}
861
+ }
862
+ }
863
+ },
864
+ "403": {
865
+ "description": "operation failed",
866
+ "headers": {},
867
+ "content": {
868
+ "application/json": {
869
+ "schema": {}
870
+ }
871
+ }
872
+ },
873
+ "500": {
874
+ "description": "unknown error",
875
+ "headers": {},
876
+ "content": {
877
+ "application/json": {
878
+ "schema": {}
879
+ }
880
+ }
881
+ }
882
+ },
883
+ "deprecated": false
884
+ }
885
+ },
886
+ "/task-management/tasks": {
887
+ "get": {
888
+ "tags": [
889
+ "TaskManagement"
890
+ ],
891
+ "summary": "Get all tasks",
892
+ "description": "Get all tasks",
893
+ "operationId": "getTaskManagementTasks",
894
+ "parameters": [],
895
+ "responses": {
896
+ "200": {
897
+ "description": "successful operation",
898
+ "headers": {},
899
+ "content": {
900
+ "application/json": {
901
+ "schema": {}
902
+ }
903
+ }
904
+ },
905
+ "403": {
906
+ "description": "operation failed",
907
+ "headers": {},
908
+ "content": {
909
+ "application/json": {
910
+ "schema": {}
911
+ }
912
+ }
913
+ },
914
+ "500": {
915
+ "description": "unknown error",
916
+ "headers": {},
917
+ "content": {
918
+ "application/json": {
919
+ "schema": {}
920
+ }
921
+ }
922
+ }
923
+ },
924
+ "deprecated": false
925
+ }
926
+ },
927
+ "/task-management/create-task": {
928
+ "post": {
929
+ "tags": [
930
+ "TaskManagement"
931
+ ],
932
+ "summary": "Create new task",
933
+ "description": "Create new task",
934
+ "operationId": "postTaskManagementCreateTask",
935
+ "parameters": [],
936
+ "requestBody": {
937
+ "description": "Task details",
938
+ "content" : {
939
+ "application/json": {
940
+ "schema": {
941
+ "example": {
942
+ "name": "testTask",
943
+ "function": "Software Upgrade",
944
+ "activation": "Recurrence",
945
+ "scheduledOnce": {
946
+ "startDate": "08-11-2020",
947
+ "startTime": "14:15"
948
+ },
949
+ "scheduledRecurrent": {
950
+ "startDate": "08-11-2020",
951
+ "endDate": "08-11-2020",
952
+ "timeFrame": "Weekly",
953
+ "daysOfWeek": [
954
+ "Sunday"
955
+ ],
956
+ "daysOfMonth": "1,4,15",
957
+ "months": [
958
+ "January"
959
+ ],
960
+ "timeOfDay": "14:15"
961
+ },
962
+ "targetNCEs": [
963
+ "string"
964
+ ],
965
+ "groupIdList": [
966
+ "string"
967
+ ],
968
+ "additionalInfo": {
969
+ "management-channel": "In-Band"
970
+ }
971
+ }
972
+ },
973
+ "example": {
974
+ "name": "testTask",
975
+ "function": "Software Upgrade",
976
+ "activation": "Recurrence",
977
+ "scheduledOnce": {
978
+ "startDate": "08-11-2020",
979
+ "startTime": "14:15"
980
+ },
981
+ "scheduledRecurrent": {
982
+ "startDate": "08-11-2020",
983
+ "endDate": "08-11-2020",
984
+ "timeFrame": "Weekly",
985
+ "daysOfWeek": [
986
+ "Sunday"
987
+ ],
988
+ "daysOfMonth": "1,4,15",
989
+ "months": [
990
+ "January"
991
+ ],
992
+ "timeOfDay": "14:15"
993
+ },
994
+ "targetNCEs": [
995
+ "string"
996
+ ],
997
+ "groupIdList": [
998
+ "string"
999
+ ],
1000
+ "additionalInfo": {
1001
+ "management-channel": "In-Band"
1002
+ }
1003
+ }
1004
+ }
1005
+ }
1006
+ },
1007
+ "responses": {
1008
+ "200": {
1009
+ "description": "successful operation",
1010
+ "headers": {},
1011
+ "content": {
1012
+ "application/json": {
1013
+ "schema": {}
1014
+ }
1015
+ }
1016
+ },
1017
+ "403": {
1018
+ "description": "operation failed",
1019
+ "headers": {},
1020
+ "content": {
1021
+ "application/json": {
1022
+ "schema": {}
1023
+ }
1024
+ }
1025
+ },
1026
+ "500": {
1027
+ "description": "unknown error",
1028
+ "headers": {},
1029
+ "content": {
1030
+ "application/json": {
1031
+ "schema": {}
1032
+ }
1033
+ }
1034
+ }
1035
+ },
1036
+ "deprecated": false
1037
+ }
1038
+ },
1039
+ "/task-management/update-task/{task-id}": {
1040
+ "put": {
1041
+ "tags": [
1042
+ "TaskManagement"
1043
+ ],
1044
+ "summary": "Update task",
1045
+ "description": "Update task",
1046
+ "operationId": "putTaskManagementUpdateTask",
1047
+ "parameters": [{
1048
+ "name": "task-id",
1049
+ "in": "path",
1050
+ "description": "Task id",
1051
+ "required": true,
1052
+ "style": "simple",
1053
+ "schema": {
1054
+ "type": "string",
1055
+ "example": {}
1056
+ }
1057
+ }],
1058
+ "requestBody": {
1059
+ "description": "Task details",
1060
+ "content" : {
1061
+ "application/json": {
1062
+ "schema": {
1063
+ "example": {
1064
+ "name": "testTask",
1065
+ "function": "Software Upgrade",
1066
+ "activation": "Recurrence",
1067
+ "scheduledOnce": {
1068
+ "startDate": "08-11-2020",
1069
+ "startTime": "14:15"
1070
+ },
1071
+ "scheduledRecurrent": {
1072
+ "startDate": "08-11-2020",
1073
+ "endDate": "08-11-2020",
1074
+ "timeFrame": "Weekly",
1075
+ "daysOfWeek": [
1076
+ "Sunday"
1077
+ ],
1078
+ "daysOfMonth": "1,4,15",
1079
+ "months": [
1080
+ "January"
1081
+ ],
1082
+ "timeOfDay": "14:15"
1083
+ },
1084
+ "targetNCEs": [
1085
+ "string"
1086
+ ],
1087
+ "groupIdList": [
1088
+ "string"
1089
+ ],
1090
+ "additionalInfo": {
1091
+ "management-channel": "In-Band"
1092
+ }
1093
+ }
1094
+ },
1095
+ "example": {
1096
+ "name": "testTask",
1097
+ "function": "Software Upgrade",
1098
+ "activation": "Recurrence",
1099
+ "scheduledOnce": {
1100
+ "startDate": "08-11-2020",
1101
+ "startTime": "14:15"
1102
+ },
1103
+ "scheduledRecurrent": {
1104
+ "startDate": "08-11-2020",
1105
+ "endDate": "08-11-2020",
1106
+ "timeFrame": "Weekly",
1107
+ "daysOfWeek": [
1108
+ "Sunday"
1109
+ ],
1110
+ "daysOfMonth": "1,4,15",
1111
+ "months": [
1112
+ "January"
1113
+ ],
1114
+ "timeOfDay": "14:15"
1115
+ },
1116
+ "targetNCEs": [
1117
+ "string"
1118
+ ],
1119
+ "groupIdList": [
1120
+ "string"
1121
+ ],
1122
+ "additionalInfo": {
1123
+ "management-channel": "In-Band"
1124
+ }
1125
+ }
1126
+ }
1127
+ }
1128
+ },
1129
+ "responses": {
1130
+ "200": {
1131
+ "description": "successful operation",
1132
+ "headers": {},
1133
+ "content": {
1134
+ "application/json": {
1135
+ "schema": {}
1136
+ }
1137
+ }
1138
+ },
1139
+ "403": {
1140
+ "description": "operation failed",
1141
+ "headers": {},
1142
+ "content": {
1143
+ "application/json": {
1144
+ "schema": {}
1145
+ }
1146
+ }
1147
+ },
1148
+ "404": {
1149
+ "description": "operation failed - task-id not found",
1150
+ "headers": {},
1151
+ "content": {
1152
+ "application/json": {
1153
+ "schema": {}
1154
+ }
1155
+ }
1156
+ },
1157
+ "500": {
1158
+ "description": "unknown error",
1159
+ "headers": {},
1160
+ "content": {
1161
+ "application/json": {
1162
+ "schema": {}
1163
+ }
1164
+ }
1165
+ }
1166
+ },
1167
+ "deprecated": false
1168
+ }
1169
+ },
1170
+ "/task-management/execute-task/{task-id}": {
1171
+ "post": {
1172
+ "tags": [
1173
+ "TaskManagement"
1174
+ ],
1175
+ "summary": "Execute task",
1176
+ "description": "Execute task",
1177
+ "operationId": "postTaskManagementExecuteTask",
1178
+ "parameters": [{
1179
+ "name": "task-id",
1180
+ "in": "path",
1181
+ "description": "Task id",
1182
+ "required": true,
1183
+ "style": "simple",
1184
+ "schema": {
1185
+ "type": "string",
1186
+ "example": {}
1187
+ }
1188
+ }],
1189
+ "responses": {
1190
+ "200": {
1191
+ "description": "successful operation",
1192
+ "headers": {},
1193
+ "content": {
1194
+ "application/json": {
1195
+ "schema": {}
1196
+ }
1197
+ }
1198
+ },
1199
+ "403": {
1200
+ "description": "operation failed",
1201
+ "headers": {},
1202
+ "content": {
1203
+ "application/json": {
1204
+ "schema": {}
1205
+ }
1206
+ }
1207
+ },
1208
+ "404": {
1209
+ "description": "operation failed - task-id not found",
1210
+ "headers": {},
1211
+ "content": {
1212
+ "application/json": {
1213
+ "schema": {}
1214
+ }
1215
+ }
1216
+ },
1217
+ "500": {
1218
+ "description": "unknown error",
1219
+ "headers": {},
1220
+ "content": {
1221
+ "application/json": {
1222
+ "schema": {}
1223
+ }
1224
+ }
1225
+ }
1226
+ },
1227
+ "deprecated": false
1228
+ }
1229
+ },
1230
+ "/task-management/cancel-task/{task-execution-id}": {
1231
+ "post": {
1232
+ "tags": [
1233
+ "TaskManagement"
1234
+ ],
1235
+ "summary": "Cancel running task",
1236
+ "description": "Cancel running task",
1237
+ "operationId": "postTaskManagementCancelTask",
1238
+ "parameters": [{
1239
+ "name": "task-execution-id",
1240
+ "in": "path",
1241
+ "description": "Task execution id",
1242
+ "required": true,
1243
+ "style": "simple",
1244
+ "schema": {
1245
+ "type": "string",
1246
+ "example": {}
1247
+ }
1248
+ }],
1249
+ "responses": {
1250
+ "200": {
1251
+ "description": "successful operation",
1252
+ "headers": {},
1253
+ "content": {
1254
+ "application/json": {
1255
+ "schema": {}
1256
+ }
1257
+ }
1258
+ },
1259
+ "403": {
1260
+ "description": "operation failed",
1261
+ "headers": {},
1262
+ "content": {
1263
+ "application/json": {
1264
+ "schema": {}
1265
+ }
1266
+ }
1267
+ },
1268
+ "404": {
1269
+ "description": "operation failed - task-id not found",
1270
+ "headers": {},
1271
+ "content": {
1272
+ "application/json": {
1273
+ "schema": {}
1274
+ }
1275
+ }
1276
+ },
1277
+ "500": {
1278
+ "description": "unknown error",
1279
+ "headers": {},
1280
+ "content": {
1281
+ "application/json": {
1282
+ "schema": {}
1283
+ }
1284
+ }
1285
+ }
1286
+ },
1287
+ "deprecated": false
1288
+ }
1289
+ },
1290
+ "/task-management/delete-task/{task-id}": {
1291
+ "delete": {
1292
+ "tags": [
1293
+ "TaskManagement"
1294
+ ],
1295
+ "summary": "Delete task by task id",
1296
+ "description": "Delete task by task id",
1297
+ "operationId": "taskManagementDeleteTask",
1298
+ "parameters": [{
1299
+ "name": "task-id",
1300
+ "in": "path",
1301
+ "description": "Task id",
1302
+ "required": true,
1303
+ "style": "simple",
1304
+ "schema": {
1305
+ "type": "string",
1306
+ "example": {}
1307
+ }
1308
+ }],
1309
+ "responses": {
1310
+ "200": {
1311
+ "description": "successful operation",
1312
+ "headers": {},
1313
+ "content": {
1314
+ "application/json": {
1315
+ "schema": {}
1316
+ }
1317
+ }
1318
+ },
1319
+ "403": {
1320
+ "description": "operation failed",
1321
+ "headers": {},
1322
+ "content": {
1323
+ "application/json": {
1324
+ "schema": {}
1325
+ }
1326
+ }
1327
+ },
1328
+ "404": {
1329
+ "description": "operation failed - task-id not found",
1330
+ "headers": {},
1331
+ "content": {
1332
+ "application/json": {
1333
+ "schema": {}
1334
+ }
1335
+ }
1336
+ },
1337
+ "500": {
1338
+ "description": "unknown error",
1339
+ "headers": {},
1340
+ "content": {
1341
+ "application/json": {
1342
+ "schema": {}
1343
+ }
1344
+ }
1345
+ }
1346
+ },
1347
+ "deprecated": false
1348
+ }
1349
+ },
1350
+ "/services/monitoring/fault-management/alarms/{alarm-name}": {
1351
+ "get": {
1352
+ "tags": [
1353
+ "MonitoringFaultManagementAlarms"
1354
+ ],
1355
+ "summary": "Get alarm configuration by alarm name.",
1356
+ "description": "Get alarm configuration by alarm name.",
1357
+ "operationId": "getFaultManagementAlarmConfiguration",
1358
+ "parameters": [{
1359
+ "name": "alarm-name",
1360
+ "in": "path",
1361
+ "description": "Alarm name",
1362
+ "required": true,
1363
+ "style": "simple",
1364
+ "schema": {
1365
+ "type": "string",
1366
+ "example": {}
1367
+ }
1368
+ }],
1369
+ "responses": {
1370
+ "200": {
1371
+ "description": "successful operation",
1372
+ "headers": {},
1373
+ "content": {
1374
+ "application/json": {
1375
+ "schema": {}
1376
+ }
1377
+ }
1378
+ },
1379
+ "400": {
1380
+ "description": "operation failed",
1381
+ "headers": {},
1382
+ "content": {
1383
+ "application/json": {
1384
+ "schema": {}
1385
+ }
1386
+ }
1387
+ }},
1388
+ "deprecated": false
1389
+ }
1390
+ },
1391
+ "/services/monitoring/fault-management/alarms/": {
1392
+ "get": {
1393
+ "tags": [
1394
+ "MonitoringFaultManagementAlarms"
1395
+ ],
1396
+ "summary": "Get all alarms configuration.",
1397
+ "description": "Get all alarms configuration.",
1398
+ "operationId": "getAllFaultManagementAlarmConfiguration",
1399
+ "parameters": [],
1400
+ "responses": {
1401
+ "200": {
1402
+ "description": "successful operation",
1403
+ "headers": {},
1404
+ "content": {
1405
+ "application/json": {
1406
+ "schema": {}
1407
+ }
1408
+ }
1409
+ },
1410
+ "400": {
1411
+ "description": "operation failed",
1412
+ "headers": {},
1413
+ "content": {
1414
+ "application/json": {
1415
+ "schema": {}
1416
+ }
1417
+ }
1418
+ }},
1419
+ "deprecated": false
1420
+ }
1421
+ },
1422
+ "/services/monitoring/fault-management/active-alarms/": {
1423
+ "get": {
1424
+ "tags": [
1425
+ "MonitoringFaultManagementActiveAlarms"
1426
+ ],
1427
+ "summary": "Get all active alarms.",
1428
+ "description": "Get all active alarms.",
1429
+ "operationId": "getAllFaultManagementActiveAlarms",
1430
+ "parameters": [],
1431
+ "responses": {
1432
+ "200": {
1433
+ "description": "successful operation",
1434
+ "headers": {},
1435
+ "content": {
1436
+ "application/json": {
1437
+ "schema": {}
1438
+ }
1439
+ }
1440
+ },
1441
+ "400": {
1442
+ "description": "operation failed",
1443
+ "headers": {},
1444
+ "content": {
1445
+ "application/json": {
1446
+ "schema": {}
1447
+ }
1448
+ }
1449
+ }},
1450
+ "deprecated": false
1451
+ }
1452
+ }
1453
+ },
1454
+ "components": {
1455
+ "schemas": {
1456
+ "RootType": {
1457
+ "title": "RootType",
1458
+ "required": ["Types"],
1459
+ "type": "object",
1460
+ "properties": {
1461
+ "Types": {
1462
+ "$ref": "#/components/schemas/Types2"
1463
+ }
1464
+ },
1465
+ "xml": {
1466
+ "name": "RootType",
1467
+ "prefix": "",
1468
+ "attribute": false,
1469
+ "wrapped": false
1470
+ }
1471
+ },
1472
+ "Types": {
1473
+ "title": "Types",
1474
+ "required": ["Default", "Override"],
1475
+ "type": "object",
1476
+ "properties": {
1477
+ "Default": {
1478
+ "type": "array",
1479
+ "items": {
1480
+ "$ref": "#/components/schemas/Default"
1481
+ },
1482
+ "description": "",
1483
+ "xml": {
1484
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1485
+ "attribute": false,
1486
+ "wrapped": false
1487
+ },
1488
+ "example": "<Default Extension=\"rels\" ContentType=\"application/vnd.openxmlformats-package.relationships+xml\" />"
1489
+ },
1490
+ "Override": {
1491
+ "type": "array",
1492
+ "items": {
1493
+ "$ref": "#/components/schemas/Override"
1494
+ },
1495
+ "description": "",
1496
+ "xml": {
1497
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1498
+ "attribute": false,
1499
+ "wrapped": false
1500
+ },
1501
+ "example": "<Override PartName=\"/word/document.xml\" ContentType=\"application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml\" />"
1502
+ }
1503
+ },
1504
+ "xml": {
1505
+ "name": "Types",
1506
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1507
+ "attribute": false,
1508
+ "wrapped": false
1509
+ }
1510
+ },
1511
+ "Default": {
1512
+ "title": "Default",
1513
+ "required": ["Extension", "ContentType"],
1514
+ "type": "object",
1515
+ "properties": {
1516
+ "Extension": {
1517
+ "type": "string",
1518
+ "xml": {
1519
+ "name": "Extension",
1520
+ "attribute": true,
1521
+ "wrapped": false
1522
+ },
1523
+ "example": "<Extension>rels</Extension>"
1524
+ },
1525
+ "ContentType": {
1526
+ "type": "string",
1527
+ "xml": {
1528
+ "name": "ContentType",
1529
+ "attribute": true,
1530
+ "wrapped": false
1531
+ },
1532
+ "example": "<ContentType>application/vnd.openxmlformats-package.relationships+xml</ContentType>"
1533
+ }
1534
+ },
1535
+ "xml": {
1536
+ "name": "Default",
1537
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1538
+ "attribute": false,
1539
+ "wrapped": false
1540
+ }
1541
+ },
1542
+ "Override": {
1543
+ "title": "Override",
1544
+ "required": ["PartName", "ContentType"],
1545
+ "type": "object",
1546
+ "properties": {
1547
+ "PartName": {
1548
+ "type": "string",
1549
+ "xml": {
1550
+ "name": "PartName",
1551
+ "attribute": true,
1552
+ "wrapped": false
1553
+ },
1554
+ "example": "<PartName>/word/document.xml</PartName>"
1555
+ },
1556
+ "ContentType": {
1557
+ "type": "string",
1558
+ "xml": {
1559
+ "name": "ContentType",
1560
+ "attribute": true,
1561
+ "wrapped": false
1562
+ },
1563
+ "example": "<ContentType>application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml</ContentType>"
1564
+ }
1565
+ },
1566
+ "xml": {
1567
+ "name": "Override",
1568
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1569
+ "attribute": false,
1570
+ "wrapped": false
1571
+ }
1572
+ },
1573
+ "Types2": {
1574
+ "title": "Types2",
1575
+ "required": ["Default", "Override"],
1576
+ "type": "object",
1577
+ "properties": {
1578
+ "Default": {
1579
+ "type": "array",
1580
+ "items": {
1581
+ "$ref": "#/components/schemas/Default"
1582
+ },
1583
+ "description": "",
1584
+ "xml": {
1585
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1586
+ "attribute": false,
1587
+ "wrapped": false
1588
+ },
1589
+ "example": "<Default Extension=\"rels\" ContentType=\"application/vnd.openxmlformats-package.relationships+xml\" />"
1590
+ },
1591
+ "Override": {
1592
+ "type": "array",
1593
+ "items": {
1594
+ "$ref": "#/components/schemas/Override"
1595
+ },
1596
+ "description": "",
1597
+ "xml": {
1598
+ "namespace": "http://schemas.openxmlformats.org/package/2006/content-types",
1599
+ "attribute": false,
1600
+ "wrapped": false
1601
+ },
1602
+ "example": "<Override PartName=\"/word/document.xml\" ContentType=\"application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml\" />"
1603
+ }
1604
+ }
1605
+ }
1606
+ }
1607
+ },
1608
+ "tags": [
1609
+ {
1610
+ "name": "NCEManagement",
1611
+ "description": "NCE Management"
1612
+ },
1613
+ {
1614
+ "name": "Redundancy",
1615
+ "description": "Redundancy"
1616
+ },
1617
+ {
1618
+ "name": "NCEGroupManagement",
1619
+ "description": "NCE Group Management"
1620
+ },
1621
+ {
1622
+ "name": "TaskManagement",
1623
+ "description": "Task Management"
1624
+ },
1625
+ {
1626
+ "name": "MonitoringFaultManagementAlarms",
1627
+ "description": "Monitoring Fault Management Alarms"
1628
+ }
1629
+ ],
1630
+ "externalDocs": {
1631
+ "description": "Find out more about the OpenAPI Initiative",
1632
+ "url": "https://www.openapis.org/"
1633
+ }
1634
+ }