summaryrefslogtreecommitdiffstats
path: root/docs/ONAP Model Spec/im/NSD.rst
blob: 2d4469a3fe8d7142cb1d60483872f91d858856a4 (plain)
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
.. Copyright 2018 (China Mobile)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

.. contents::
   :depth: 3
..

|image0|

NetworkServiceDescriptorModel 
===============================


NetworkServiceDescriptor
------------------------

The NSD class is a deployment template whose instances are used by the
NFVO for the lifecycle management of NSs. For all attributes in this
class, the Producer is SDC and the Consumer is SDC/UUI/VFC

Applied stereotypes:

-  OpenModelClass

-  support: MANDATORY

-  Preliminaryry

+--------------------------+----------------------------+-------------+-------------------+----------------+
| **AttributeName**        | **Type**                   | **Mult.**   | **Stereotypes**   | **Description**|
|                          |                            |             |                   |                |
+==========================+============================+=============+===================+================+
| nsdIdentifier            | Identifier                 | 1           | Preliminary       | Identifier     |
|                          |                            |             |                   | of this NSD    |
|                          |                            |             | OpenModelAttribute| class. It      |
|                          |                            |             |                   | globally       |
|                          |                            |             |                   | uniquely       |
|                          |                            |             | -  isInvariant:   | identifies     |
|                          |                            |             |       true        | an instance    |
|                          |                            |             |                   | of the NSD.    |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| designer                 | String                     | 1           | Preliminary       | Identifies     |
|                          |                            |             |                   | the            |
|                          |                            |             | OpenModelAttribute| designer of    |
|                          |                            |             |                   | the NSD.       |
|                          |                            |             |                   |                |
|                          |                            |             | -  isInvariant:   |                |
|                          |                            |             |       false       |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| version                  | Version                    | 1           | Preliminary       | Identifies     |
|                          |                            |             |                   | the version    |
|                          |                            |             | OpenModelAttribute| of the NSD.    |
|                          |                            |             |                   |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  isInvariant:   |                |
|                          |                            |             |       false       |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| nsdName                  | String                     | 1           | Preliminary       | Provides       |
|                          |                            |             |                   | the human      |
|                          |                            |             | OpenModelAttribute| readable       |
|                          |                            |             |                   | name of the    |
|                          |                            |             |                   | NSD.           |
|                          |                            |             | -  isInvariant:   |                |
|                          |                            |             |       false       |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| nsdInvariantId           | Identifier                 | 1           | Preliminary       | Identifies     |
|                          |                            |             |                   | an NSD in a    |
|                          |                            |             | OpenModelAttribute| version        |
|                          |                            |             |                   | independent    |
|                          |                            |             |                   | manner.        |
|                          |                            |             | -  isInvariant:   | This           |
|                          |                            |             |      false        | attribute is   |
|                          |                            |             |                   | invariant      |
|                          |                            |             | -  valueRange:    | across         |
|                          |                            |             |       no          | versions of    |
|                          |                            |             |       range       | NSD.           |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| autoScalingRule          | Rule                       | 0..\*       | Preliminary       | Specifies a    |
|                          |                            |             |                   | rule to        |
|                          |                            |             | OpenModelAttribute| trigger a      |
|                          |                            |             |                   | scaling        |
|                          |                            |             |                   | action on a    |
|                          |                            |             | -  isInvariant:   | NS             |
|                          |                            |             |        false      | instantiated   |
|                          |                            |             |                   | according      |
|                          |                            |             | -  valueRange:    | to the NSD.    |
|                          |                            |             |       no          | NOTE 1: The    |
|                          |                            |             |       range       | rule is        |
|                          |                            |             |       constraint  | based on a     |
|                          |                            |             |                   | combination    |
|                          |                            |             |                   | of             |
|                          |                            |             |                   | assertions     |
|                          |                            |             | -  support:       | on the         |
|                          |                            |             |       MANDATORY   | values of      |
|                          |                            |             |                   | virtualised    |
|                          |                            |             |                   | resource-      |
|                          |                            |             |                   | related        |
|                          |                            |             |                   | performance    |
|                          |                            |             |                   | metrics and    |
|                          |                            |             |                   | VNF            |
|                          |                            |             |                   | Indicators     |
|                          |                            |             |                   | identified     |
|                          |                            |             |                   | by the         |
|                          |                            |             |                   | monitoredInfo  |
|                          |                            |             |                   | attribute.     |
|                          |                            |             |                   | NOTE 2:        |
|                          |                            |             |                   | There may      |
|                          |                            |             |                   | be multiple    |
|                          |                            |             |                   | data           |
|                          |                            |             |                   | sources        |
|                          |                            |             |                   | (each          |
|                          |                            |             |                   | identified     |
|                          |                            |             |                   | as             |
|                          |                            |             |                   | monitoredInfo) |
|                          |                            |             |                   | per rule       |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| monitoredInfo            | MonitoredData              | 0..\*       | Preliminary       | Identifies     |
|                          |                            |             |                   | either a       |
|                          |                            |             | OpenModelAttribute| virtualised    |
|                          |                            |             |                   | resource-      |
|                          |                            |             |                   | related        |
|                          |                            |             | -  isInvariant:   | performance    |
|                          |                            |             |       false       | metric or a    |
|                          |                            |             |                   | VNF            |
|                          |                            |             |                   | Indicator.     |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\*       | Preliminary       | Provides a     |
|                          |                            |             |                   | life cycle     |
|                          |                            |             | OpenModelAttribute| management     |
|                          |                            |             |                   | script         |
|                          |                            |             |                   | written in     |
|                          |                            |             | -  isInvariant:   | a Domain       |
|                          |                            |             |       false       | Specific       |
|                          |                            |             |                   | Language       |
|                          |                            |             | -  valueRange:    | (DSL).         |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| \_virtualLinkDesc        | NsVirtualLinkDesc          | 0..\*       | Preliminary       | Provides       |
|                          |                            |             |                   | the            |
|                          |                            |             | OpenModelAttribute| constituent    |
|                          |                            |             |                   | VLDs.          |
|                          |                            |             |                   | Cardinality    |
|                          |                            |             | -  isInvariant:   | of 0 means     |
|                          |                            |             |       false       | that the NS    |
|                          |                            |             |                   | is a NF set    |
|                          |                            |             |                   | with           |
|                          |                            |             | -  valueRange:    | unspecified    |
|                          |                            |             |       no          | connectivity.  |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| \_vnfdId                 | Vnfd                       | 0..\*       | Preliminary       | References     |
|                          |                            |             |                   | the VNFD of    |
|                          |                            |             | OpenModelAttribute| a              |
|                          |                            |             |                   | constituent    |
|                          |                            |             |                   | VNF.           |
|                          |                            |             | -  isInvariant:   |                |
|                          |                            |             |       false       |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
|                          |                            |             |                   |                |
|                          |                            |             | PassedByReference |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+
| \_pnfdId                 | Pnfd                       | 0..\*       | Experimental      | References     |
|                          |                            |             |                   | the PNFD of    |
|                          |                            |             |                   | a              |
|                          |                            |             | OpenModelAttribute| constituent    |
|                          |                            |             |                   | PNF.           |
|                          |                            |             |                   |                |
|                          |                            |             | -  isInvariant:   |                |
|                          |                            |             |       false       |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  valueRange:    |                |
|                          |                            |             |       no          |                |
|                          |                            |             |       range       |                |
|                          |                            |             |       constraint  |                |
|                          |                            |             |                   |                |
|                          |                            |             | -  support:       |                |
|                          |                            |             |       MANDATORY   |                |
|                          |                            |             |                   |                |
|                          |                            |             | PassedByReference |                |
+--------------------------+----------------------------+-------------+-------------------+----------------+

