summaryrefslogtreecommitdiffstats
path: root/docs/ONAP Model Spec/im/Root/Root.rst
blob: ddda9414cfff821e4d67f1b0299b1744e6a87b38 (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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
.. Copyright 2019
.. 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

Root Model
==========

.. contents::
   :depth: 3
..

Overview
--------

**Qualified Name:** Common::Root

**Description:**

A set of common business entities that collectively serve as the foundation of the ONAP Information Model. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence.

Class Definition
----------------

DesignEntity class
^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::DesignEntity

**Description:**

A template which describes an OperationalEntity in terms of deployment and operational behavior requirements.

This class is abstract.

**Parent class:** Entity

**Applied Stereotypes:**

-  OpenModelClass

-  support: MANDATORY

-  Preliminary

**Table** **Attributes for class DesignEntity**

================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
**Attribute Name** **Type**   **Mult.** **Description**                                                                                                                                                                                                                                                                                                                                                        **Stereotypes**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
validFor           TimePeriod 1         The period during which the design entity is valid.                                                                                                                                                                                                                                                                                                                    OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
status             String     1         The condition of the specification, such s active, inactive, or planned.                                                                                                                                                                                                                                                                                               OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
name               String     1         Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
description        String     1         Defines a textual free-form description of the object.                                                                                                                                                                                                                                                                                                                 OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
id                 Identifier 1         Unambiguously distinguishes different object instances. It is the naming attribute of the object.                                                                                                                                                                                                                                                                      OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                        Identifier of this information element. This attribute shall be globally unique.                                                                                                                                                                                                                                                                                       -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================

Domain class
^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::Domain

**Description:**

Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain

**Parent class:** RootEntity

**Applied Stereotypes:**

-  Experimental

-  OpenModelClass

-  support: MANDATORY

Entity class
^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::Entity

**Description:**

This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment.

This class is abstract.

**Parent class:** RootEntity

**Applied Stereotypes:**

-  OpenModelClass

-  support: MANDATORY

-  Preliminary

ManagedEntity class
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::ManagedEntity

**Description:**

A ManagedEntity is used to specify that an Entity is manageable by electronic means.

**Applied Stereotypes:**

-  Experimental

-  OpenModelClass

-  support: MANDATORY

**Table** **Attributes for class ManagedEntity**

========================= ======== ========= ================================================================================================================= =====================
**Attribute Name**        **Type** **Mult.** **Description**                                                                                                   **Stereotypes**
========================= ======== ========= ================================================================================================================= =====================
managementMethodCurrent   Integer  1         This is an enumerated integer that defines the particular type of management method that is currently being used. OpenModelAttribute
                                             Permitted Values:                                                                                                
                                             0: Unknown                                                                                                        -  partOfObjectKey: 0
                                             1: None                                                                                                          
                                             2: CLI                                                                                                            -  uniqueSet:
                                             3: SNMP                                                                                                          
                                             4: TL1                                                                                                            -  isInvariant: false
                                             5: CMIP                                                                                                          
                                             6: Proprietary                                                                                                    -  unsigned: false
                                                                                                                                                              
                                                                                                                                                               -  counter: NA
                                                                                                                                                              
                                                                                                                                                               -  support: MANDATORY
managementMethodSupported Integer  1..\*     This is an array of integers that define the different management methods that are supported by this object.      OpenModelAttribute
                                             Permitted Values:                                                                                                
                                             0: Unknown                                                                                                        -  partOfObjectKey: 0
                                             1: None                                                                                                          
                                             2: CLI                                                                                                            -  uniqueSet:
                                             3: SNMP                                                                                                          
                                             4: TL1                                                                                                            -  isInvariant: false
                                             5: CMIP                                                                                                          
                                             6: Proprietary                                                                                                    -  unsigned: false
                                                                                                                                                              
                                                                                                                                                               -  counter: NA
                                                                                                                                                              
                                                                                                                                                               -  support: MANDATORY
========================= ======== ========= ================================================================================================================= =====================

OperationalEntity class
^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::OperationalEntity

**Description:**

An OperationalEntity is a deployment in a NFV environment of a DesignEntity.

This class is abstract.

**Parent class:** Entity

**Applied Stereotypes:**

-  OpenModelClass

-  support: MANDATORY

-  Preliminary

RootEntity class
^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootObjectClasses::RootEntity

**Description:**

This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.

This class is abstract.

**Applied Stereotypes:**

-  OpenModelClass

-  support: MANDATORY

-  Preliminary

**Table** **Attributes for class RootEntity**

================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
**Attribute Name** **Type**   **Mult.** **Description**                                                                                                                                                                                                                                                                                                                                                        **Stereotypes**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
name               String     0..1      Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
description        String     0..1      Defines a textual free-form description of the object.                                                                                                                                                                                                                                                                                                                 OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
id                 Identifier 1         Unambiguously distinguishes different object instances. It is the naming attribute of the object.                                                                                                                                                                                                                                                                      OpenModelAttribute
                                                                                                                                                                                                                                                                                                                                                                                                              
                                        Identifier of this information element. This attribute shall be globally unique.                                                                                                                                                                                                                                                                                       -  partOfObjectKey: 0
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  uniqueSet:
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  isInvariant: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  unsigned: false
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  counter: NA
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               -  support: MANDATORY
                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                               Preliminary
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================

Enumeration definition
----------------------

CompositeOperator enumeration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootTypeDefinitons::CompositeOperator

**Description:**

The operator being applied to to some group of selectoin critiera.

**Applied Stereotypes:**

-  Preliminary

**Contains Enumeration Literals:**

-  AND

-  OR

-  XOR

Operator enumeration
^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootTypeDefinitons::Operator

**Description:**

The operator being applied to some atomic selection critera.

**Applied Stereotypes:**

-  Preliminary

**Contains Enumeration Literals:**

-  MORETHAN

-  LESSTHAN

-  EQUAL

Priority enumeration
^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Priority

**Description:**

priority - processing priority.

**Applied Stereotypes:**

-  Preliminary

**Contains Enumeration Literals:**

-  HIGH

-  MEDIUM

-  NORMAL

-  LOW

RuleScope enumeration
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::RuleScope

**Description:**

Defines the scope of the rule.

**Applied Stereotypes:**

-  Preliminary

**Contains Enumeration Literals:**

-  NFVI_POP

-  ZONE

-  ZONE_GROUP

-  NFVI_NODE

RuleType enumeration
^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::RuleType

**Description:**

Specifies the type of rule.

**Applied Stereotypes:**

-  Preliminary

**Contains Enumeration Literals:**

-  AFFINITY

-  ANTI_AFFINITY

Datatype definition
-------------------

ConfigurableProperties datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::Root::RootTypeDefinitons:: ConfigurableProperties

**Description:**

Dynamic, configurable properites of some entity.

**Applied Stereotypes:**

-  Experimental

**Table** **Attributes for Data Type ConfigurableProperties**

================== ============ ========= ==================================================== ==================================
**Attribute Name** **Type**     **Mult.** **Description**                                      **Stereotypes**
================== ============ ========= ==================================================== ==================================
properties         KeyValuePair 0..\*     The specific configurable properties of some entity. Experimental
                                                                                              
                                                                                               OpenModelAttribute
                                                                                              
                                                                                               -  isInvariant: false
                                                                                              
                                                                                               -  valueRange: no range constraint
                                                                                              
                                                                                               -  support: MANDATORY
================== ============ ========= ==================================================== ==================================

DateTime primitive type
^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::DateTime

**Description:**

DateTime - RFC 2822 standard date/time format.

RFC 2822 format

day-of-week, dd MM yyyy HH':'mm':'ss 'GMT'

e.g. Tue, 21 Jun 2016 14:05:20 GMT

File primitive type
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::File

**Description:**

A primitive Type

**Applied Stereotypes:**

-  Experimental

Identifier datatype
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Identifier

**Applied Stereotypes:**

-  Preliminary

Key datatype
^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Key

**Description:**

key - the key datatype is a tuple which provides the name of a key along with its value and relative order.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type Key**

================== ======== ========= ============================================================================== ==================================
**Attribute Name** **Type** **Mult.** **Description**                                                                **Stereotypes**
================== ======== ========= ============================================================================== ==================================
keyName            String   1         keyName - Name of the key.                                                     OpenModelAttribute
                                                                                                                    
                                                                                                                     -  isInvariant: false
                                                                                                                    
                                                                                                                     -  valueRange: no range constraint
                                                                                                                    
                                                                                                                     -  support: MANDATORY
keyOrder           Integer  0..1      keyOrder - Relative sequence or order of the key (with respect to other keys). OpenModelAttribute
                                                                                                                    
                                                                                                                     -  isInvariant: false
                                                                                                                    
                                                                                                                     -  valueRange: no range constraint
                                                                                                                    
                                                                                                                     -  support: MANDATORY
keyValue           String   0..1      keyValue - Value of the key.                                                   OpenModelAttribute
                                                                                                                    
                                                                                                                     -  isInvariant: false
                                                                                                                    
                                                                                                                     -  valueRange: no range constraint
                                                                                                                    
                                                                                                                     -  support: MANDATORY
================== ======== ========= ============================================================================== ==================================

KeyValuePair datatype
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::KeyValuePair

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type KeyValuePair**

================== ======== ========= =============== ==================================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ======== ========= =============== ==================================
key                String   1                         OpenModelAttribute
                                                     
                                                      -  isInvariant: false
                                                     
                                                      -  valueRange: no range constraint
                                                     
                                                      -  support: MANDATORY
value              String   1                         OpenModelAttribute
                                                     
                                                      -  isInvariant: false
                                                     
                                                      -  valueRange: no range constraint
                                                     
                                                      -  support: MANDATORY
================== ======== ========= =============== ==================================

Number primitive type
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Number

**Description:**

This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real.

**Applied Stereotypes:**

-  Preliminary

Object primitive type
^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Object

**Description:**

object - objects are model elements that represent instances of a class or of classes

**Applied Stereotypes:**

-  Preliminary

Rule primitive type
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Rule

**Description:**

Primitive type describing a rule.

**Applied Stereotypes:**

-  Preliminary

SecurityParameters datatype
^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::SecurityParameters

**Description:**

The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature.

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type SecurityParameters**

================== ======== ========= ========================================================================================================= ==================================
**Attribute Name** **Type** **Mult.** **Description**                                                                                           **Stereotypes**
================== ======== ========= ========================================================================================================= ==================================
signature          String   1         Provides the signature of the signed part of the descriptor.                                              OpenModelAttribute
                                                                                                                                               
                                                                                                                                                -  isInvariant: false
                                                                                                                                               
                                                                                                                                                -  valueRange: no range constraint
                                                                                                                                               
                                                                                                                                                -  support: MANDATORY
algorithm          String   1         Identifies the algorithm used to compute the signature.                                                   OpenModelAttribute
                                                                                                                                               
                                                                                                                                                -  isInvariant: false
                                                                                                                                               
                                                                                                                                                -  valueRange: no range constraint
                                                                                                                                               
                                                                                                                                                -  support: MANDATORY
certificate                 0..1      Provides a certificate or a reference to a certificate to validate the signature.                         OpenModelAttribute
                                      NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD
                                                                                                                                                -  isInvariant: false
                                                                                                                                               
                                                                                                                                                -  valueRange: no range constraint
                                                                                                                                               
                                                                                                                                                -  support: MANDATORY
================== ======== ========= ========================================================================================================= ==================================

TimePeriod datatype
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::TimePeriod

**Description:**

A base / value business entity used to represent a period of time, between two timepoints

**Applied Stereotypes:**

-  Preliminary

**Table** **Attributes for Data Type TimePeriod**

================== ======== ========= ================================================= ==================================
**Attribute Name** **Type** **Mult.** **Description**                                   **Stereotypes**
================== ======== ========= ================================================= ==================================
startDateTime      DateTime 1         An instant of time, starting at the TimePeriod    OpenModelAttribute
                                      Notes:                                           
                                      If null, then represents to the beginning of time -  isInvariant: false
                                                                                       
                                                                                        -  valueRange: no range constraint
                                                                                       
                                                                                        -  support: MANDATORY
endDateTime        DateTime 1         An instant of time, ending at the TimePeriod:     OpenModelAttribute
                                      Notes:                                           
                                      If null, then represents to the end of time       -  isInvariant: false
                                                                                       
                                                                                        -  valueRange: no range constraint
                                                                                       
                                                                                        -  support: MANDATORY
================== ======== ========= ================================================= ==================================

UnixEpoch primitive type
^^^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::UnixEpoch

**Description:**

the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds

Uri primitive type
^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Uri

**Description:**

type string;

The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66.

Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1.

The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent.

Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate.

A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required.

In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017.

reference

RFC 3986: Uniform Resource Identifier (URI): Generic Syntax

RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations

RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs);

**Applied Stereotypes:**

-  Preliminary

Uuid primitive type
^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Uuid

**Description:**

type string {

pattern

'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; }

A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters.

The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6;

reference

RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace;

**Applied Stereotypes:**

-  Preliminary

Version primitive type
^^^^^^^^^^^^^^^^^^^^^^

**Qualified Name:** Common::TypeDefinitions::Version

**Description:**

This primitive type defines the version of an element.

**Applied Stereotypes:**

-  Preliminary