@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.yaml ADDED
@@ -0,0 +1,1181 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: DNOR - Drivenet Orchestration
4
+ description: This is a sample description. You can find out more about the OpenAPI Specification at http://spec.openapis.org/oas/v3.0.3.
5
+ contact:
6
+ email: ankit.bhansali@itential.com
7
+ version: '1.0.0'
8
+ servers:
9
+ - url: https://localhost
10
+ variables: {}
11
+ paths:
12
+ /nce-management/deploy:
13
+ post:
14
+ tags:
15
+ - NCEManagement
16
+ summary: deploy
17
+ description: Deploy DNOS to create an NCE.
18
+ operationId: deploy
19
+ parameters: []
20
+ requestBody:
21
+ description: ''
22
+ content:
23
+ application/json:
24
+ schema:
25
+ example:
26
+ name: NY22C
27
+ candidateDNOSYaml: v13.0
28
+ oobIpv4Address: Acquired
29
+ oobIpv4Subnet: 24
30
+ oobIpv6Address: Acquired
31
+ oobIpv6Subnet: 127
32
+ oobIpv4DefaultGateway: 198.51.100.42
33
+ oobIpv6DefaultGateway: 2001:0db8:5b96:0000:0000:426f:8e17:642a
34
+ inBandIpv4Address: 198.51.100.42
35
+ inBandIpv4Subnet: 24
36
+ inBandIpv6Address: 2001:0db8:5b96:0000:0000:426f:8e17:642a
37
+ inBandIpv6Subnet: 127
38
+ minimumNccs: 2
39
+ siteId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
40
+ configurationData:
41
+ filename: baseConfig.xml
42
+ username: dnroot
43
+ configurationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
44
+ formation:
45
+ type: Cluster
46
+ specific: CL-96
47
+ nccs:
48
+ - serialNumber: string
49
+ nccId: 1
50
+ example:
51
+ name: NY22C
52
+ candidateDNOSYaml: v13.0
53
+ oobIpv4Address: Acquired
54
+ oobIpv4Subnet: 24
55
+ oobIpv6Address: Acquired
56
+ oobIpv6Subnet: 127
57
+ oobIpv4DefaultGateway: 198.51.100.42
58
+ oobIpv6DefaultGateway: 2001:0db8:5b96:0000:0000:426f:8e17:642a
59
+ inBandIpv4Address: 198.51.100.42
60
+ inBandIpv4Subnet: 24
61
+ inBandIpv6Address: 2001:0db8:5b96:0000:0000:426f:8e17:642a
62
+ inBandIpv6Subnet: 127
63
+ minimumNccs: 2
64
+ siteId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
65
+ configurationData:
66
+ filename: baseConfig.xml
67
+ username: dnroot
68
+ configurationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
69
+ formation:
70
+ type: Cluster
71
+ specific: CL-96
72
+ nccs:
73
+ - serialNumber: string
74
+ nccId: 1
75
+ required: true
76
+ responses:
77
+ '200':
78
+ description: successful operation
79
+ headers: {}
80
+ content:
81
+ application/json:
82
+ schema: {}
83
+ '403':
84
+ description: operation failed
85
+ headers: {}
86
+ content:
87
+ application/json:
88
+ schema: {}
89
+ deprecated: false
90
+ /nce-management/{cluster-id}:
91
+ put:
92
+ tags:
93
+ - NCEManagement
94
+ summary: updateNCEbyClusterID
95
+ description: Edit an existing NCE. If NCE is in 'Waiting for equipment' status all required body fields should be provided as in Create NCE
96
+ operationId: updateNCEbyClusterID
97
+ parameters:
98
+ - name: cluster-id
99
+ in: path
100
+ description: System-ID of the NCE
101
+ required: true
102
+ style: simple
103
+ schema:
104
+ type: string
105
+ example: {}
106
+ requestBody:
107
+ description: ''
108
+ content:
109
+ application/json:
110
+ schema:
111
+ example:
112
+ name: NY22C
113
+ inBandIpv4Address: 198.51.100.42
114
+ inBandIpv4Subnet: 24
115
+ inBandIpv6Address: 2001:0db8:5b96:0000:0000:426f:8e17:642a
116
+ inBandIpv6Subnet: 127
117
+ oobIpv4DefaultGateway: 198.51.100.42
118
+ oobIpv6DefaultGateway: 2001:0db8:5b96:0000:0000:426f:8e17:642a
119
+ siteId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
120
+ formation:
121
+ type: Cluster
122
+ specific: CL-96
123
+ targetGroupId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
124
+ nccs:
125
+ - serialNumber: string
126
+ nccId: 1
127
+ example:
128
+ name: NY22C
129
+ inBandIpv4Address: 198.51.100.42
130
+ inBandIpv4Subnet: 24
131
+ inBandIpv6Address: 2001:0db8:5b96:0000:0000:426f:8e17:642a
132
+ inBandIpv6Subnet: 127
133
+ oobIpv4DefaultGateway: 198.51.100.42
134
+ oobIpv6DefaultGateway: 2001:0db8:5b96:0000:0000:426f:8e17:642a
135
+ siteId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
136
+ formation:
137
+ type: Cluster
138
+ specific: CL-96
139
+ targetGroupId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
140
+ nccs:
141
+ - serialNumber: string
142
+ nccId: 1
143
+ required: true
144
+ responses:
145
+ '200':
146
+ description: successful operation
147
+ headers: {}
148
+ content:
149
+ application/json:
150
+ schema: {}
151
+ '403':
152
+ description: operation failed
153
+ headers: {}
154
+ content:
155
+ application/json:
156
+ schema: {}
157
+ deprecated: false
158
+ delete:
159
+ tags:
160
+ - NCEManagement
161
+ summary: deleteNCEbyClusterID
162
+ description: Remove an NCE from DNOR and delete the DNOS installation on the NCE nodes.
163
+ operationId: deleteNCEbyClusterID
164
+ parameters:
165
+ - name: cluster-id
166
+ in: path
167
+ description: ''
168
+ required: true
169
+ style: simple
170
+ schema:
171
+ type: string
172
+ example: {}
173
+ responses:
174
+ '200':
175
+ description: successful operation
176
+ headers: {}
177
+ content:
178
+ application/json:
179
+ schema: {}
180
+ '403':
181
+ description: operation failed
182
+ headers: {}
183
+ content:
184
+ application/json:
185
+ schema: {}
186
+ deprecated: false
187
+ /nce-management/download/{cluster-id}:
188
+ post:
189
+ tags:
190
+ - NCEManagement
191
+ summary: nceManagementDownload
192
+ description: Download a newer version of DNOS to the NCE (prior to upgrade).
193
+ operationId: nceManagementDownload
194
+ parameters:
195
+ - name: cluster-id
196
+ in: path
197
+ description: System-ID of the NCE
198
+ required: true
199
+ style: simple
200
+ schema:
201
+ type: string
202
+ example: {}
203
+ requestBody:
204
+ description: Download values
205
+ content:
206
+ application/json:
207
+ schema:
208
+ description: Download values
209
+ example:
210
+ version: string
211
+ inBand: false
212
+ example:
213
+ version: string
214
+ inBand: false
215
+ required: true
216
+ responses:
217
+ '200':
218
+ description: successful operation
219
+ headers: {}
220
+ content:
221
+ application/json:
222
+ schema: {}
223
+ '403':
224
+ description: failed operation
225
+ headers: {}
226
+ content: {}
227
+ deprecated: false
228
+ /nce-management/upgrade/{cluster-id}:
229
+ post:
230
+ tags:
231
+ - NCEManagement
232
+ summary: nceManagementUpgrade
233
+ description: Upgrade the version of DNOS running on an NCE.
234
+ operationId: nceManagementUpgrade
235
+ parameters:
236
+ - name: cluster-id
237
+ in: path
238
+ description: System-ID of the NCE
239
+ required: true
240
+ style: simple
241
+ schema:
242
+ type: string
243
+ example: {}
244
+ requestBody:
245
+ description: Upgrade deatil
246
+ content:
247
+ application/json:
248
+ schema:
249
+ description: Upgrade deatil
250
+ example: {}
251
+ example: {}
252
+ required: true
253
+ responses:
254
+ '200':
255
+ description: successful operation
256
+ headers: {}
257
+ content:
258
+ application/json:
259
+ schema: {}
260
+ '403':
261
+ description: failed operation
262
+ headers: {}
263
+ content: {}
264
+ deprecated: false
265
+ /nce-management/cancel/{cluster-id}:
266
+ post:
267
+ tags:
268
+ - NCEManagement
269
+ summary: nceManagementCancel
270
+ description: Cancel the current process running on an NCE
271
+ operationId: nceManagementCancel
272
+ parameters:
273
+ - name: cluster-id
274
+ in: path
275
+ description: System-ID of the NCE
276
+ required: true
277
+ style: simple
278
+ schema:
279
+ type: string
280
+ example: {}
281
+ responses:
282
+ '200':
283
+ description: successful operation
284
+ headers: {}
285
+ content:
286
+ application/json:
287
+ schema: {}
288
+ '403':
289
+ description: Cannot cancel process at the current stage
290
+ headers: {}
291
+ content:
292
+ application/json:
293
+ schema: {}
294
+ '404':
295
+ description: Process not found
296
+ headers: {}
297
+ content:
298
+ application/json:
299
+ schema: {}
300
+ '500':
301
+ description: Cannot cancel - unknown error
302
+ headers: {}
303
+ content:
304
+ application/json:
305
+ schema: {}
306
+ deprecated: false
307
+ /nce-management/precheck/{cluster-id}:
308
+ post:
309
+ tags:
310
+ - NCEManagement
311
+ summary: nceManagementPrecheck
312
+ description: Preupgrade validation
313
+ operationId: nceManagementPrecheck
314
+ parameters:
315
+ - name: cluster-id
316
+ in: path
317
+ description: System-ID of the NCE
318
+ required: true
319
+ style: simple
320
+ schema:
321
+ type: string
322
+ example: {}
323
+ responses:
324
+ '200':
325
+ description: successful operation
326
+ headers: {}
327
+ content:
328
+ application/json:
329
+ schema: {}
330
+ '403':
331
+ description: Precheck failed
332
+ headers: {}
333
+ content:
334
+ application/json:
335
+ schema: {}
336
+ deprecated: false
337
+ /redundancy/disable:
338
+ put:
339
+ tags:
340
+ - Redundancy
341
+ summary: redundancyDisable
342
+ description: Disable DNOR node values
343
+ operationId: redundancyDisable
344
+ parameters: []
345
+ requestBody:
346
+ description: ''
347
+ content:
348
+ application/json:
349
+ schema:
350
+ example:
351
+ dnorRole: PRIMARY
352
+ addr: 198.51.100.42
353
+ example:
354
+ dnorRole: PRIMARY
355
+ addr: 198.51.100.42
356
+ required: false
357
+ responses:
358
+ '200':
359
+ description: successful operation
360
+ headers: {}
361
+ content:
362
+ application/json:
363
+ schema: {}
364
+ '403':
365
+ description: operation failed
366
+ headers: {}
367
+ content:
368
+ application/json:
369
+ schema: {}
370
+ deprecated: false
371
+ /redundancy/enable:
372
+ put:
373
+ tags:
374
+ - Redundancy
375
+ summary: redundancyEnable
376
+ description: Enable DNOR node values
377
+ operationId: redundancyEnable
378
+ parameters: []
379
+ requestBody:
380
+ description: ''
381
+ content:
382
+ application/json:
383
+ schema:
384
+ example:
385
+ dnorRole: PRIMARY
386
+ addr: 198.51.100.42
387
+ example:
388
+ dnorRole: PRIMARY
389
+ addr: 198.51.100.42
390
+ required: false
391
+ responses:
392
+ '200':
393
+ description: successful operation
394
+ headers: {}
395
+ content:
396
+ application/json:
397
+ schema: {}
398
+ '403':
399
+ description: operation failed
400
+ headers: {}
401
+ content:
402
+ application/json:
403
+ schema: {}
404
+ deprecated: false
405
+ /redundancy:
406
+ put:
407
+ tags:
408
+ - Redundancy
409
+ summary: redundancy
410
+ description: Trigger manual switchover on the active DNOR node
411
+ operationId: redundancy
412
+ parameters: []
413
+ requestBody:
414
+ description: Manual switchover
415
+ content:
416
+ application/json:
417
+ schema:
418
+ description: Manual switchover
419
+ example: {}
420
+ example: {}
421
+ required: false
422
+ responses:
423
+ '200':
424
+ description: successful operation
425
+ headers: {}
426
+ content:
427
+ application/json:
428
+ schema: {}
429
+ '403':
430
+ description: operation failed
431
+ headers: {}
432
+ content:
433
+ application/json:
434
+ schema: {}
435
+ deprecated: false
436
+ /target-group/groups:
437
+ get:
438
+ tags:
439
+ - NCEGroupManagement
440
+ summary: targetGroupGroups
441
+ description: Get all existing target groups
442
+ operationId: targetGroupGroups
443
+ parameters: []
444
+ responses:
445
+ '200':
446
+ description: successful operation
447
+ headers: {}
448
+ content:
449
+ application/json:
450
+ schema: {}
451
+ '403':
452
+ description: operation failed
453
+ headers: {}
454
+ content:
455
+ application/json:
456
+ schema: {}
457
+ '500':
458
+ description: unknown error
459
+ headers: {}
460
+ content:
461
+ application/json:
462
+ schema: {}
463
+ deprecated: false
464
+ /target-group/create-group:
465
+ post:
466
+ tags:
467
+ - NCEGroupManagement
468
+ summary: targetGroupCreateGroup
469
+ description: Create new target gorup
470
+ operationId: targetGroupCreateGroup
471
+ parameters: []
472
+ requestBody:
473
+ description: Target group details
474
+ content:
475
+ application/json:
476
+ schema:
477
+ description: Target group details
478
+ example:
479
+ groupName: firstGroup
480
+ parentGroupId: firstGroupId
481
+ example:
482
+ groupName: firstGroup
483
+ parentGroupId: firstGroupId
484
+ required: false
485
+ responses:
486
+ '200':
487
+ description: successful operation
488
+ headers: {}
489
+ content:
490
+ application/json:
491
+ schema: {}
492
+ '403':
493
+ description: operation failed
494
+ headers: {}
495
+ content:
496
+ application/json:
497
+ schema: {}
498
+ '404':
499
+ description: operation failed - parent group id not found
500
+ headers: {}
501
+ content:
502
+ application/json:
503
+ schema: {}
504
+ '500':
505
+ description: unknown error
506
+ headers: {}
507
+ content:
508
+ application/json:
509
+ schema: {}
510
+ deprecated: false
511
+ /target-group/update-group/{group-id}:
512
+ put:
513
+ tags:
514
+ - NCEGroupManagement
515
+ summary: targetGroupUpdateGroupGroupID
516
+ description: Update target group
517
+ operationId: targetGroupUpdateGroupGroupID
518
+ parameters:
519
+ - name: group-id
520
+ in: path
521
+ description: Group id
522
+ required: true
523
+ style: simple
524
+ schema:
525
+ type: string
526
+ example: {}
527
+ requestBody:
528
+ description: Target group details
529
+ content:
530
+ application/json:
531
+ schema:
532
+ description: Target group details
533
+ example:
534
+ groupName: firstGroup
535
+ parentGroupId: firstGroupId
536
+ example:
537
+ groupName: firstGroup
538
+ parentGroupId: firstGroupId
539
+ required: false
540
+ responses:
541
+ '200':
542
+ description: successful operation
543
+ headers: {}
544
+ content:
545
+ application/json:
546
+ schema: {}
547
+ '403':
548
+ description: operation failed
549
+ headers: {}
550
+ content:
551
+ application/json:
552
+ schema: {}
553
+ '404':
554
+ description: operation failed - group id/parent group id not found
555
+ headers: {}
556
+ content:
557
+ application/json:
558
+ schema: {}
559
+ '500':
560
+ description: unknown error
561
+ headers: {}
562
+ content:
563
+ application/json:
564
+ schema: {}
565
+ deprecated: false
566
+ /target-group/target-group/{group-id}:
567
+ delete:
568
+ tags:
569
+ - NCEGroupManagement
570
+ summary: deleteTargetGroupGroupId
571
+ description: Delete target group by id
572
+ operationId: deleteTargetGroupGroupId
573
+ parameters:
574
+ - name: group-id
575
+ in: path
576
+ description: Group id
577
+ required: true
578
+ style: simple
579
+ schema:
580
+ type: string
581
+ example: {}
582
+ responses:
583
+ '200':
584
+ description: successful operation
585
+ headers: {}
586
+ content:
587
+ application/json:
588
+ schema: {}
589
+ '403':
590
+ description: operation failed
591
+ headers: {}
592
+ content:
593
+ application/json:
594
+ schema: {}
595
+ '404':
596
+ description: operation failed - group id not found
597
+ headers: {}
598
+ content:
599
+ application/json:
600
+ schema: {}
601
+ '500':
602
+ description: unknown error
603
+ headers: {}
604
+ content:
605
+ application/json:
606
+ schema: {}
607
+ deprecated: false
608
+ /task-management/task-executions:
609
+ get:
610
+ tags:
611
+ - TaskManagement
612
+ summary: getTaskManagementTaskExecutions
613
+ description: Get all tasks executions, past and currently running
614
+ operationId: getTaskManagementTaskExecutions
615
+ parameters: []
616
+ responses:
617
+ '200':
618
+ description: successful operation
619
+ headers: {}
620
+ content:
621
+ application/json:
622
+ schema: {}
623
+ '403':
624
+ description: operation failed
625
+ headers: {}
626
+ content:
627
+ application/json:
628
+ schema: {}
629
+ '500':
630
+ description: unknown error
631
+ headers: {}
632
+ content:
633
+ application/json:
634
+ schema: {}
635
+ deprecated: false
636
+ /task-management/tasks:
637
+ get:
638
+ tags:
639
+ - TaskManagement
640
+ summary: getTaskManagementTasks
641
+ description: Get all tasks
642
+ operationId: getTaskManagementTasks
643
+ parameters: []
644
+ responses:
645
+ '200':
646
+ description: successful operation
647
+ headers: {}
648
+ content:
649
+ application/json:
650
+ schema: {}
651
+ '403':
652
+ description: operation failed
653
+ headers: {}
654
+ content:
655
+ application/json:
656
+ schema: {}
657
+ '500':
658
+ description: unknown error
659
+ headers: {}
660
+ content:
661
+ application/json:
662
+ schema: {}
663
+ deprecated: false
664
+ /task-management/create-task:
665
+ post:
666
+ tags:
667
+ - TaskManagement
668
+ summary: postTaskManagementCreateTask
669
+ description: Create new task
670
+ operationId: postTaskManagementCreateTask
671
+ parameters: []
672
+ requestBody:
673
+ description: Task details
674
+ content:
675
+ application/json:
676
+ schema:
677
+ description: Task details
678
+ example:
679
+ name: testTask
680
+ function: Software Upgrade
681
+ activation: Recurrence
682
+ scheduledOnce:
683
+ startDate: 08-11-2020
684
+ startTime: 14:15
685
+ scheduledRecurrent:
686
+ startDate: 08-11-2020
687
+ endDate: 08-11-2020
688
+ timeFrame: Weekly
689
+ daysOfWeek:
690
+ - Sunday
691
+ daysOfMonth: 1,4,15
692
+ months:
693
+ - January
694
+ timeOfDay: 14:15
695
+ targetNCEs:
696
+ - string
697
+ groupIdList:
698
+ - string
699
+ additionalInfo:
700
+ management-channel: In-Band
701
+ example:
702
+ name: testTask
703
+ function: Software Upgrade
704
+ activation: Recurrence
705
+ scheduledOnce:
706
+ startDate: 08-11-2020
707
+ startTime: 14:15
708
+ scheduledRecurrent:
709
+ startDate: 08-11-2020
710
+ endDate: 08-11-2020
711
+ timeFrame: Weekly
712
+ daysOfWeek:
713
+ - Sunday
714
+ daysOfMonth: 1,4,15
715
+ months:
716
+ - January
717
+ timeOfDay: 14:15
718
+ targetNCEs:
719
+ - string
720
+ groupIdList:
721
+ - string
722
+ additionalInfo:
723
+ management-channel: In-Band
724
+ required: false
725
+ responses:
726
+ '200':
727
+ description: successful operation
728
+ headers: {}
729
+ content:
730
+ application/json:
731
+ schema: {}
732
+ '403':
733
+ description: operation failed
734
+ headers: {}
735
+ content:
736
+ application/json:
737
+ schema: {}
738
+ '500':
739
+ description: unknown error
740
+ headers: {}
741
+ content:
742
+ application/json:
743
+ schema: {}
744
+ deprecated: false
745
+ /task-management/update-task/{task-id}:
746
+ put:
747
+ tags:
748
+ - TaskManagement
749
+ summary: putTaskManagementUpdateTask
750
+ description: Update task
751
+ operationId: putTaskManagementUpdateTask
752
+ parameters:
753
+ - name: task-id
754
+ in: path
755
+ description: Task id
756
+ required: true
757
+ style: simple
758
+ schema:
759
+ type: string
760
+ example: {}
761
+ requestBody:
762
+ description: Task details
763
+ content:
764
+ application/json:
765
+ schema:
766
+ description: Task details
767
+ example:
768
+ name: testTask
769
+ function: Software Upgrade
770
+ activation: Recurrence
771
+ scheduledOnce:
772
+ startDate: 08-11-2020
773
+ startTime: 14:15
774
+ scheduledRecurrent:
775
+ startDate: 08-11-2020
776
+ endDate: 08-11-2020
777
+ timeFrame: Weekly
778
+ daysOfWeek:
779
+ - Sunday
780
+ daysOfMonth: 1,4,15
781
+ months:
782
+ - January
783
+ timeOfDay: 14:15
784
+ targetNCEs:
785
+ - string
786
+ groupIdList:
787
+ - string
788
+ additionalInfo:
789
+ management-channel: In-Band
790
+ example:
791
+ name: testTask
792
+ function: Software Upgrade
793
+ activation: Recurrence
794
+ scheduledOnce:
795
+ startDate: 08-11-2020
796
+ startTime: 14:15
797
+ scheduledRecurrent:
798
+ startDate: 08-11-2020
799
+ endDate: 08-11-2020
800
+ timeFrame: Weekly
801
+ daysOfWeek:
802
+ - Sunday
803
+ daysOfMonth: 1,4,15
804
+ months:
805
+ - January
806
+ timeOfDay: 14:15
807
+ targetNCEs:
808
+ - string
809
+ groupIdList:
810
+ - string
811
+ additionalInfo:
812
+ management-channel: In-Band
813
+ required: false
814
+ responses:
815
+ '200':
816
+ description: successful operation
817
+ headers: {}
818
+ content:
819
+ application/json:
820
+ schema: {}
821
+ '403':
822
+ description: operation failed
823
+ headers: {}
824
+ content:
825
+ application/json:
826
+ schema: {}
827
+ '404':
828
+ description: operation failed - task-id not found
829
+ headers: {}
830
+ content:
831
+ application/json:
832
+ schema: {}
833
+ '500':
834
+ description: unknown error
835
+ headers: {}
836
+ content:
837
+ application/json:
838
+ schema: {}
839
+ deprecated: false
840
+ /task-management/execute-task/{task-id}:
841
+ post:
842
+ tags:
843
+ - TaskManagement
844
+ summary: postTaskManagementExecuteTask
845
+ description: Execute task
846
+ operationId: postTaskManagementExecuteTask
847
+ parameters:
848
+ - name: task-id
849
+ in: path
850
+ description: Task id
851
+ required: true
852
+ style: simple
853
+ schema:
854
+ type: string
855
+ example: {}
856
+ responses:
857
+ '200':
858
+ description: successful operation
859
+ headers: {}
860
+ content:
861
+ application/json:
862
+ schema: {}
863
+ '403':
864
+ description: operation failed
865
+ headers: {}
866
+ content:
867
+ application/json:
868
+ schema: {}
869
+ '404':
870
+ description: operation failed - task-id not found
871
+ headers: {}
872
+ content:
873
+ application/json:
874
+ schema: {}
875
+ '500':
876
+ description: unknown error
877
+ headers: {}
878
+ content:
879
+ application/json:
880
+ schema: {}
881
+ deprecated: false
882
+ /task-management/cancel-task/{task-execution-id}:
883
+ post:
884
+ tags:
885
+ - TaskManagement
886
+ summary: postTaskManagementCancelTask
887
+ description: Cancel running task
888
+ operationId: postTaskManagementCancelTask
889
+ parameters:
890
+ - name: task-execution-id
891
+ in: path
892
+ description: Task execution id
893
+ required: true
894
+ style: simple
895
+ schema:
896
+ type: string
897
+ example: {}
898
+ responses:
899
+ '200':
900
+ description: successful operation
901
+ headers: {}
902
+ content:
903
+ application/json:
904
+ schema: {}
905
+ '403':
906
+ description: operation failed
907
+ headers: {}
908
+ content:
909
+ application/json:
910
+ schema: {}
911
+ '404':
912
+ description: operation failed - task-id not found
913
+ headers: {}
914
+ content:
915
+ application/json:
916
+ schema: {}
917
+ '500':
918
+ description: unknown error
919
+ headers: {}
920
+ content:
921
+ application/json:
922
+ schema: {}
923
+ deprecated: false
924
+ /task-management/delete-task/{task-id}:
925
+ delete:
926
+ tags:
927
+ - TaskManagement
928
+ summary: taskManagementDeleteTask
929
+ description: Delete task by task id
930
+ operationId: taskManagementDeleteTask
931
+ parameters:
932
+ - name: task-id
933
+ in: path
934
+ description: Task id
935
+ required: true
936
+ style: simple
937
+ schema:
938
+ type: string
939
+ example: {}
940
+ responses:
941
+ '200':
942
+ description: successful operation
943
+ headers: {}
944
+ content:
945
+ application/json:
946
+ schema: {}
947
+ '403':
948
+ description: operation failed
949
+ headers: {}
950
+ content:
951
+ application/json:
952
+ schema: {}
953
+ '404':
954
+ description: operation failed - task-id not found
955
+ headers: {}
956
+ content:
957
+ application/json:
958
+ schema: {}
959
+ '500':
960
+ description: unknown error
961
+ headers: {}
962
+ content:
963
+ application/json:
964
+ schema: {}
965
+ deprecated: false
966
+ /services/monitoring/fault-management/alarms/{alarm-name}:
967
+ get:
968
+ tags:
969
+ - MonitoringFaultManagementAlarms
970
+ summary: getFaultManagementAlarmConfiguration
971
+ description: Get alarm configuration by alarm name.
972
+ operationId: getFaultManagementAlarmConfiguration
973
+ parameters:
974
+ - name: alarm-name
975
+ in: path
976
+ description: Alarm name
977
+ required: true
978
+ style: simple
979
+ schema:
980
+ type: string
981
+ example: {}
982
+ responses:
983
+ '200':
984
+ description: successful operation
985
+ headers: {}
986
+ content:
987
+ application/json:
988
+ schema: {}
989
+ '400':
990
+ description: operation failed
991
+ headers: {}
992
+ content:
993
+ application/json:
994
+ schema: {}
995
+ deprecated: false
996
+ /services/monitoring/fault-management/alarms/:
997
+ get:
998
+ tags:
999
+ - MonitoringFaultManagementAlarms
1000
+ summary: getAllFaultManagementAlarmConfiguration
1001
+ description: Get all alarms configuration.
1002
+ operationId: getAllFaultManagementAlarmConfiguration
1003
+ parameters: []
1004
+ responses:
1005
+ '200':
1006
+ description: successful operation
1007
+ headers: {}
1008
+ content:
1009
+ application/json:
1010
+ schema: {}
1011
+ '400':
1012
+ description: operation failed
1013
+ headers: {}
1014
+ content:
1015
+ application/json:
1016
+ schema: {}
1017
+ deprecated: false
1018
+ /services/monitoring/fault-management/active-alarms/:
1019
+ get:
1020
+ tags:
1021
+ - MonitoringFaultManagementActiveAlarms
1022
+ summary: getAllFaultManagementActiveAlarms
1023
+ description: Get all active alarms.
1024
+ operationId: getAllFaultManagementActiveAlarms
1025
+ parameters: []
1026
+ responses:
1027
+ '200':
1028
+ description: successful operation
1029
+ headers: {}
1030
+ content:
1031
+ application/json:
1032
+ schema: {}
1033
+ '400':
1034
+ description: operation failed
1035
+ headers: {}
1036
+ content:
1037
+ application/json:
1038
+ schema: {}
1039
+ deprecated: false
1040
+ components:
1041
+ schemas:
1042
+ RootType:
1043
+ title: RootType
1044
+ required:
1045
+ - Types
1046
+ type: object
1047
+ properties:
1048
+ Types:
1049
+ $ref: '#/components/schemas/Types2'
1050
+ xml:
1051
+ name: RootType
1052
+ prefix: ''
1053
+ attribute: false
1054
+ wrapped: false
1055
+ Types:
1056
+ title: Types
1057
+ required:
1058
+ - Default
1059
+ - Override
1060
+ type: object
1061
+ properties:
1062
+ Default:
1063
+ type: array
1064
+ items:
1065
+ $ref: '#/components/schemas/Default'
1066
+ description: ''
1067
+ xml:
1068
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1069
+ attribute: false
1070
+ wrapped: false
1071
+ example: <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml" />
1072
+ Override:
1073
+ type: array
1074
+ items:
1075
+ $ref: '#/components/schemas/Override'
1076
+ description: ''
1077
+ xml:
1078
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1079
+ attribute: false
1080
+ wrapped: false
1081
+ example: <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml" />
1082
+ xml:
1083
+ name: Types
1084
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1085
+ attribute: false
1086
+ wrapped: false
1087
+ Default:
1088
+ title: Default
1089
+ required:
1090
+ - Extension
1091
+ - ContentType
1092
+ type: object
1093
+ properties:
1094
+ Extension:
1095
+ type: string
1096
+ xml:
1097
+ name: Extension
1098
+ attribute: true
1099
+ wrapped: false
1100
+ example: <Extension>rels</Extension>
1101
+ ContentType:
1102
+ type: string
1103
+ xml:
1104
+ name: ContentType
1105
+ attribute: true
1106
+ wrapped: false
1107
+ example: <ContentType>application/vnd.openxmlformats-package.relationships+xml</ContentType>
1108
+ xml:
1109
+ name: Default
1110
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1111
+ attribute: false
1112
+ wrapped: false
1113
+ Override:
1114
+ title: Override
1115
+ required:
1116
+ - PartName
1117
+ - ContentType
1118
+ type: object
1119
+ properties:
1120
+ PartName:
1121
+ type: string
1122
+ xml:
1123
+ name: PartName
1124
+ attribute: true
1125
+ wrapped: false
1126
+ example: <PartName>/word/document.xml</PartName>
1127
+ ContentType:
1128
+ type: string
1129
+ xml:
1130
+ name: ContentType
1131
+ attribute: true
1132
+ wrapped: false
1133
+ example: <ContentType>application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml</ContentType>
1134
+ xml:
1135
+ name: Override
1136
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1137
+ attribute: false
1138
+ wrapped: false
1139
+ Types2:
1140
+ title: Types2
1141
+ required:
1142
+ - Default
1143
+ - Override
1144
+ type: object
1145
+ properties:
1146
+ Default:
1147
+ type: array
1148
+ items:
1149
+ $ref: '#/components/schemas/Default'
1150
+ description: ''
1151
+ xml:
1152
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1153
+ attribute: false
1154
+ wrapped: false
1155
+ example: <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml" />
1156
+ Override:
1157
+ type: array
1158
+ items:
1159
+ $ref: '#/components/schemas/Override'
1160
+ description: ''
1161
+ xml:
1162
+ namespace: http://schemas.openxmlformats.org/package/2006/content-types
1163
+ attribute: false
1164
+ wrapped: false
1165
+ example: <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml" />
1166
+ tags:
1167
+ - name: NCEManagement
1168
+ description: NCE Management
1169
+ - name: Redundancy
1170
+ description: Redundancy
1171
+ - name: NCEGroupManagement
1172
+ description: NCE Group Management
1173
+ - name: TaskManagement
1174
+ description: Task Management
1175
+ - name: MonitoringFaultManagementAlarms
1176
+ description: Monitoring Fault Management Alarms
1177
+ - name: MonitoringFaultManagementActiveAlarms
1178
+ description: ''
1179
+ externalDocs:
1180
+ description: Find out more about the OpenAPI Initiative
1181
+ url: https://www.openapis.org/