SOL002SOL003_def.yaml 44.3 KB
Newer Older
1
2
3
4
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
5
6
  Link:
    description: >
7
      This type represents a link to a resource using an absolute URI.
8
9
10
11
12
13
    type: object
    required:
      - href
    properties:
      href:
        description: >
14
          URI of another resource referenced from a resource.
15
          Shall be an absolute URI (i.e. a UTI that contains {apiRoot}).
Giacomo Bernini's avatar
Giacomo Bernini committed
16
17
18
19
        $ref: "#/definitions/Uri"

  NotificationLink:
    description: >
20
      This type represents a link to a resource in a notification, using an absolute or relative URI.
Giacomo Bernini's avatar
Giacomo Bernini committed
21
22
23
24
25
26
27
28
29
30
31
32
    type: object
    required:
      - href
    properties:
      href:
        description: >
          URI of a resource referenced from a notification.
          Should be an absolute URI (i.e. a URI that contains
          {apiRoot}), however, may be a relative URI (i.e. a URI
          where the {apiRoot} part is omitted) if the {apiRoot}
          information is not available.
        $ref: "#/definitions/Uri"
33

34
  KeyValuePairs:
35
    description: >
36
37
38
39
40
      This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON,
      a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4
      of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber",
      "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of
      different type.
41
42
    type: object

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
  ApiVersionInformation:
    description: >
      This type represents API version information.
    type: object
    required:
      - uriPrefix
      - apiVersions
    properties:
      uriPrefix:
        description: >
          Specifies the URI prefix for the API, in the following
          form {apiRoot}/{apiName}/{apiMajorVersion}/.
        type: string
      apiVersions:
        description: >
          Version(s) supported for the API signaled by the
          uriPrefix attribute.
        type: array
        items:
          type: object
          required:
            - version
          properties:
            version:
              description: >
                Identifies a supported version. The value of the
                version attribute shall be a version identifier as
                specified in clause 9.1 (SOL013).
              type: string
            isDeprecated:
              description: >
                If such information is available, this attribute indicates
                whether use of the version signaled by the version
                attribute is deprecated (true) or not (false).

                A deprecated version is still supported by the API producer but is recommended
                not to be used any longer.
                When a version is no longer supported, it does not appear in the response body.
              type: boolean
            retirementDate:
              description: >
                The date and time after which the API version will no
                longer be supported.
                This attribute may be included if the value of the
                isDeprecated attribute is set to true and shall be
                absent otherwise.
              $ref: "#/definitions/DateTime"

91
92
93
94
95
  VnfInstanceSubscriptionFilter:
    description: >
      This type represents subscription filter criteria to match VNF
      instances.
    type: object
96
97
98
99
100
101
102
103
104
105
106
    anyOf:
      - oneOf:
        - required:
            - vnfdId
        - required:
            - vnfProductsFromProviders
      - oneOf:
        - required:
            - vnfInstanceIds
        - required:
            - vnfInstanceNames