NsVirtualLinkDesc
-----------------

The NsVirtualLinkDesc class provides general information enabling the
instantiation of virtual links. For all attributes in this class the
Producer is SDC and the Consumer is SDC/UUI/VFC.

**Parent class:** VirtualLinkDesc

Applied stereotypes:

-  OpenModelClass

-  support: MANDATORY

-  Preliminaryry

+------------------------+-----------------+-------------+-------------------+----------------+
| **Attribute Name**     | **Type**        | **Mult.**   | **Stereotypes**   | **Description**|
+========================+=================+=============+===================+================+
| vitualLinkDescProvider | String          | 0..1        | Preliminary       | Defines the    |
|                        |                 |             |                   | organization   |
|                        |                 |             | OpenModelAttribute| generating     |
|                        |                 |             |                   | the VLD.       |
|                        |                 |             |                   |                |
|                        |                 |             | -  isInvariant:   |                |
|                        |                 |             |       false       |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  valueRange:    |                |
|                        |                 |             |       no          |                |
|                        |                 |             |       range       |                |
|                        |                 |             |       constraint  |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  support:       |                |
|                        |                 |             |       MANDATORY   |                |
+------------------------+-----------------+-------------+-------------------+----------------+
| virtuaLinkDescVersion  | Version         | 1           | Preliminary       | Specifies      |
|                        |                 |             |                   | the version    |
|                        |                 |             | OpenModelAttribute| of the VLD.    |
|                        |                 |             |                   |                |
|                        |                 |             | -  isInvariant:   |                |
|                        |                 |             |       false       |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  valueRange:    |                |
|                        |                 |             |       no          |                |
|                        |                 |             |       range       |                |
|                        |                 |             |       constraint  |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  support:       |                |
|                        |                 |             |       MANDATORY   |                |
+------------------------+-----------------+-------------+-------------------+----------------+
| VirtualLinkDf          | VirtualLinkDf   | 1           | Preliminary       | Specifies      |
|                        |                 |             |                   | properties     |
|                        |                 |             | OpenModelAttribute| for            |
|                        |                 |             |                   | instantiating  |
|                        |                 |             | -  isInvariant:   | a VL           |
|                        |                 |             |       false       | according      |
|                        |                 |             |                   | to a           |
|                        |                 |             |                   | specific       |
|                        |                 |             | -  valueRange:    | flavour.       |
|                        |                 |             |       no          |                |
|                        |                 |             |       range       |                |
|                        |                 |             |       constraint  |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  support:       |                |
|                        |                 |             |       MANDATORY   |                |
+------------------------+-----------------+-------------+-------------------+----------------+
| virtualLinkDescId      | Identifier      | 1           | Preliminary       | Uniquely       |
|                        |                 |             |                   | identifies     |
|                        |                 |             | OpenModelAttribute| a VLD in       |
|                        |                 |             |                   | the parent     |
|                        |                 |             |                   | descriptor.    |
|                        |                 |             | -  isInvariant:   | For            |
|                        |                 |             |       false       | VnfVirtualL    |
|                        |                 |             |                   | inkDesc,       |
|                        |                 |             |                   | the parent     |
|                        |                 |             |                   | descriptor     |
|                        |                 |             | -  valueRange:    | is the         |
|                        |                 |             |       no          | VNFD. For      |
|                        |                 |             |       range       | NsVirtualLi-   |
|                        |                 |             |       constraint  | nkDesc,        |
|                        |                 |             |                   | the parent     |
|                        |                 |             |                   | descriptor     |
|                        |                 |             | -  support:       | is the NSD.    |
|                        |                 |             |       MANDATORY   | Note: the      |
|                        |                 |             |                   | description    |
|                        |                 |             |                   | of this        |
|                        |                 |             |                   | class are      |
|                        |                 |             |                   | different      |
|                        |                 |             |                   | in ETSI GS     |
|                        |                 |             |                   | NFV IFA 011    |
|                        |                 |             |                   | and ETSI GS    |
|                        |                 |             |                   | NFV IFA        |
|                        |                 |             |                   | 014. The       |
|                        |                 |             |                   | present        |
|                        |                 |             |                   | definition     |
|                        |                 |             |                   | merges the 2   |
|                        |                 |             |                   | definitions.   |
+------------------------+-----------------+-------------+-------------------+----------------+
| connectivityType       | ConnectivityType| 1           | Preliminary       | Specifies      |
|                        |                 |             |                   | the            |
|                        |                 |             | OpenModelAttribute| protocol       |
|                        |                 |             |                   | exposed by     |
|                        |                 |             |                   | a VL and       |
|                        |                 |             | -  isInvariant:   | the flow       |
|                        |                 |             |       false       | pattern        |
|                        |                 |             |                   | supported      |
|                        |                 |             |                   | by the VL.     |
|                        |                 |             | -  valueRange:    |                |
|                        |                 |             |       no          |                |
|                        |                 |             |       range       |                |
|                        |                 |             |       constraint  |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  support:       |                |
|                        |                 |             |       MANDATORY   |                |
+------------------------+-----------------+-------------+-------------------+----------------+
| description            | String          | 0..1        | Preliminary       | Provides       |
|                        |                 |             |                   | human-readable |
|                        |                 |             | OpenModelAttribute| information    |
|                        |                 |             |                   | on the         |
|                        |                 |             | -  isInvariant:   | purpose of     |
|                        |                 |             |       false       | the VL         |
|                        |                 |             |                   | (e.g.          |
|                        |                 |             |                   | control        |
|                        |                 |             | -  valueRange:    | plane          |
|                        |                 |             |       no          | traffic).      |
|                        |                 |             |       range       |                |
|                        |                 |             |       constraint  |                |
|                        |                 |             |                   |                |
|                        |                 |             | -  support:       |                |
|                        |                 |             |       MANDATORY   |                |
+------------------------+-----------------+-------------+-------------------+----------------+

