summaryrefslogtreecommitdiffstats
path: root/adapters/mso-vnfm-adapter/mso-vnfm-adapter-api/src/main/resources/vnfmadapter.yaml
blob: dc5f85e5fe5eeca3ca7eb469866e2149c7b1839e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
swagger: '2.0'
info:
  version: 1.0.0
  title: ONAP SO VNFM Adapter API
  description: >-
    Describes the API between SO (Service Orchestrator) and the adapter for VNFM
    (Virtual Network Function Manager)
basePath: /so/vnfm-adapter/v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  '/vnfs/{vnfId}':
    post:
      tags:
        - SO VNFM Adapter
      summary: VNF create
      description: Create a VNF instance using a VNFM.
      operationId: vnf_create
      consumes:
        - application/json
      parameters:
        - required: true
          type: string
          description: >-
            The identifier of the VNF. This must be the vnf-id of an existing
            generic-vnf in AAI.
          name: vnfId
          in: path
        - in: body
          name: body
          description: VNF creation parameters
          required: true
          schema:
            $ref: '#/definitions/CreateVnfRequest'
        - name: X-ONAP-RequestID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single top level invocation of ONAP
          in: header
          required: true
          type: string
        - name: X-InvocationID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single invocation of a single component
          in: header
          required: true
          type: string
      responses:
        '202':
          description: >-
            The request was accepted for processing, but the processing has not
            been completed.
          schema:
            $ref: '#/definitions/CreateVnfResponse'
        '400':
          description: >-
            An error occurred in the VNFM adapter relating to the given input,
            for example, if the definition of the given VNF in AAI does not
            included required information.
        '404':
          description: A VNF with the specified ID was not found in AAI.
        '500':
          description: >-
            An error occurred in the VNFM adapter not relating to the given
            input, or an error is received from the VNFM.
    delete:
      tags:
        - SO VNFM Adapter
      summary: VNF delete
      description: Delete an instance of a VNF using a VNFM.
      operationId: vnf_delete
      consumes:
        - application/json
      parameters:
        - required: true
          type: string
          description: >-
            The identifier of the VNF. This must be the vnf-id of an existing
            generic-vnf in AAI
          name: vnfId
          in: path
        - name: X-ONAP-RequestID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single top level invocation of ONAP
          in: header
          required: true
          type: string
        - name: X-InvocationID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single invocation of a single component
          in: header
          required: true
          type: string
      responses:
        '202':
          description: >-
            The request was accepted for processing, but the processing has not
            been completed.
          schema:
            $ref: '#/definitions/DeleteVnfResponse'
        '400':
          description: >-
            An error occurred in the VNFM adapter relating to the given input,
            for example, if the definition of the given VNF in AAI does not
            included required information.
        '404':
          description: A VNF with the specified ID was not found in AAI.
        '500':
          description: >-
            An error occurred in the VNFM adapter not relating to the given
            input, or an error is received from the VNFM.
  '/jobs/{jobId}':
    get:
      tags:
        - SO VNFM Adapter
      summary: Job query
      description: Query the status of a job.
      operationId: job_query
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - required: true
          type: string
          description: The identifier of the Job.
          name: jobId
          in: path
        - name: X-ONAP-RequestID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single top level invocation of ONAP
          in: header
          required: true
          type: string
        - name: X-InvocationID
          description: >-
            Used to track REST requests for logging purposes. Identifies a
            single invocation of a single component
          in: header
          required: true
          type: string
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/QueryJobResponse'
        '404':
          description: A job with the specified ID was not found.
        '500':
          description: >-
            An error occurred in the VNFM adapter not relating to the given
            input, or an error is received from the VNFM.