107
    properties:
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
      vnfdIds:
        description: >
          If present, match VNF instances that were created based on a VNFD
          identified by one of the vnfdId values listed in this attribute.
          The attributes "vnfdIds" and "vnfProductsFromProviders" are
          alternatives to reference to VNF instances that are based on certain
          VNFDs in a filter. They should not be used both in the same filter
          instance, but one alternative should be chosen.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      vnfProductsFromProviders:
        description: >
          If present, match VNF instances that belong to VNF products from
          certain providers.
          The attributes "vnfdIds" and "vnfProductsFromProviders" are
          alternatives to reference to VNF instances that are based on certain
          VNFDs in a filter. They should not be used both in the same filter
          instance, but one alternative should be chosen.
        type: array
        items:
          type: object
          required:
            - vnfProvider
          properties:
            vnfProvider:
              description: >
                Name of the VNF provider to match.
              type: string
            vnfProducts:
              description: >
                If present, match VNF instances that belong to VNF products
                with certain product names, from one particular provider.
              type: array
              items:
                type: object
                required:
                  - vnfProductName
                properties:
                  vnfProductName:
                    description: >
                      Name of the VNF product to match.
                    type: string
                  versions:
                    description: >
                      If present, match VNF instances that belong to VNF
                      products with certain versions and a certain product
                      name, from one particular provider.
                    type: array
                    items:
                      type: object
                      required:
                        - vnfSoftwareVersion
                      properties:
                        vnfSoftwareVersion:
                          description: >
                            Software version to match.
                          $ref: "#/definitions/Version"
                        vnfdVersions:
                          description: >
                            If present, match VNF instances that belong to VNF
                            products with certain VNFD versions, a certain
                            software version and a certain product name, from
                            one particular provider.
                          type: array
                          items:
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
                            $ref: "#/definitions/Version"
      vnfInstanceIds:
        description: >
          If present, match VNF instances with an instance identifier listed
          in this attribute.
          The attributes "vnfInstanceIds" and "vnfInstanceNames" are
          alternatives to reference to particular VNF Instances in a filter.
          They should not be used both in the same filter instance, but one
          alternative should be chosen.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      vnfInstanceNames:
        description: >
          If present, match VNF instances with a VNF Instance Name listed in
          this attribute.
          The attributes "vnfInstanceIds" and "vnfInstanceNames" are
          alternatives to reference to particular VNF Instances in a filter.
          They should not be used both in the same filter instance, but one
          alternative should be chosen.
        type: array
        items:
          type: string

198
  VnfExtCpData.VimConnectionInfo:
199
    description: >
200
201
202
203
204
205
      This type represents parameters to connect to a VIM for managing the
      resources of a VNF instance.
      This structure is used to convey VIM-related parameters over the Or-Vnfm
      interface. Additional parameters for a VIM may be configured into the
      VNFM by means outside the scope of the present document, and bound to
      the identifier of that VIM.
206
207
    type: object
    required:
208
      - vimType
209
    properties:
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
      vimId:
        description: >
          The identifier of the VIM instance. This identifier is managed by
          the NFVO.
          Shall be present to address additional information about the VIM if
          such information has been configured into the VNFM by means outside
          the scope of the present document, and should be absent otherwise.
        $ref: "#/definitions/Identifier"
      vimType:
        description: >
          Discriminator for the different types of the VIM information. The
          value of this attribute determines the structure of the
          "interfaceInfo" and "accessInfo" attributes, based on the type of the
          VIM. The set of permitted values is expected to change over time as
          new types or versions of VIMs become available.
          The ETSI NFV registry of VIM-related information provides access to
          information about VimConnectionInfo definitions for various VIM
          types. The structure of the registry is defined in Annex C of SOL003.
228
        type: string
229
      interfaceInfo:
230
        description: >
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
          Information about the interface or interfaces to the VIM, if
          applicable, such as the URI of an interface endpoint to
          communicate with the VIM. The applicable keys are dependent on the
          content of vimType.
          Alternatively, such information may have been configured into the
          VNFM and bound to the vimId.
        $ref: "#/definitions/KeyValuePairs"
      accessInfo:
        description: >
          Authentication credentials for accessing the VIM, and other
          access-related information such as tenants or infrastructure
          resource groups (see note). The applicable keys are dependent on the
          content of vimType.
          If the VimConnectionInfo structure is part of an HTTP response
          payload body, sensitive attributes that are children of this attributes
          (such as passwords) shall not be included.
          If the VimConnectionInfo structure is part of an HTTP request payload
          body, sensitive attributes that are children of this attribute (such
          as passwords) shall be present if they have not been provisioned out
          of band.
251
252
253
254
255
256
257
258
259
260
261
262
263
264

          If applicable, this attribute also provides information about the
          resourceGroupIds that are accessible using a particular set of credentials.
          See definition of "resourceGroupId" in clause 9.5.3.3.

          Once the connectivity between VNFM and VIM is provided through a secure
          connection over HTTP Secure (HTTP over SSL/TLS), and the connection might
          also be established through a VPN (for example TLS-based VPN tunnelling)
          for site-to-site connection, the "accessInfo" JSON data structure,
          and the sensitive data related information ("username"/"password" as required
          properties for authentication purpose), will be transmitted as plain text through
          a TLS tunnel without additional encoding/encryption before transmitting it,
          making the sensitive data visible to the endpoint. The base64 encoded certificates
          are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM.
