Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Link:
description: >
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: >
URI of the referenced resource.
type: string
format: url
Version:
description: >
A version.
type: string
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
DateTime:
description: >
Date-time stamp.
Representation: String formatted according to IETF RFC 3339.
type: string
format: "date-time"
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
DynamicNetworkAddressData:
description: >
This type represents a network address that is requested to be assigned.
type: object
required:
- numIpAddresses
properties:
macAddress:
description: >
MAC address. Shall not be present if numIPAddresses > 1. If it is not
present, it will be chosen by the VIM.
type: string
#TODO: Can we describe the syntax of this (Table 4.4.2.2-1)?
numIpAddresses:
description: >
Number of IP addresses to assign dynamically. Shall be greater than
zero.
type: integer
format: uint32
subnetId:
description: >
Subnet defined by the identifier of the subnet resource in the VIM.
In case this attribute is present, an IP addresses from that subnet
will be assigned; otherwise, IP addresses not bound to a subnet
will be assigned.
At most one of "subnetId" and "subnetIpRanges" shall be present.
$ref: "#/definitions/IdentifierInVim"
subnetIpRanges:
description: >
Subnet defined as one or more IP address ranges. In case this
attribute is present, IP addresses from one of the ranges will be
assigned; otherwise, IP addresses not bound to a subnet will be
assigned.
At most one of "subnetId" and "subnetIpRanges" shall be present.
type: array
items:
type: object
properties:
minIpAddress:
description: >
Lowest IP address belonging to the range.
type: string
#TODO: Can we describe the syntax of this (Table 4.4.2.2-1)?
maxIpAddress:
description: >
Highest IP address belonging to the range.
type: string
#TODO: Can we describe the syntax of this (Table 4.4.2.2-1)?
ExtManagedVirtualLinkData:
#SOL003 location: 4.4.1.12
type: object
required:
- id
- virtualLinkDescId
- resourceId
properties:
id:
description: >
The identifier of the externally-managed internal VL instance.
$ref: "#/definitions/Identifier"
virtualLinkDescId:
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"
ExtVirtualLinkData:
#SOL003 location: 4.4.1.11
description: >
This type represents an external VL.
type: object
required:
- id
- resourceId
- extCps
properties:
id:
description: >
The identifier of the external VL instance.
$ref: "#/definitions/Identifier"
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"
extCps:
description: >
External CPs of the VNF to be connected to this external VL.
type: array
items:
$ref: "#/definitions/VnfExtCpData"
FixedNetworkAddressData:
#SOL003 location: 4.4.1.8
description: >
This type represents a network address that is requested to be assigned.
type: object
properties:
macAddress:
description: >
MAC address. If it is not present, it will be chosen by the VIM.
At least one of "macAddress" and "ipAddress" shall be present.
type: string
#TODO: Is it possible to describe the scheme of this? (Table 4.4.2.2-1)
ipAddress:
description: >
IP address. If it is not present, no IP address will be assigned.
At least one of "macAddress" and "ipAddress" shall be present.
type: string
#TODO: Can we describe the syntax of this (Table 4.4.2.2-1)?
subnetId:
description: >
Identifier of the subnet in the VIM. This attribute may be present
if the "ipAddress" attribute is present, and shall be absent
otherwise.
$ref: "#/definitions/IdentifierInVim"
Identifier:
description: >
An identifier with the intention of being globally unique.
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
IdentifierInVnfd:
description: >
An identifier that is unique within a VNF descriptor.
type: string
KeyValuePairs:
description: >
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 key- value pairs is represented as an object. It shall comply with the provisions
defined in clause 4 of IETF RFC 7159.
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.
MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
type: string
enum:
- INSTANTIATE
- SCALE
- SCALE_TO_LEVEL
- CHANGE_FLAVOUR
- TERMINATE
- HEAL
- OPERATE
- CHANGE_EXT_CONN
- MODIFY_INFO
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
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"?
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
ResourceHandle:
required:
- vimConnectionId
- resourceId
type: object
description: >
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: >
Type of the resource in the scope of the VIM or the resource
provider.
type: string
#TODO: Note of Table 4.4.1.7-1
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
SubscriptionAuthentication:
type: object
required:
- authType
properties:
authType:
description: >
Defines the type of Authentication / Authorization to use when
sending a notification.
Permitted values:
* BASIC: In every POST request that sends a notification, use
HTTP Basic authentication with the client credentials.
* OAUTH2_CLIENT_CREDENTIALS: In every POST request that sends a
notification, use an OAuth 2.0 Bearer token, obtained using the
client credentials grant type.
type: string
enum:
- BASIC
- OAUTH2_CLIENT_CREDENTIALS
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"
Uri:
description: >
String formatted according to IETF RFC 3986.
type: string
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
VimConnectionInfo:
type: object
required:
- id
- vimType
discriminator: vimType
properties:
id:
description: >
The identifier of the VIM Connection. This identifier is managed by
the NFVO.
$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.
type: string
enum:
# These are only examples
- EXAMPLE_OPENSTACK
- EXAMPLE_VMWARE_VCLOUD
VnfExtCpData:
#SOL003 location: 4.4.1.10
description: >
This type represents an external CP.
type: object
required:
- cpdId
properties:
cpdId:
description: >
The identifier of the CPD in the VNFD.
$ref: "#/definitions/IdentifierInVnfd"
fixedAddresses:
description: >
List of (fixed) network addresses that need to be configured on the
CP. This attribute shall be present if fixed addresses need to be
configured.
type: array
items:
$ref: "#/definitions/FixedNetworkAddressData"
dynamicAddresses:
description: >
List of network addresses to be assigned dynamically. This attribute
shall be present if dynamic addresses need to be configured.
type: array
items:
$ref: "#/definitions/DynamicNetworkAddressData"
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
VnfInstanceSubscriptionFilter:
description: >
This type represents subscription filter criteria to match VNF
instances.
type: object
properties:
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:
- vnfSoftwareVersions
properties:
vnfSoftwareVersions:
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:
$ref: "#/definitions/Version"