Pnfd
----

The Pnfd class is a deployment template enabling on-boarding PNFs and
referencing them from an NSD. It focuses on connectivity aspects only.

**Parent class:** NetworkFunctionDesc

Applied stereotypes:

-  OpenModelClass

-  support: MANDATORY

-  Experimental



Vnfd
----

The Vnfd class is a deployment template enabling on-boarding VNFs and
referencing them from an NSD. 


ConnectivityType
----------------

The ConnectivityType datatype specifies the protocol exposed by a VL and
the flow pattern supported by the VL.

+--------------+--------------+-----------+-----------+-------------------+----------------+
| **Attribute  | **Type**     | **Mult.** | **Access**| **Stereotypes**   | **Description**|
| Name**       |              |           |           |                   |                |
+==============+==============+===========+===========+===================+================+
| layerProtocol| LayerProtocol| 1         | RW        | Preliminary       | identifies     |
|              |              |           |           |                   | the            |
|              |              |           |           | OpenModelAttribute| protocol       |
|              |              |           |           |                   | this VL        |
|              |              |           |           |                   | gives          |
|              |              |           |           | -  isInvariant:   | access to      |
|              |              |           |           |       false       | (IPV4, IPV6).  |
|              |              |           |           |                   |                |
|              |              |           |           | -  valueRange:    |                |
|              |              |           |           |       no          |                |
|              |              |           |           |       range       |                |
|              |              |           |           |       constraint  |                |
|              |              |           |           |                   |                |
|              |              |           |           | -  support:       |                |
|              |              |           |           |       MANDATORY   |                |
+--------------+--------------+-----------+-----------+-------------------+----------------+
| flowPatternrn| String       | 0..1      | RW        | Preliminary       | Identifies     |
|              |              |           |           |                   | the flow       |
|              |              |           |           | OpenModelAttribute| pattern        |
|              |              |           |           |                   | of the         |
|              |              |           |           | -  isInvariant:   | connectivity   |
|              |              |           |           |       false       | (Line,         |
|              |              |           |           |                   | Tree,          |
|              |              |           |           |                   | Mesh).         |
|              |              |           |           | -  valueRange:    |                |
|              |              |           |           |       no          |                |
|              |              |           |           |       range       |                |
|              |              |           |           |       constraint  |                |
|              |              |           |           |                   |                |
|              |              |           |           | -  support:       |                |
|              |              |           |           |       MANDATORY   |                |
+--------------+--------------+-----------+-----------+-------------------+----------------+