265
266
267
268
269
270
271
        $ref: "#/definitions/KeyValuePairs"
      extra:
        description: >
          VIM type specific additional information. The applicable structure,
          and whether or not this attribute is available, is dependent on the
          content of vimType.
        $ref: "#/definitions/KeyValuePairs"
272

273
274
275
276
  ResourceHandle:
    required:
      - resourceId
    type: object
277
    description: >
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
      This type represents the information that allows addressing a virtualised
      resource that is used by a VNF instance. Information about the resource
      is available from the VIM.
    properties:
      vimConnectionId:
        description: >
          Identifier of the VIM connection to manage the resource. This
          attribute shall only be supported and present if VNF-related resource
          management in direct mode is applicable. The applicable
          "VimConnectionInfo" structure, which is referenced by
          vimConnectionId, can be obtained from the "vimConnectionInfo"
          attribute of the "VnfInstance" structure.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifier of the entity responsible for the management of the
          resource. This attribute shall only be supported and present when
          VNF-related resource management in indirect mode is applicable. The
          identification scheme is outside the scope of the present document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          Identifier of the resource in the scope of the VIM or the resource
          provider.
        $ref: "#/definitions/IdentifierInVim"
      vimLevelResourceType:
        description: >
          The value set of the "vimLevelResourceType" attribute is within the scope
          of the VIM or the resource provider and can be used as information that
          complements the ResourceHandle. This value set is different from the value
          set of the "type" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).
        type: string
310

311
  VnfExtCpData:
312
    description: >
313
314
315
316
317
318
319
320
      This type represents configuration information for external CPs created
      from a CPD.
    type: object
    required:
      - cpdId
    properties:
      cpdId:
        description: >
321
322
          The identifier of the CPD in the VNFD. In case this identifier refers to a CPD with trunking enabled,
          the external CP instances created from this CPD will represent ports in a trunk.
323
324
325

          NOTE: In case this identifier refers to a CPD with trunking enabled, the external CP instances created 
          from this CPD will represent ports in a trunk.
326
327
328
        $ref: "#/definitions/IdentifierInVnfd"
      cpConfig:
        description: >
329
          Map of instance data that need to be configured on the CP instances
330
          created from the respective CPD.
331
332
          The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer.
          The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
333
334
335
336
337
338
339
340
341
          Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity.
          Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC
          instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute.
          If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same
          segmentationId, which means they are connected to the same set of external VLs via the trunk.
          The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig" entry identified by a
          particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed
          by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance
          in case it represents a subport. Deleting the last key from the map removes the affected instance of the
342
          "VnfExtCpData" structure from its parent data structure.
343
344
        type: object
        additionalProperties:
345
          $ref: "#/definitions/VnfExtCpConfig"
346

347
  VnfExtCpConfig:
348
    description: >
349
350
351
352
353
354
      This type represents an externally provided link port or network address
      information per instance of an external connection point. In case a link
      port is provided, the VNFM shall use that link port when connecting the
      external CP to the external VL. In a link port is not provided, the VNFM
      shall create a link port on the external VL, and use that link port to
      connect the external CP to the external VL.
355
356
357
358
359
    anyOf:
      - required:
        - linkPortId
      - required:
        - cpProtocolData
360
361
    type: object
    properties:
362
363
      parentCpConfigId:
        description: >
364
365
366
          Value of the key that identifies the  "VnfExtCpConfig" map entry which corresponds to the parent port of the
          trunk. Reference to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk. Only present
          in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in
367
          a trunk, and if parent ports are supported.
368
369
370
371
372
373
374
        $ref: "#/definitions/IdentifierInVnf"
      linkPortId:
        description: >
          Identifier of a pre-configured link port to which the external CP
          will be associated.
          The following conditions apply to the attributes "linkPortId" and
          "cpProtocolData":
375
          1) At least one of the "linkPortId" and "cpProtocolData" attributes shall
376
             be present for a to-be-created external CP instance or an existing external
377
             CP instance.
378
          2) If the "linkPortId" attribute is absent, the VNFM shall create a
