SOL005NSDescriptorManagement_def.yaml 19.8 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
3

4
definitions:
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
  NsdInfoModifications:
    type: object
    description: >
      This type represents attribute modifications for an individual NS
      descriptor resource based on the NsdInfo data type. The attributes of
      NsdInfo that can be modified are included in the NsdInfoModifications
      data type.NOTE: At least one of the attributes - nsdOperationalState and
      userDefinedData - shall be present.
    properties:
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      userDefinedData:
        description: >
          Modifications of the userDefinedData attribute in NsdInfo
          data type. See note. If present, these modifications shall be applied
          according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
          NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

26
  NsdInfo:
27
    type: object
28
    required:
29
30
31
32
      - id
      - nsdOnboardingState
      - nsdOperationalState
      - nsdUsageState
33
      - _links
34
35
36
37
38
    properties:
      id:
        description: >
          Identifier of the on boarded individual NS descriptor
          resource. This identifier is allocated by the NFVO.
39
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
40
41
42
43
44
45
      nsdId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies the NSD in a globally unique
          way. It is copied from the NSD content and shall be
          present after the NSD content is on-boarded.
46
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
47
      nsdName:
48
        type: string
49
        description: >
50
51
          Name of the on boarded NSD. This information is copied from the
          NSD content and shall be present after the NSD content is on-boarded.
52
53
54
55
56
      nsdVersion:
        description: >
          Version of the on-boarded NSD. This information is
          copied from the NSD content and shall be present
          after the NSD content is on-boarded.
57
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
58
      nsdDesigner:
59
        type: string
60
        description: >
61
62
          Designer of the on-boarded NSD. This information is copied
          from the NSD content and shall be present after the NSD content is on-boarded.
63
64
65
66
67
68
69
      nsdInvariantId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies an NSD in a version independent
          manner. This information is copied from the NSD
          content and shall be present after the NSD content is
          on-boarded.
70
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
71
72
73
74
75
76
      vnfPkgIds:
        description: >
          Identifies the VNF package for the VNFD referenced
          by the on-boarded NS descriptor resource.
        type: array
        items:
77
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
78
79
80
81
82
83
84
      pnfdInfoIds:
        description: >
          Identifies the PnfdInfo element for the PNFD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
85
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
86
87
88
89
90
91
92
      nestedNsdInfoIds:
        description: >
          Identifies the NsdInfo element for the nested NSD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
93
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
94
95
96
97
98
99
100
      nsdOnboardingState:
        description: >
          On boarding state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on boarding procedure. See
101
          clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
102
103
104
105
          structure.
          It shall be present when the "nsdOnboardingState"
          attribute is CREATED and the uploading or
          processing fails in NFVO.
106
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
      nsdOperationalState:
        description: >
          Operational state of the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
        $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Usage state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
122
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
123
      _links:
124
        type: object
125
        required:
126
127
          - self
          - nsd_content
128
        description: >
129
          Links to resources related to this resource.
130
131
132
        properties:
          self:
            description: >
133
              URI of this resource.
134
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
135
136
          nsd_content:
            description: >
137
              Link to the NSD content resource.
138
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
139
    description: >
140
      This type represents a response for the query NSD operation.
141
142

  CreateNsdInfoRequest:
143
    type: object
144
145
    properties:
      userDefinedData:
146
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
147
    description: >
148
149
      This type creates a completely new NS descriptor resource.

150
  PnfdInfoModifications:
151
    type: object
152
    required:
153
      - userDefinedData
154
155
    properties:
      userDefinedData:
156
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
157
    description: >
158
      This type represents attribute modifications for an individual PNF
159
160
      descriptor resource based on the "PnfdInfo" data type. The attributes of
      "PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
161
      data type.
162

163
  PnfdInfo:
164
    type: object
165
    required:
166
167
168
169
      - id
      - pnfdOnboardingState
      - pnfdUsageState
      - _links