MonitoredData(TBD)
------------------

The MonitoredData datatype identifies information to be monitored during
the lifetime of a network service instance.

NsLifeCycleManagementScript
---------------------------

The LifeCycleManagementScript information element specifies a script for
the NS.

+-------------+-----------+-----------+-----------+-------------------+----------------+
| **Attribute | **Type**  | **Mult.** | **Access**| **Stereotypes**   | **Description**|
| Name**      |           |           |           |                   |                |
+=============+===========+===========+===========+===================+================+
| event       | String    | 1..\*     | RW        | OpenModelAttribute| Describes  NS  |
|             |           |           |           |                   | lifecycle      |
|             |           |           |           | -  isInvarriant:  | event(s)       |
|             |           |           |           |       false       | or an          |
|             |           |           |           |                   | external       |
|             |           |           |           |                   | stimulus       |
|             |           |           |           |                   | detected       |
|             |           |           |           |                   | on an          |
|             |           |           |           | -  valueRange:    | NFVO           |
|             |           |           |           |       no          | reference      |
|             |           |           |           |       range       | point.         |
|             |           |           |           |       constraint  | NOTE 1: A      |
|             |           |           |           |                   | minimum        |
|             |           |           |           |                   | set of NS      |
|             |           |           |           |                   | lifecycle      |
|             |           |           |           | -  support:       | events         |
|             |           |           |           |                   | triggered      |
|             |           |           |           |       MANDATORY   | internally     |
|             |           |           |           |                   | by the NFVO    |
|             |           |           |           |                   | includes:      |
|             |           |           |           |                   | start          |
|             |           |           |           |                   | instantiation, |
|             |           |           |           |                   | end            |
|             |           |           |           |                   | instantiation, |
|             |           |           |           |                   | start          |
|             |           |           |           |                   | scaling,       |
|             |           |           |           |                   | end            |
|             |           |           |           |                   | scaling,       |
|             |           |           |           |                   | start          |
|             |           |           |           |                   | healing,       |
|             |           |           |           |                   | end            |
|             |           |           |           |                   | healing,       |
|             |           |           |           |                   | start          |
|             |           |           |           |                   | termination,   |
|             |           |           |           |                   | end            |
|             |           |           |           |                   | termination,   |
|             |           |           |           |                   | start          |
|             |           |           |           |                   | update,        |
|             |           |           |           |                   | end            |
|             |           |           |           |                   | update.        |
|             |           |           |           |                   | NOTE 2: A      |
|             |           |           |           |                   | minimum        |
|             |           |           |           |                   | set of         |
|             |           |           |           |                   | external       |
|             |           |           |           |                   | stimulus       |
|             |           |           |           |                   | includes:      |
|             |           |           |           |                   | the            |
|             |           |           |           |                   | receipt        |
|             |           |           |           |                   | of             |
|             |           |           |           |                   | request        |
|             |           |           |           |                   | message        |
|             |           |           |           |                   | of             |
|             |           |           |           |                   | instantiation, |
|             |           |           |           |                   | scaling,       |
|             |           |           |           |                   | healing,       |
|             |           |           |           |                   | termination,   |
|             |           |           |           |                   | update of NS.  |
+-------------+-----------+-----------+-----------+-------------------+----------------+
| script      | String    | 1         | RW        | OpenModelAttribute| Includes       |
|             |           |           |           |                   | an NS LCM      |
|             |           |           |           |                   | script         |
|             |           |           |           | -  isInvarriant:  | (e.g.,         |
|             |           |           |           |       false       | written        |
|             |           |           |           |                   | in a DSL)      |
|             |           |           |           |                   | triggered      |
|             |           |           |           |                   | to react       |
|             |           |           |           | -  valueRange:    | to one of the  |
|             |           |           |           |       no          | events         |
|             |           |           |           |       range       | listed in      |
|             |           |           |           |       constraint  | the event      |
|             |           |           |           |                   | attribute.     |
|             |           |           |           | -  support:       |                |
|             |           |           |           |       MANDATORY   |                |
+-------------+-----------+-----------+-----------+-------------------+----------------+