definitions:
  CreateVnfRequest:
    type: object
    properties:
      name:
        type: string
        description: The name to be applied to the VNF.
      tenant:
        $ref: '#/definitions/Tenant'
      additionalParams:
        type: object
        description: >-
          Additional input parameters for the instantiation process, specific to
          the VNF being instantiated, as declared in the VNFD as part of
          "InstantiateVnfOpConfig".
        additionalProperties:
          type: string
      externalVirtualLinks:
        type: array
        description: Information about external VLs to connect the VNF to.
        items:
          $ref: '#/definitions/ExternalVirtualLink'
    required:
      - name
      - tenant
  Tenant:
    type: object
    description: Details of the tenant that VNFs can be deployed into
    properties:
      cloudOwner:
        type: string
        description: The owner in AAI of the cloud to which the tenant belongs.
      regionName:
        type: string
        description: The regionName in AAI of the cloud to which the tenant belongs.
      tenantId:
        type: string
        description: The identifier of the tenant in the VIM.
    required:
      - cloudOwner
      - regionName
      - tenantId
  CreateVnfResponse:
    type: object
    properties:
      jobId:
        description: The ID of the job which can be used to query the status of the job
        type: string
    required:
      - jobId
  DeleteVnfResponse:
    type: object
    properties:
      jobId:
        description: >-
          The ID of the job which can be used to query the status of the delete
          job
        type: string
    required:
      - jobId
  QueryJobResponse:
    type: object
    properties:
      operationStatusRetrievalStatus:
        $ref: '#/definitions/OperationStatusRetrievalStatusEnum'
      id:
        type: string
      operation:
        $ref: '#/definitions/OperationEnum'
      operationState:
        $ref: '#/definitions/OperationStateEnum'
      startTime:
        type: string
        format: date-time
      stateEnteredTime:
        type: string
        format: date-time
      vnfInstanceId:
        type: string
    required:
      - operationStatusRetrievalStatus
  OperationStatusRetrievalStatusEnum:
    description: The status of the attempt to retrrieve the operation from the VNFM
    type: string
    enum:
      - STATUS_FOUND
      - WAITING_FOR_STATUS
      - OPERATION_NOT_FOUND
      - CANNOT_RETRIEVE_STATUS
  OperationEnum:
    description: The operation
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
      - MODIFY_INFO
  OperationStateEnum:
    description: The status of the operation
    type: string
    enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED_TEMP
      - FAILED
      - ROLLING_BACK
      - ROLLED_BACK
  ExternalVirtualLink:
    description: |
      This type represents an external VL.
    type: object
    required:
      - id
      - resourceId
      - extCps
    properties:
      id:
        description: |
          An identifier with the intention of being globally unique.
        type: string
      tenant:
        $ref: '#/definitions/Tenant'
      resourceId:
        description: |
          An identifier maintained by the VIM.
        type: string
      extCps:
        description: |
          External CPs of the VNF to be connected to this external VL.
        type: array
        items:
          description: >
            This type represents configuration information for external CPs
            created from a CPD.
          type: object
          required:
            - cpdId
          properties:
            cpdId:
              description: |
                An identifier that is unique within a VNF descriptor.
              type: string
            cpConfig:
              description: >
                List of instance data that need to be configured on the CP
                instances created from the respective CPD.
              type: array
              items:
                description: >
                  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.
                type: object
                properties:
                  cpInstanceId:
                    description: >
                      An identifier that is unique for the respective type
                      within a VNF instance, but may not be globally unique.
                    type: string
                  linkPortId:
                    description: |
                      An identifier with the intention of being globally unique.
                    type: string
                  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":  * The "linkPortId" and "cpProtocolData"
                      attributes shall both be  absent for the deletion of an
                      existing external CP instance
                        addressed by cpInstanceId. 
                      * At least one of these attributes shall be present for a 
                      to-be-created external CP instance or an existing external
                        CP instance.
                      * If the "linkPortId" attribute is absent, the VNFM shall
                      create a  link port.

                      * 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.
                      * 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:
                      description: |
                        This type represents network protocol data.
                      type: object
                      required:
                        - layerProtocol
                      properties:
                        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
                          enum:
                            - IP_OVER_ETHERNET
                        ipOverEthernet:
                          description: >
                            This type represents network address data for IP
                            over Ethernet.
                          type: object
                          properties:
                            macAddress:
                              description: >
                                A MAC address. Representation: string that
                                consists of groups of two hexadecimal digits,
                                separated by hyphens or colons.
                              type: string
                              format: MAC
                            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:
                                      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
                                  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: >
                                          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
                                      maxAddress:
                                        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
                                  subnetId:
                                    description: >
                                      An identifier maintained by the VIM or
                                      other resource provider. It is expected to
                                      be unique within the VIM instance.
                                    type: string
      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:
          description: >
            This type represents an externally provided link port to be used to
            connect an external connection point to an external VL.
          type: object
          required:
            - id
            - resourceHandle
          properties:
            id:
              description: |
                An identifier with the intention of being globally unique.
              type: string
            resourceHandle:
              required:
                - tenant
                - resourceId
              type: object
              description: >
                This type represents the information that allows addressing a
                virtualised resource that is used by a VNF instance.
              properties:
                tenant:
                  $ref: '#/definitions/Tenant'
                resourceId:
                  description: >
                    An identifier maintained by the VIM or other resource
                    provider. It is expected to be unique within the VIM
                    instance.
                  type: string
                vimLevelResourceType:
                  description: >
                    Type of the resource in the scope of the VIM or the resource
                    provider.
                  type: string