170
171
172
173
174
175
    properties:
      id:
        description: >
          Identifier of the on-boarded individual PNF
          descriptor resource. This identifier is allocated by
          the NFVO.
176
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
177
178
179
180
181
182
      pnfdId:
        description: >
          This identifier, which is managed by the PNFD
          designer, identifies the PNFD in a globally unique way.
          It is copied from the PNFD content and shall
          be present after the PNFD content is on-boarded.
183
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
184
185
186
187
188
      pnfdName:
        description: >
          Name of the on-boarded PNFD. This information
          is copied from the PNFD content and shall be
          present after the PNFD content is on-boarded.
189
        type: string
190
      pnfdersion:
191
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
192
193
      pnfdProvider:
        description: >
194
195
          Provider of the on-boarded PNFD. This information is copied from
          the PNFD content and shall be present after the PNFD content is on-boarded.
196
        type: string
197
198
199
200
201
      pnfdInvariantId:
        description: >
          Identifies a PNFD in a version independent
          manner. This attribute is invariant across versions
          of PNFD.
202
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
203
204
205
206
207
208
209
      pnfdOnboardingState:
        description: >
          On-boarding state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on-boarding procedure.
210
          See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
211
212
213
          It shall be present when the
          pnfdOnboardingState attribute is CREATED
          and the uploading or processing fails in the NFVO.
214
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
215
216
217
218
219
220
221
222
      pnfdUsageState:
        description: >
          Usage state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual PNF descriptor resource.
          This attribute can be modified with the PATCH method.
223
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
224
225
      _links:
        required:
226
227
228
          - pnfd_content
          - self
        type: object
229
        description: >
230
          Links to resources related to this resource.
231
232
        properties:
          self:
233
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
234
          pnfd_content:
235
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
236
    description: >
237
      This type represents a response for the query PNFD operation.
238

239
  CreatePnfdInfoRequest:
240
    type: object
241
242
    properties:
      userDefinedData:
243
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
244
245
246
247
    description: >
      User-defined data for the PNF descriptor resource to be created.
      It shall be present when the user defined data is set for
      the individual PNF descriptor resource to be created.
248

249
  NsdmSubscriptionRequest:
250
    type: object
251
    required:
252
      - callbackUri
253
    properties:
254
255
256
257
258
259
260
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        type: string
        description: >
          The URI of the endpoint to send the notification to.
      authentication:
261
262
263
264
        description: >
          Authentication parameters to configure the use of Authorization when sending
          notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires authorization of notifications.
265
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
266
    description: >
267
268
      This type represents a subscription request related to notifications
      about NSD management.
269

270
  NsdmSubscription:
271
    type: object
272
    required:
273
274
275
      - id
      - callbackUri
      - _links
276
    properties:
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset
          of all notifications this subscription relates to.
          A particular notification is sent to the subscriber if the filter
          matches, or if there is no filter.
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
      _links:
        type: object
        description: >
          Links to resources related to this resource.
        properties:
          self:
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
299
    description: >
300
      This type represents a subscription related to notifications about NSD management.
301

302
303
304
305
306
307
308
309
310
311
  NsdmNotificationsFilter:
    type: object
    description: >
      This type represents a subscription filter related to notifications
      about NSD management. It shall comply with the provisions defined in Table
      5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure,
      the following applies: All attributes shall match in order for the filter
      to match (logical "and" between different filter attributes). If an attribute
      is an array, the attribute shall match if at least one of the values in the
      array matches (logical "or" between the values of one filter attribute).