379
             link port.
380
          3) If the "cpProtocolData" attribute is absent, the "linkPortId"
381
382
383
384
             attribute shall be provided referencing a pre-created link port,
             and the VNFM can use means outside the scope of the present
             document to obtain the pre-configured address information for the
             connection point from the resource representing the link port.
385
          4) If both "cpProtocolData" and "linkportId" are provided, the API
386
387
388
389
390
391
392
393
394
             consumer shall ensure that the cpProtocolData can be used with the
             pre-created link port referenced by "linkPortId".
        $ref: "#/definitions/Identifier"
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the link port
          that connects the CP to a VL.
          The following conditions apply to the attributes "linkPortId" and
          "cpProtocolData":
395
396
397
398
399
400
401
          1) Void
          2) At least one of the "linkPortId" and "cpProtocolData" attributes 
             shall be present for an external CP instance representing a subport 
             that is to be created, or an external CP instance that is to be created 
             by creating the corresponding VNFC or VNF instance during the current or 
             a subsequent LCM operation, or for an existing external CP instance 
             that is to be re-configured or added to a particular external virtual link.
402
403
404
405
406
407
408
409
410
411
412
413
414
          3) If the "linkPortId" attribute is absent, the VNFM shall create a
             link port.
          4) If the "cpProtocolData" attribute is absent, the "linkPortId"
             attribute shall be provided referencing a pre-created link port,
             and the VNFM can use means outside the scope of the present
             document to obtain the pre-configured address information for the
             connection point from the resource representing the link port.
          5) If both "cpProtocolData" and "linkportId" are provided, the API
             consumer shall ensure that the cpProtocolData can be used with the
             pre-created link port referenced by "linkPortId".
        type: array
        items:
          $ref: "#/definitions/CpProtocolData"
415

416
417
  CpProtocolData:
    description: >
418
      This type represents network protocol data.
419
    type: object
Giacomo Bernini's avatar
Giacomo Bernini committed
420
    required:
421
      - layerProtocol
Giacomo Bernini's avatar
Giacomo Bernini committed
422
    properties:
423
424
425
426
427
428
429
430
      layerProtocol:
        description: >
          Identifier of layer(s) and protocol(s).
          This attribute allows to signal the addition of further types of
          layer and protocol in future versions of the present document in a
          backwards-compatible way. In the current version of the present
          document, only IP over Ethernet is supported.
        type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
431
        enum:
432
433
434
435
436
437
438
439
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          Network address data for IP over Ethernet to assign to the extCP
          instance. Shall be present if layerProtocol is equal to
          "IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressData"

440
441
442
443
  IpOverEthernetAddressData:
    description: >
      This type represents network address data for IP over Ethernet.
    type: object
444
445
446
447
448
449
450
451
452
453
454
455
    anyOf:
      - required:
          - macAddress
      - required:
          - ipAddresses
    oneOf:
      - required:
          - fixedAddresses
      - required:
          - numDynamicAddresses
      - required:
          - ipAddressRange
456
457
458
459
460
461
462
    properties:
      macAddress:
        description: >
          MAC address. If this attribute is not present, it shall be chosen by
          the VIM.
          At least one of "macAddress" or "ipAddresses" shall be present.
        $ref: "#/definitions/MacAddress"
463
464
465
466
467
468
469
470
471
472
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a
          subport in a trunk, segmentationId shall be present. Otherwise it shall not be present.
          Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment
          value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an
          identifier used between the application and the NFVI networking infrastructure to identify the network
          sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local
          segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.
        type: string
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
      ipAddresses:
        description: >
          List of IP addresses to assign to the CP instance. Each entry
          represents IP address data for fixed or dynamic IP address
          assignment per subnet.
          If this attribute is not present, no IP address shall be assigned.
        type: array
        items:
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            fixedAddresses:
              description: >
                Fixed addresses to assign (from the subnet defined by
                "subnetId" if provided).
                Exactly one of "fixedAddresses", "numDynamicAddresses" or
                "ipAddressRange" shall be present.
              type: array
              items:
                $ref: "#/definitions/IpAddress"
            numDynamicAddresses:
              description: >
                Number of dynamic addresses to assign (from the subnet defined
                by "subnetId" if provided).
                Exactly one of "fixedAddresses", "numDynamicAddresses" or
                "ipAddressRange" shall be present.
              type: integer
            addressRange:
              description: >
                An IP address range to be used, e.g. in case of egress
                connections.
                In case this attribute is present, IP addresses from the range
                will be used.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in the
                VIM.
                In case this attribute is present, IP addresses from that
                subnet will be assigned; otherwise, IP addresses not bound to
                a subnet will be assigned.
              $ref: "#/definitions/IdentifierInVim"