NsQoS
-----

The NsQoS datatype specifies quality of service parameters applicable to
a NS VL.

+---------------------+-----------+-----------+-----------+-------------------+----------------+
| **Attribute Name**  | **Type**  | **Mult.** | **Access**|**Stereotypes**    | **Description**|
+=====================+===========+===========+===========+===================+================+
| priority            | Integer   | 0..1      | RW        | Preliminary       | Specifies      |
|                     |           |           |           |                   | the            |
|                     |           |           |           |                   | priority       |
|                     |           |           |           | OpenModelAttribute| level in       |
|                     |           |           |           |                   | case of        |
|                     |           |           |           |                   | congestion     |
|                     |           |           |           | -  isInvariant:   | on the         |
|                     |           |           |           |       false       | underlying     |
|                     |           |           |           |                   | physical       |
|                     |           |           |           | -  valueRange:    | links.         |
|                     |           |           |           |       no          |                |
|                     |           |           |           |       range       |                |
|                     |           |           |           |       constraint  |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  support:       |                |
|                     |           |           |           |       MANDATORY   |                |
+---------------------+-----------+-----------+-----------+-------------------+----------------+
| latency             | Number    | 1         | RW        | Preliminary       | Maximum        |
|                     |           |           |           |                   | latency        |
|                     |           |           |           |                   | in ms.         |
|                     |           |           |           | OpenModelAttribute|                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  isInvariant:   |                |
|                     |           |           |           |       false       |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  valueRange:    |                |
|                     |           |           |           |       no          |                |
|                     |           |           |           |       range       |                |
|                     |           |           |           |       constraint  |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  support:       |                |
|                     |           |           |           |       MANDATORY   |                |
+---------------------+-----------+-----------+-----------+-------------------+----------------+
| packetDelayVariation| Number    | 1         | RW        | Preliminary       | Maximum        |
|                     |           |           |           |                   | jitter in      |
|                     |           |           |           |                   | ms.            |
|                     |           |           |           | OpenModelAttribute|                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  isInvariant:   |                |
|                     |           |           |           |       false       |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  valueRange:    |                |
|                     |           |           |           |       no          |                |
|                     |           |           |           |       range       |                |
|                     |           |           |           |       constraint  |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  support:       |                |
|                     |           |           |           |       MANDATORY   |                |
+---------------------+-----------+-----------+-----------+-------------------+----------------+
| packetLossRatio     | Number    | 0..1      | RW        | Preliminary       | Maximum        |
|                     |           |           |           |                   | packet         |
|                     |           |           |           |                   | loss           |
|                     |           |           |           | OpenModelAttribute| ratio.         |
|                     |           |           |           |                   | Cardinality    |
|                     |           |           |           | -  isInvariant:   | is 0 if        |
|                     |           |           |           |       false       | no             |
|                     |           |           |           |                   | packetLossRatio|
|                     |           |           |           |                   | requirement    |
|                     |           |           |           | -  valueRange:    | exists.        |
|                     |           |           |           |       no          |                |
|                     |           |           |           |       range       |                |
|                     |           |           |           |       constraint  |                |
|                     |           |           |           |                   |                |
|                     |           |           |           | -  support:       |                |
|                     |           |           |           |       MANDATORY   |                |
+---------------------+-----------+-----------+-----------+-------------------+----------------+