312
313
314
315
316
317

      NOTE 1: The attributes "nsdId" and "nsdInfoId" are alternatives to reference to a particular NSD in a filter.
      They should not be used both in the same filter instance, but one alternative should be chosen.

      NOTE 2: The attributes "pnfdId" and "pnfdInfoId" are alternatives to reference to a particular PNFD in a filter.
      They should not be used both in the same filter instance, but one alternative should be chosen.
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
    properties:
      notificationTypes:
        description: >
          Match particular notification types. Permitted values: NsdOnBoardingNotification,
          NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
          PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
          The permitted values of the "notificationTypes" ] attribute are spelled
          exactly as the names of the notification types to facilitate automated
          code generation systems.
        type: array
        items:
          type: string
          enum:
            - NsdOnBoardingNotification
            - NsdOnboardingFailureNotification
            - NsdChangeNotification
            - NsdDeletionNotification
            - PnfdOnBoardingNotification
            - PnfdOnBoardingFailureNotification
            - PnfdDeletionNotification
      nsdInfoId:
        description: >
          Match the NsdInfo identifier which is allocated by the NFVO.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        description: >
          Match the NSD identifier, which is allocated by the NSD designer.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdName:
        description: >
          Match the name of the on boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      nsdVersion:
        description: >
          Match the NSD version listed as part of this attribute.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      nsdDesigner:
        description: >
          Match the NSD designer of the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      nsdInvariantId:
        description: >
          Match the NSD invariant identifier which is allocated
          by the NSD designer and identifies an NSD in a
          version independent manner.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfPkgIds:
        description: >
          Match VNF packages with a package identifier listed
          in the attribute.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoIds:
        description: >
          Match the PnfdInfo identifier for the PNFD
          referenced by the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nestedNsdInfoIds:
        description: >
          Match the NsdInfo identifier for the nested NSD
          referenced by the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdOnboardingState:
        description: >
          Match particular on-boarding state of the NSD.
        type: array
        items:
          $ref: "#/definitions/NsdOnboardingStateType"
      nsdOperationalState:
        description: >
          Match particular operational state of the on-boarded NSD.
        type: array
        items:
          $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Match particular usage state of the on-boarded NSD.
        type: array
        items:
          $ref: "#/definitions/NsdUsageStateType"
      pnfdId:
        description: >
          Match the PNFD identifier which is copied from the PNFD content.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdName:
        description: >
          Match the name of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      pnfdVersion:
        description: >
          Match the PNFD designer of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      pnfdProvider:
        description: >
          Match the provider of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      pnfdInvariantId:
        description: >
          Match the PNFD in a version independent manner.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdOnboardingState:
        description: >
          Match particular on-boarding state of the PNFD.
        type: array
        items:
          $ref: "#/definitions/PnfdOnboardingStateType"
      pnfdUsageState:
        description: >
          Match the usage state of the individual PNF descriptor resource.
        type: array
        items:
          $ref: "#/definitions/PnfdUsageStateType"

  NsdOperationalStateType:
    type: string
    description: >
      The enumeration NsdOperationalStateType shall comply with the provisions
      defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
      state of the resource.
      ENABLED = The operational state of the resource is enabled.
      DISABLED = The operational state of the resource is disabled.
    enum:
      - ENABLED
      - DISABLED

  NsdUsageStateType:
    type: string
    description: >
      The enumeration NsdUsageStateType shall comply with the provisions
      defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
      of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
      is not-in-use.
    enum:
      - IN_USE
      - NOT_IN_USE

  NsdOnboardingStateType:
    type: string
    description: >
      The enumeration NsdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
      state of the NSD.
      CREATED = The NSD information object is created.
      UPLOADING = The associated NSD content is being uploaded.
      PROCESSING = The associated NSD content is being processed, e.g. validation.
      ONBOARDED = The associated NSD content is on-boarded.
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED

  PnfdOnboardingStateType:
    type: string
    description: >
      The enumeration PnfdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
      of the individual PNF descriptor resource.
      CREATED = The PNF descriptor resource is created.
      UPLOADING = The associated PNFD content is being uploaded.
      PROCESSING = The associated PNFD content is being processed, e.g. validation.
      ONBOARDED = The associated PNFD content is on-boarded.
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDING

  PnfdUsageStateType:
    type: string
    description: >
      The enumeration PnfdUsageStateType shall comply with the provisions
      defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
      of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
      is not-in-use.
    enum:
      - IN_USE
      - NOT_IN_USE