536

537
  ExtVirtualLinkData:
538
    description: >
539
      This type represents an external VL.
540
    type: object
Giacomo Bernini's avatar
Giacomo Bernini committed
541
    required:
542
      - id
543
544
      - resourceId
      - extCps
545
    properties:
546
      id:
547
        description: >
548
549
          The identifier of the external VL instance. The identifier is
          assigned by the NFV-MANO entity that manages this VL instance.
550
        $ref: "#/definitions/Identifier"
551
      vimConnectionId:
552
        description: >
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
          Identifier of the VIM connection to manage this resource. This
          attribute shall only be supported and present if VNF-related
          resource management in direct mode is applicable.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of this
          resource. This attribute shall only be supported and present
          if VNF-related resource management in indirect mode is applicable.
          The identification scheme is outside the scope of the present
          document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or the
          resource provider.
        $ref: "#/definitions/IdentifierInVim"
      extCps:
        description: >
          External CPs of the VNF to be connected to this external VL.
        type: array
        items:
          $ref: "#/definitions/VnfExtCpData"
      extLinkPorts:
        description: >
          Externally provided link ports to be used to connect external
          connection points to this external VL. If this attribute is not
          present, the VNFM shall create the link ports on the external VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortData"
584
585
586
587
588

  ExtManagedVirtualLinkData:
    type: object
    required:
      - id
589
      - vnfVirtualLinkDescId
590
591
592
593
      - resourceId
    properties:
      id:
        description: >
594
595
596
          The identifier of the externally-managed internal VL instance. The
          identifier is assigned by the NFV-MANO entity that manages this VL
          instance.
597
        $ref: "#/definitions/Identifier"
598
      vnfVirtualLinkDescId:
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
        description: >
          The identifier of the VLD in the VNFD for this VL.
        $ref: "#/definitions/IdentifierInVnfd"
      vimConnectionId:
        description: >
          Identifier of the VIM connection to manage this resource. This
          attribute shall only be supported and present if VNF-related
          resource management in direct mode is applicable.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of this
          resource. This attribute shall only be supported and present if
          VNF-related resource management in indirect mode is applicable. The
          identification scheme is outside the scope of the present document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or the
          resource provider.
        $ref: "#/definitions/IdentifierInVim"
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
      vnfLinkPort:
        description: >
          Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL 
          on this network resource. If this attribute is not present, the VNFM shall create the link ports on the 
          externally-managed VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortData"
      extManagedMultisiteVirtualLinkId:
        description: >
          Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO 
          entity that manages the externally managed multi-site VL instance. It shall be present when the present 
          externally-managed internal VL (indicated by extManagedVirtualLinkId) is part of a multi-site VL, e.g., 
          in support of multi-site VNF spanning several VIMs. All externally-managed internal VL instances 
          corresponding to an internal VL created based on the same virtualLinkDescId shall refer to the same 
          extManagedMultisiteVirtualLinkId.
        $ref: "#/definitions/Identifier"
637

638
  Identifier:
639
    description: >
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
      An identifier with the intention of being globally unique.
    type: string

  DateTime:
    description: >
      Date-time stamp.
      Representation: String formatted according to IETF RFC 3339.
    type: string
    format: date-time

  Uri:
    description: >
      String formatted according to IETF RFC 3986.
    type: string

  Boolean:
    description: >
      The Boolean is a data type having two values (true and false).
    type: boolean

  MacAddress:
    description: >
      A MAC address. Representation: string that consists of groups of two hexadecimal digits,
      separated by hyphens or colons.
    type: string
    format: MAC

  IpAddress:
    description: >
      An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
      integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
      consists of groups of zero to four hexadecimal digits, separated by colons.
    type: string
    format: IP

  Version:
    description: >
      A version.
    type: string

  String:
    description: >
      A string defined in IETF RFC 8259.
    type: string

  Number:
    description: >
      A number defined in IETF RFC 8259.
    type: number