VirtualLinkDf
-------------

The VirtualLinkDf datatype specifies properties for instantiating a VL
according to a specific flavour.

+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
| **Attribute Name**    | **Type**                 | **Mult.** | **Access**|**Stereotypes**    | **Description**|
+=======================+==========================+===========+===========+===================+================+
| flavourId             | Identifier               | 1         | RW        | Preliminary       | Identifies     |
|                       |                          |           |           |                   | this           |
|                       |                          |           |           | OpenModelAttribute| VirtualLinkDF  |
|                       |                          |           |           |                   | datatype       |
|                       |                          |           |           | -  isInvariant:   | within a       |
|                       |                          |           |           |       false       | VLD.           |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  valueRange:    |                |
|                       |                          |           |           |       no          |                |
|                       |                          |           |           |       range       |                |
|                       |                          |           |           |       constraint  |                |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  support:       |                |
|                       |                          |           |           |       MANDATORY   |                |
+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
| qos                   | NsQoS                    | 0..1      | RW        | Preliminary       | Specifies      |
|                       |                          |           |           |                   | quality        |
|                       |                          |           |           |                   | of             |
|                       |                          |           |           | OpenModelAttribute| service        |
|                       |                          |           |           |                   | parameters     |
|                       |                          |           |           | -  isInvariant:   | applicable     |
|                       |                          |           |           |       false       | to a VL.       |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  valueRange:    |                |
|                       |                          |           |           |       no          |                |
|                       |                          |           |           |       range       |                |
|                       |                          |           |           |       constraint  |                |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  support:       |                |
|                       |                          |           |           |       MANDATORY   |                |
+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1      | RW        | Preliminary       | Specifies      |
|                       |                          |           |           |                   | one of         |
|                       |                          |           |           |                   | the three      |
|                       |                          |           |           | OpenModelAttribute| levels         |
|                       |                          |           |           |                   | defined        |
|                       |                          |           |           |                   | in ETSI        |
|                       |                          |           |           | -  isInvariant:   | GS NFV-REL     |
|                       |                          |           |           |       false       | 001:           |
|                       |                          |           |           |                   |                |
|                       |                          |           |           |                   | - Level1       |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  valueRange:    | - Level2       |
|                       |                          |           |           |       no          |                |
|                       |                          |           |           |       range       | - Level3       |
|                       |                          |           |           |       constraint  |                |
|                       |                          |           |           |                   |                |
|                       |                          |           |           | -  support:       |                |
|                       |                          |           |           |       MANDATORY   |                |
+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+



ServiceAvailabilityLevel
------------------------

Specifies one of the three levels defined in ETSI GS NFV-REL 001: 
Level 1  Level 2  Level 3

Contains Enumeration Literals:

-  LEVEL_1:

-  LEVEL_2:

-  LEVEL_3:

.. |image0| image:: NSD1.PNG