docs/ONAP Model Spec/im/PNF/PNFD.rst


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

.. 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

PnfdModel 
~~~~~~~~~

Classes
-------

Pnf
~~~

An implementation of a NF via a tightly coupled software and hardware system.

**Parent class:** NetworkFunction

Applied stereotypes:

-  Future

-  OpenModelClass

-  **support: MANDATORY**

================== ======== ========= ================================== ============================================
**Attribute Name** **Type** **Mult.** **Stereotypes**                    **Description**
================== ======== ========= ================================== ============================================
\_pnfExtCp         PnfExtCp 1..\*     OpenModelAttribute                 External CP of the PNF.
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
id                 String   1         Experimental                       Identifier of the network function
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
name               String   0..1      Experimental                      
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
type               String   1         Experimental                       Description of the type of network function
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
description        String   0..1      Experimental                       Description of the network function
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
role               String   1         Experimental                       Role the network function will be providing.
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
================== ======== ========= ================================== ============================================

PnfExtCp
~~~~~~~~

External CP of the PNF.

**Parent class:** Cp

Applied stereotypes:

-  Future

-  OpenModelClass

-  **support: MANDATORY**

================== ============= ========= ================================== ========================================================================================================================================================================
**Attribute Name** **Type**      **Mult.** **Stereotypes**                    **Description**
================== ============= ========= ================================== ========================================================================================================================================================================
cpd                invalid       1         OpenModelAttribute                 Cpd used to deploy this PNF CP.
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpId               Identifier    1         OpenModelAttribute                 Identifier of the connection point instance.
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpName             String        1         OpenModelAttribute                 Name of the Cp instance.
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpNameAlt          String        1         OpenModelAttribute                 alternative name of the Cp instance.
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpType             String        1         OpenModelAttribute                 Generic description of the type of Cp
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpRole             String        1         OpenModelAttribute                 Role in the network this Cp will be providing
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpFunction         String        1         OpenModelAttribute                 English description of the function this specific Cp will be providing
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpDescription      String        1         OpenModelAttribute                 Cp description
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
cpBandwidth        String        1         OpenModelAttribute                 Cp assigned (actual) bandwidth
                                                                             
                                           -  isInvariant: false              Cp (max? assigned?) bandwidth
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
provStatus         String        1         OpenModelAttribute                 provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
adminsStatus       String        1         OpenModelAttribute                 Administrative status of the connection point.
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
protocol           String        1         OpenModelAttribute                 Protocol used by the Cp
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
trunkMode          Boolean       1         OpenModelAttribute                 Indicator whether the Cp is in trunk mode
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
addressType        String        1         OpenModelAttribute                 Type of address: MAC address or IP address
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
L2addressData      L2AddressData 0..1      OpenModelAttribute                 Only present when addressType is MAC address
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
L3addressData      L3AddressData 0..1      OpenModelAttribute                 Only present when addressType is IP address
                                                                             
                                           -  isInvariant: false             
                                                                             
                                           -  valueRange: no range constraint
                                                                             
                                           -  support: MANDATORY             
================== ============= ========= ================================== ========================================================================================================================================================================

PnfExtCpd
~~~~~~~~~

A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL.

**Parent class:** ExtCpd

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

PnfProfile
~~~~~~~~~~

The PnfProfile class describes additional data for a given PNF instance used in a DF.

Applied stereotypes:

-  Future

-  OpenModelClass

-  **support: MANDATORY**

========================== ========================= ========= ================================== ========================================================================================================================================
**Attribute Name**         **Type**                  **Mult.** **Stereotypes**                    **Description**
========================== ========================= ========= ================================== ========================================================================================================================================
pnfProfileId               Identifier                1         OpenModelAttribute                 Identifier of this PnfProfile class. It uniquely identifies a PnfProfile.
                                                                                                 
                                                               -  isInvariant: false             
                                                                                                 
                                                               -  valueRange: no range constraint
                                                                                                 
                                                               -  support: MANDATORY             
pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\*     OpenModelAttribute                 Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link.
                                                                                                 
                                                               -  isInvariant: false             
                                                                                                 
                                                               -  valueRange: no 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**

-  Preliminary

=================== ================== ========= ================================== ====================================================================================================================
**Attribute Name**  **Type**           **Mult.** **Stereotypes**                    **Description**
=================== ================== ========= ================================== ====================================================================================================================
pnfdId              Identifier         1         OpenModelAttribute                 Identifier of this Pnfd class. It uniquely identifies the PNFD.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
provider            String             1         OpenModelAttribute                 Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
version             Version            1         OpenModelAttribute                 Identifies the version of the PNFD
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
security            SecurityParameters 0..1      OpenModelAttribute                 Provides a signature to prevent tampering.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
functionDescription String             1         OpenModelAttribute                 Describes the PNF function.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
pnfdInvariantId     Identifier         1         OpenModelAttribute                 Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD.
                                                                                   
                                                 -  isInvariant: true              
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
name                String             1         OpenModelAttribute                 Provides the human readable name of the PNFD.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
                                                                                   
                                                 Preliminary                       
\_pnfExtCpd         PnfExtCpd          1..\*     OpenModelAttribute                 Specifies the characteristics of one or more connection points where to connect the PNF to a VL.
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
=================== ================== ========= ================================== ====================================================================================================================

Data Types
----------

SwVersion
~~~~~~~~~

The software versions associated with the pnfd

Applied stereotypes:

-  Future

================== ======== ========= ========== ================================== =====================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes**                    **Description**
================== ======== ========= ========== ================================== =====================
active             String   1         RW         OpenModelAttribute                 The active software
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
passive            String   0..\*     RW         OpenModelAttribute                 The passive software
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
recovery           String   0..\*     RW         OpenModelAttribute                 The recovery software
                                                                                   
                                                 -  isInvariant: false             
                                                                                   
                                                 -  valueRange: no range constraint
                                                                                   
                                                 -  support: MANDATORY             
================== ======== ========= ========== ================================== =====================