690
691
692
693
694
695
  UnsignedInt:
    description: >
      Unsigned integer number
    type: integer
    minimum: 0

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
  IdentifierInVnfd:
    description: >
      An identifier that is unique within a VNF descriptor.
    type: string

  IdentifierInVim:
    description: >
      An identifier maintained by the VIM or other resource provider. It is
      expected to be unique within the VIM instance.
    type: string

  IdentifierInVnf:
    description: >
      An identifier that is unique for the respective type within a VNF
      instance, but may not be globally unique.
    type: string

  IdentifierLocal:
    description: >
      An identifier that is unique within a limited local scope other than above listed identifiers,
      such as within a complex data structure or within a request-response pair.
      Representation: string of variable length.
    type: string

720
721
722
723
724
  Checksum: #no definition found
    description: >
      Cheksum description
    type: string

725
726
727
########################################################################################################################
# TO CHECK IF INCLUDE THESE DATA TYPES IN ANOTHER DEF FILES

728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
  VnfLinkPortData:
    description: >
      This type represents an externally provided link port to be used to connect a VNFC connection point 
      to an exernally managed VL.
    type: object
    required:
    - vnfLinkPortId
    - resourceHandle
    properties:
      vnfLinkPortId:
        description: >
          Identifier of this link port as provided by the entity that has created the link port.
        $ref: "#/definitions/Identifier"
      resourceHandle:
        description: >
          Resource handle of the virtualised resource that realizes the link port.
        $ref: "#/definitions/ResourceHandle"

746
747
748
749
  ExtLinkPortData:
    description: >
      This type represents an externally provided link port to be used to
      connect an external connection point to an external VL.
750
751
752
    type: object
    required:
      - id
753
754
755
      - resourceHandle
    properties:
      id:
756
        description: >
757
758
          Identifier of this link port as provided by the entity that has
          created the link port.
759
        $ref: "#/definitions/Identifier"
760
      resourceHandle:
761
        description: >
762
763
          Reference to the virtualised resource realizing this link port.
        $ref: "#/definitions/ResourceHandle"
764

765
766
767
768
769
770
771
772
773
774
775
776
777
778
  GrantedLcmOperationType:
    description: >
      The enumeration GrantedLcmOperationType defines the permitted values 
      to represent VNF lifecycle operation types in grant requests.
      Value | Description
      ------|------------
      INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
      SCALE | Represents the "Scale VNF" LCM operation.
      SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
      CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM operation.
      TERMINATE | Represents the "Terminate VNF" LCM operation.
      HEAL | Represents the "Heal VNF" LCM operation.
      OPERATE | Represents the "Operate VNF" LCM operation.
      CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.     
779
780
781
      CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation.
      CREATE_SNAPSHOT | Represents the "Create VNF snapshot" LCM operation.
      REVERT_TO_SNAPSHOT | Represents the "Revert to VNF snapshot" LCM operation.
782
783
784
785
786
787
788
789
790
791
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
792
793
794
      - CHANGE_VNFPKG
      - CREATE_SNAPSHOT
      - REVERT_TO_SNAPSHOT
795

796
797
798
799
800
801
802
803
804
805
806
807
  LcmOperationType:
    description: >
      Value | Description
      ------|------------
      INSTANTIATE | Represents the "Instantiate VNF" LCM operation.   
      SCALE | Represents the "Scale VNF" LCM operation.
      SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
      CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM operation.
      TERMINATE | Represents the "Terminate VNF" LCM operation.
      HEAL | Represents the "Heal VNF" LCM operation.
      OPERATE | Represents the "Operate VNF" LCM operation.
      CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.
808
809
810
811
      MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
      CREATE_SNAPSHOT | Represents the "Create VNF Snapshot" LCM operation.
      REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot" LCM operation.
      CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation.
812
813
814
815
816
817
818
819
820
821
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
Giacomo Bernini's avatar
Giacomo Bernini committed
822
      - MODIFY_INFO
823
824
825
      - CREATE_SNAPSHOT
      - REVERT_TO_SNAPSHOT
      - CHANGE_VNFPKG
826

827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
  ProblemDetails:
    #SOL003 location: 4.3.5.3
    description: >
      The definition of the general "ProblemDetails" data structure from
      IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
      general framework defined in IETF RFC 7807 [19], the "status" and
      "detail" attributes are mandated to be included by the present document,
      to ensure that the response contains additional textual information about
      an error. IETF RFC 7807 [19] foresees extensibility of the
      "ProblemDetails" type. It is possible that particular APIs in the present
      document, or particular implementations, define extensions to define
      additional attributes that provide more information about the error.
      The description column only provides some explanation of the meaning to
      Facilitate understanding of the design. For a full description, see
      IETF RFC 7807 [19].
    type: object
    required:
      - status
      - detail
    properties:
      type:
        description: >
          A URI reference according to IETF RFC 3986 [5] that identifies the
          problem type. It is encouraged that the URI provides human-readable
          documentation for the problem (e.g. using HTML) when dereferenced.
          When this member is not present, its value is assumed to be
          "about:blank".
        type: string
        format: URI
      title:
        description: >
          A short, human-readable summary of the problem type. It should not
          change from occurrence to occurrence of the problem, except for
          purposes of localization. If type is given and other than
          "about:blank", this attribute shall also be provided.
          A short, human-readable summary of the problem
          type.  It SHOULD NOT change from occurrence to occurrence of the
          problem, except for purposes of localization (e.g., using
          proactive content negotiation; see [RFC7231], Section 3.4).
        type: string
      status:
        description: >
          The HTTP status code for this occurrence of the problem.
          The HTTP status code ([RFC7231], Section 6) generated by the origin
          server for this occurrence of the problem.
        type: integer
      detail:
        description: >
          A human-readable explanation specific to this occurrence of the
          problem.
        type: string
      instance:
        description: >
          A URI reference that identifies the specific occurrence of the
          problem. It may yield further information if dereferenced.
        type: string
        format: URI
      #TODO: How to express "any additional attributes"?

886
887
  SubscriptionAuthentication:
    type: object
Giacomo Bernini's avatar
Giacomo Bernini committed
888
    required:
889
      - authType
Giacomo Bernini's avatar
Giacomo Bernini committed
890
    properties:
891
892
      authType:
        description: >
893
894
          Defines the types of Authentication / Authorization which the API
          consumer is willing to accept when receiving a notification.
895
          Permitted values:
896
897
898
899
900
901
902
903
904
905
          * BASIC: In every HTTP request to the notification endpoint, use
            HTTP Basic authentication with the client credentials. 
          * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
            notification endpoint, use an OAuth 2.0 Bearer token, obtained
            using the client credentials grant type.
          * TLS_CERT: Every HTTP request to the notification endpoint is sent
            over a mutually authenticated TLS session, i.e. not only the
            server is authenticated, but also the client is authenticated
            during the TLS tunnel setup.
        type: array
Giacomo Bernini's avatar
Giacomo Bernini committed
906
        items:
907
908
909
910
911
          type: string
          enum:
            - BASIC
            - OAUTH2_CLIENT_CREDENTIALS
            - TLS_CERT
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
      paramsBasic:
        description: >
          Parameters for authentication/authorization using BASIC.
          Shall be present if authType is "BASIC" and the contained
          information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          userName:
            description: >
              Username to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
          password:
            description: >
              Password to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
      paramsOauth2ClientCredentials:
        description: >
          Parameters for authentication/authorization using
          OAUTH2_CLIENT_CREDENTIALS.
          Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
          contained information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token request of the
              OAuth 2.0 client credentials grant type. 
              Shall be present if it has not been provisioned out of band.
              The clientId and clientPassword passed in a subscription shall
              not be the same as the clientId and clientPassword that are used
              to obtain authorization for API requests. Client credentials may
              differ between subscriptions. The value of clientPassword should
              be generated by a random process.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access token request of the
              OAuth 2.0 client credentials grant type. 
              Shall be present if it has not been provisioned out of band.
              The clientId and clientPassword passed in a subscription shall
              not be the same as the clientId and clientPassword that are used
              to obtain authorization for API requests. Client credentials may
              differ between subscriptions. The value of clientPassword should
              be generated by a random process.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access token can be obtained.
              Shall be present if it has not been provisioned out of band.
            $ref: "#/definitions/Uri"

967
  AffectedVnfc:
968
    description: >
969
970
      This type provides information about added, deleted, modified and
      temporary VNFCs.
971
    type: object
972
973
974
975
976
    required:
      - id
      - vduId
      - changeType
      - computeResource
977
    properties:
978
      id:
979
        description: >
980
981
982
983
          Identifier of the Vnfc instance, identifying the applicable
          "vnfcResourceInfo" entry in the "VnfInstance" data type.
        $ref: "#/definitions/IdentifierInVnf"
      vduId:
984
        description: >
985
986
          Identifier of the related VDU in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
987
988
989
990
991
992
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case of a "change current VNF Package" to identify whether the affected VNFC instance is
          associated to a VDU which is referred from the source or destination VNFD.
        $ref: "#/definitions/Identifier"
993
      changeType:
994
        description: >
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
          Signals the type of change. Permitted values:
          * ADDED
          * REMOVED
          * MODIFIED
          * TEMPORARY
          For a temporary resource, an AffectedVnfc structure exists as long
          as the temporary resource exists.
        type: string
        enum:
          - ADDED
          - REMOVED
          - MODIFIED
          - TEMPORARY
      computeResource:
        description: >
          Reference to the VirtualCompute resource. Detailed information is
          (for new and modified resources) or has been (for removed
          resources) available from the VIM.
        $ref: "#/definitions/ResourceHandle"
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
      resourceDefinitionId:
        description: >
          The identifier of the "ResourceDefinition" in the granting exchange
          related to the LCM operation occurrence. It shall be present when
          an applicable GrantInfo for thegranted resource exists. See note.
        $ref: "#/definitions/IdentifierLocal"
      zoneId:
        description: >
          The identifier of the resource zone, as managed by the resource management
           layer (typically, the VIM), where the referenced VirtualCompute resource is placed.
           Shall be provided if this information is available from the VIM.
        $ref: "#/definitions/Identifier"
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
      metadata:
        description: >
          Metadata about this resource.
          The content of this attribute shall be a copy of the content of the
          "metadata" attribute of the VnfcResourceInfo structure.
        $ref: "#/definitions/KeyValuePairs"
      affectedVnfcCpIds:
        description: >
          Identifiers of CP(s) of the VNFC instance that were affected by the
          change.
          Shall be present for those affected CPs of the VNFC instance that
          are associated to an external CP of the VNF instance.
          May be present for further affected CPs of the VNFC instance.
1039
        type: array
Giacomo Bernini's avatar
Giacomo Bernini committed
1040
        items:
1041
1042
          $ref: "#/definitions/IdentifierInVnf"
      addedStorageResourceIds:
1043
        description: >
1044
1045
1046
1047
          References to VirtualStorage resources that have been added. Each
          value refers to a VirtualStorageResourceInfo item in the
          VnfInstance that was added to the VNFC. It shall be provided if at
          least one storage resource was added to the VNFC.
1048
        type: array
Giacomo Bernini's avatar
Giacomo Bernini committed
1049
        items:
1050
1051
          $ref: "#/definitions/IdentifierInVnf"
      removedStorageResourceIds:
Giacomo Bernini's avatar
Giacomo Bernini committed
1052
        description: >
1053
1054
1055
1056
1057
1058
          References to VirtualStorage resources that have been removed.
          The value contains the identifier of a VirtualStorageResourceInfo
          item that has been removed from the VNFC, and might no longer exist
          in the VnfInstance.
          It shall be provided if at least one storage resource was removed
          from the VNFC.
Giacomo Bernini's avatar
Giacomo Bernini committed
1059
1060
        type: array
        items:
1061
          $ref: "#/definitions/IdentifierInVnf"