Newer
Older
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Link:
description: >
This type represents a link to a resource using an absolute URI.
type: object
required:
- href
properties:
href:
description: >
URI of another resource referenced from a resource.
Shall be an absolute URI (i.e. a UTI that contains {apiRoot}).
$ref: "#/definitions/Uri"
NotificationLink:
description: >
This type represents a link to a resource in a notification, using an absolute or relative URI.
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"
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 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.
type: object
CertificateConfigurationData:
description: >
This type provides input information related to certificate management.
type: object
properties:
overridingCertificateProfile:
description: >
Overriding certificate profile. This overrides the certificateBaseProfile provided
in the VNFD, and the CA and CMF can additionally override aspects of this certificateBaseProfile
at later point in the VNF lifecycle if necessary to meet operator security policy.
type: array
items:
$ref: '#/definitions/CertificateBaseProfile'
securityPolicy:
description: >
Security policy to be satisfied for certificate.
type: array
items:
$ref: '#/definitions/SecurityPolicy'
cmfData:
description: >
Information for CMF.
$ref: '#/definitions/CmfData'
CmfData:
description: >
This type provides input information related to CMF for certificate management.
type: object
required:
- endPoint
- supportedProtocol
properties:
endPoint:
description: End point of CMF instance.
required:
- ipAddress
- link
description: An IP address of this end point.
$ref: '#/definitions/IpAddress'
link:
description: A link to this end point.
$ref: '#/definitions/Link'
supportedProtocol:
description: Supported protocols by CMF instance.
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
type: array
items:
type: string
enum:
- CMP
- CMPv2
- EST
- SCEP
PaasServiceHandle:
description: >
This type provides information enabling the access and use of the PaaS Service by the
VNF instance. The type and format of the handle depends on the form that the
PaaS Service is formed.
type: object
required:
- id
properties:
id:
type: string
description: >
Identifier of this PaaS Service handle.
$ref: "#/definitions/Identifier"
interfaceInfo:
description: >
Information of the interface or interfaces to the PaaS Service
instance, if applicable, such as the URI of an interface endpoint to communicate
with the PaaS Service instance.
$ref: "#/definitions/KeyValuePairs"
accessInfo:
description: >
Authentication credentials for accessing the PaaS Service instance.
If the PaasServiceHandle structure is part of an HTTP GET response
payload body, sensitive attributes that are children of this attribute
(such as passwords) shall not be included.
$ref: "#/definitions/KeyValuePairs"
extra:
description: >
PaaS Service instance specific additional information. The applicable
structure, and whether or not this attribute is available, is dependent
on the type of the PaaS Service.
$ref: "#/definitions/KeyValuePairs"
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
ResourceCapacityDefinition:
description: >
This type represents selected values for capacity related VDU attributes.
* NOTE: Resource definitions not related to a VDU are not considered in this version of the present document.
type: object
required:
- type
properties:
tag:
description:
Tag assigned by the issuer of a VNF LCM operation request that contains this data type with values to be applied to a VDU.
It is used for tracking purposes. The tag is preserved in the run time record as long as at least one value of the capacity
related attributes associated with that tag is still valid, i.e., it has not been modified by a later VNF LCM operation request.
At most one tag can be included when the data type is used in a VNF LCM operation request.
When the data type is used in the VnfInstance data type it may contain multiple tags, namely those provided in
VNF LCM requests, if at least one of the values provided in that request associated to that tag is still
applicable in the VNFCs created from this VDU, i.e., it has not been modified by a later request.
type: array
items:
$ref: "#/definitions/String"
type:
description:
Type of the resource definition referenced.
VALUES
• COMPUTE
• STORAGE
• OSCONTAINER
type: string
enum:
- COMPUTE
- STORAGE
- OSCONTAINER
vduId:
description:
Reference to the related Vdu applicable to this resource in the VNFD. It shall be present
when the referenced resource definition is related to a VDU. See note.
$ref: "#/definitions/IdentifierInVnfd"
osContainerDescData:
description:
Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the
attribute ‘type’ indicates OSCONTAINER and absent otherwise.
type: array
items:
$ref: "#/definitions/OsContainerDescData"
virtualComputeDescData:
description:
Indicates values for resource capacity related attributes in an OsContainerDesc.
It shall be present when the attribute 'type' indicates OSCONTAINER and absent otherwise.
$ref: "#/definitions/VirtualComputeDescData"
virtualStorageDescData:
description: >
Indicates the value for the storage size related attribute in an VirtualStorageDesc.
It shall be present when the attribute 'type' indicates STORAGE and absent otherwise.
type: array
items:
$ref: "#/definitions/VirtualStorageDescData"
OsContainerDescData:
description: >
This type represents selected values for capacity related VDU attributes of an OsContainer resource.
* NOTE: At least one of the attributes shall be present.
type: object
required:
- resourceTemplateId
oneOf:
- required:
- resourceTemplateId
- required:
- requestedCpuResources
- required:
- requestedMemoryResources
- required:
- requestedEphemeralStorageResources
- required:
- extendedResourceRequests
- required:
- cpuResourceLimit
- required:
- memoryResourceLimit
- required:
- ephemeralStorageResourceLimit
- required:
- hugePageResources
properties:
resourceTemplateId:
description: >
Identifier of an osContainerDesc in the VNFD.
$ref: "#/definitions/IdentifierInVnfd"
requestedCpuResources:
description: >
Number of CPU resources requested for the container in milli-CPU. See note.
type: integer
requestedMemoryResources:
description: >
Amount of memory resources requested for the container expressed in the same units as specified in the
requested_memory_resources_valid_values property in VNFD for this container descriptor. See note.
type: array
items:
$ref: "#/definitions/Number"
requestedEphemeralStorageResources:
description: >
Size of ephemeral storage resources requested for the container expressed in the same units as specified in the
requested_ephemeral_storage_resources_valid_values property VNFD.
$ref: "#/definitions/Number"
extendedResourceRequests:
description: >
Map of the amount of extended resources of the type indicated in the key.
The key is a string that identifies an extended resource indicated in the extended_resource_requests
property in the VNFD for this container descriptor.
The value is an integer that indicates the required amount for a particular extended resource.See note.
type: array
items:
type: integer
cpuResourceLimit:
description: >
Number of CPU resources the container can maximally use in milli-CPU. See note.
type: integer
memoryResourceLimit:
description: >
Amount of memory resources the container can maximally use expressed in the same units as specified in the
memory_resource_limit_valid_values property VNFD for this container descriptor. See note.
$ref: "#/definitions/Number"
ephemeralStorageResourceLimit:
description: >
Size of ephemeral storage resources the container can maximally use expressed in the same units as specified in
the ephemeral_storage_resource_limit_valid_values property VNFD for this container descriptor. See note.
$ref: "#/definitions/Number"
hugePageResources:
description: >
Map of the total size values required for all the hugepages of the size indicated in the key.
The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_resources
property in the VNFD for this container descriptor.
The value is a number that indicates the required total size expressed in the same units as in the huge_pages_resources_property
in the VNFD that indicates the valid values for required total size for the particular hugepage size.
See note.
type: array
items:
$ref: "#/definitions/Number"
VirtualComputeDescData:
description: >
This type represents selected values for capacity related VDU attributes of the virtual compute resource of a VM.
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
* NOTE: At least one of the attributes shall be present.
type: object
required:
- resourceTemplateId
oneOf:
- required:
- resourceTemplateId
- required:
- numVirtualCpu
- required:
- virtualMemSize
- required:
- sizeOfVirtualDisk
- required:
- hugePagesRequirements
properties:
resourceTemplateId:
description: >
Identifier of a VirtualComputeDesc in the VNFD.
$ref: "#/definitions/IdentifierInVnfd"
numVirtualCpu:
description: >
Number of virtual CPUs. See note.
type: integer
virtualMemSize:
description: >
Amount of virtual Memory expressed in the same units as specified in the virtual_mem_size_valid_values property
in the VNFD for this virtual compute descriptor. See note.
$ref: "#/definitions/Number"
sizeOfVirtualDisk:
description: >
Size of virtualised storage resource expressed in the same units as specified in the size_of_storage_valid_values
property in the VNFD for this virtual compute descriptor. See note.
$ref: "#/definitions/Number"
hugePagesRequirements:
description: >
Map of the total size values required for all the hugepages of the size indicated in the key.
The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_requirements
property in the VNFD for this virtual compute descriptor.
The value is a number that indicates the required total size expressed in the same units as in the huge_pages_requirements
property in the VNFD that indicates the valid values for required total size for the particular hugepage size.
See note.
type: array
items:
$ref: "#/definitions/Number"
VirtualStorageDescData:
description: >
This type represents selected values for capacity related VDU attributes of the virtual storage resource.
type: object
required:
- resourceTemplateId
- sizeOfStorage
properties:
resourceTemplateId:
description: >
Identifier of a VirtualStorageDesc in the VNFD.
$ref: "#/definitions/IdentifierInVnfd"
sizeOfStorage:
description: >
If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates BLOCK or FILE it is
the size of the virtualized storage resource, expressed in the same units as specified in the size_of_storage_valid_values
property in the VNFD.
If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates OBJECT it is the
maximum size of the virtualized storage resource expressed in the same units as specified in the max_size_of_storage_valid_values
property in the VNFD.
$ref: "#/definitions/Number"
description: >
This type provides input information related to CMF for certificate management.
type: object
required:
- id
- endPoint
- supportedProtocol
properties:
id:
description: Identifier of this CMF information.
type: string
$ref: "#/definitions/Identifier"
endPoint:
description: End point of CMF instance.
required:
- ipAddress
- link
description: An IP address of this end point.
description: A link to this end point.
description: Supported protocol by CMF instance.
type: array
items:
type: string
enum:
- CMP
- CMPv2
- EST
- SCEP
certificateChain:
description: Certificate chain that this CMF provides.
type: array
items:
$ref: '#/definitions/KeyValuePairs'
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
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"
VnfInstanceSubscriptionFilter:
description: >
This type represents subscription filter criteria to match VNF
instances.
* NOTE 1: 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.
NOTE 2: 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: object
anyOf:
- oneOf:
- required:
- required:
- vnfProductsFromProviders
- oneOf:
- required:
- vnfInstanceIds
- required:
- vnfInstanceNames
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. See note 1.
type: array
items:
$ref: "#/definitions/Identifier"
vnfProductsFromProviders:
description: >
If present, match VNF instances that belong to VNF products from
certain providers. See note 1.
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
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:
$ref: "#/definitions/Version"
vnfInstanceIds:
description: >
If present, match VNF instances with an instance identifier listed
in this attribute. See note 2.
type: array
items:
$ref: "#/definitions/Identifier"
vnfInstanceNames:
description: >
If present, match VNF instances with a VNF Instance Name listed in
this attribute. See note 2.
type: array
items:
type: string
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
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
MonitoringConnection:
description: >
The MonitoringConnection shall follow the indications.
* NOTE: The VNFM can be made aware of monitoring connection information, including their identifiers to
be used by configuration means outside the scope of the present document (e.g. using relevant NFV-MANO management
APIs as defined in ETSI GS NFV-SOL 009).
type: object
properties:
id:
description: >
Identifier of the monitoring connection. See note.
$ref: "#/definitions/Identifier"
monitoringType:
description: >
Type of monitoring way.
VALUES:
• VIM_CISM
• EXTERNAL
• PAAS
type: string
enum:
- VIM_CISM
- EXTERNAL
- PAAS
vimId:
description: >
Information about VIM or CISM connection(s) for monitoring resources for the VNF instance.
Can be set when MonitoringType is equal to “VIM_CISM”.
$ref: "#/definitions/Identifier"
paasServiceId:
description: >
Information about PaasAsset to be used. Can be set when MonitoringType is equal to “PAAS”.
$ref: "#/definitions/Identifier"
interfaceInfo:
description: >
Information about the interface(s) to the external monitoring tool, if available, including interface
endpoint e.g. URL API version, and protocol type. Can be set when MonitoringType is equal to “EXTERNAL”.
$ref: "#/definitions/KeyValuePairs"
accessInfo:
description: >
Authentication credentials for accessing the external monitoring tool. Examples can include those to support
different authentication schemes, e.g. OAuth, Token, Username/password, etc. Can be set when MonitoringType is equal to “EXTERNAL”.
$ref: "#/definitions/KeyValuePairs"
extra:
description: >
Type specific additional information, if applicable.
$ref: "#/definitions/String"
ResourceHandle:
required:
- 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.
* NOTE 1: The information about the VIM or CISM connection referenced by the VIM connection id is known to the
VNFM. Moreover, the identifier of the VIM connection provides scope to the resourceId.
* NOTE 2: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or CISM or the resource
provider and can be used as information that complements the ResourceHandle. When the container
infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would
correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod,
PersistentVolumeClaim, NetworkAttachmentDefinition.
* NOTE 3: When the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the
following way:
- For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide
- For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim,
i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by
Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own
- For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of
the 'metadata.name' field in Kubernetes® manifest.
properties:
vimConnectionId:
description: >
Identifier of the VIM or CISM connection to manage the resource.
This attribute shall be supported when the resource is managed by a CISM.
When the resource is managed by a VIM, this attribute shall only be supported and present if VNF-related
resource management in direct mode is applicable.
$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
CISM or the resource provider. See note 3.
$ref: "#/definitions/IdentifierInVim"
vimLevelResourceType:
description: >
Type of the resource in the scope of the VIM or the CISM
or the resource provider. See note 2.
type: string
vimLevelAdditionalResourceInfo:
Additional resource information which is specific to this
resource and its type, and which is available from the
VIM or the CISM or the resource provider.
$ref: "#/definitions/AdditionalResourceInfo"
containerNamespace:
description: >
The value of the namespace in which the MCIO
corresponding to the resource is deployed.
This attribute shall be present if the resource is managed
by a CISM and it shall be absent otherwise.
type: string
VnfExtCpData:
description: >
This type represents configuration information for external CPs created.
* NOTE 1: 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.
* NOTE 2: 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.
* NOTE 3: 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 "VnfExtCpData" structure from
its parent data structure.
* NOTE 4: If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or
"ChangeCurrentVnfPkg" operation, a cpConfig map entry identified by a particular map key value
is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig
map entry may be used by an external CP instance different than the one that has used it before the
operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg"
operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure.
* NOTE 5: Subports need not be used for containerized VNFCs. The application container can send and receive IP
packets with any VLAN tag as long as the network interface to connect to the secondary container cluster
network has been configured appropriately. Thus, no individual cpConfig, except the one representing the
trunk, need be modelled to allow traffic tagged with a particular VLAN through the connection point.
* NOTE 6: In the case that the cloud native template included in the MCIOP describes the set of VNFC instances, for
containerized VNFCs individual connection points need not be configured for each VNFC instance. It is only
required to configure one "cpConfig" per "cpdId", not per VNFC instance. The case of using, for a scalable
VDU, a cloud native template in the MCIOP that describes one single VNFC instance is not specified in the
present document version.
type: object
required:
- cpdId
properties:
cpdId:
description: >
The identifier of the CPD in the VNFD. See note 1.
$ref: "#/definitions/IdentifierInVnfd"
cpConfig:
description: >
Map of instance data that need to be configured on the CP instances
created from the respective CPD.
The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf"
The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
type: object
additionalProperties:
$ref: "#/definitions/VnfExtCpConfig"
VnfExtCpConfig:
description: >
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
This type represents an externally provided link port, or a network attachment definition resource of secondary
container cluster network, or network address information per instance of an external connection point.
In the case of VM-based deployment of the VNFC exposing the external CP:
1. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the
external VL.
2. In case 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.
In the case of container-based deployment of the VNFC exposing the external CP, the VNFM shall use the network
attachment definition resource of secondary container cluster network when connecting the CP to the external VL.
* NOTE 1: The following conditions apply to the attributes "linkPortId" and "cpProtocolData" for an external CP
instance connected or to be connected to a virtual network not categorized as secondary container cluster network:
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.
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
precreated 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 NFVO shall ensure that the
cpProtocolData can be used with the pre-created link port referenced by "linkPortId".
* NOTE 2: The following conditions apply to the attributes “netAttDefResourceId” and “cpProtocolData” for an external CP
instance connected or to be connected to a secondary container cluster network:
2) The "netAttDefResourceId" attribute shall be present and the "cpProtocolData" attribute may be present for
a to-be-created external CP instance or an existing external CP instance.
* NOTE 3: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment
definition resource is needed to fulfil the connectivity requirements of the external CP, e.g. to build a link
redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall belong
to the same namespace as defined by the corresponding "containerNamespace" attribute in the "resourceHandle" attribute
in the "NetAttDefResourceData".
* NOTE 4: Either linkPortId or netAttDefResourceId may be included, but not both.
anyOf:
- required:
- linkPortId
- required:
- cpProtocolData
- required:
- netAttDefResourceId
type: object
properties:
parentCpConfigId:
description: >
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
a trunk, and if parent ports are supported.
$ref: "#/definitions/IdentifierInVnf"
linkPortId:
description: >
Identifier of a pre-configured link port to which the external CP
will be associated. See notes 1 and 4.
$ref: "#/definitions/Identifier"
createExtLinkPort:
description: >
Indicates to the VNFM the need to create a dedicated link port for the external CP.
If set to True, the VNFM shall create a link port.
If set to False, the VNFM shall not create a link port.
This attribute is only applicable for external CP instances without a floating IP address that expose a VIP CP
instance for which a dedicated IP address is allocated. It shall be present in that case and shall be absent otherwise.
type: boolean
cpProtocolData:
description: >
Parameters for configuring the network protocols on the
link port that connects the CP to a VL. See notes 1 and 2.
type: array
items:
$ref: "#/definitions/CpProtocolData"
netAttDefResourceId:
description: >
Identifier of the “NetAttDefResourceData” structure that
provides the specification of the interface to attach the
external CP to a secondary container cluster network.
It is only applicable if the external CP is connected or to
be connected to a secondary container cluster network. It
shall not be present if the external CP is related to a
virtual network not categorized as secondary container
cluster network.
See notes 2, 3 and 4.
type: array
items:
$ref: "#/definitions/Identifier"
CpProtocolData:
description: >
This type represents network protocol data.
* NOTE: 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.
layerProtocol:
description: >
Identifier of layer(s) and protocol(s).
Permitted values:
- IP_OVER_ETHERNET.
- IP_FOR_VIRTUAL_CP
See note
ipOverEthernet:
description: >
Network address data for IP over Ethernet to assign to the external CP
instance. Shall be present if layerProtocol is equal to
"IP_OVER_ETHERNET", and shall be absent otherwise.
$ref: "#/definitions/IpOverEthernetAddressData"
virtualCpAddress:
description: >
IP address data to assign to an external CP
instance exposing a virtual CP. It shall be
present if layerProtocol is equal to
“IP_FOR_VIRTUAL_CP” and the external CP
instance exposes a virtual CP and shall not be
present otherwise.
$ref: "#/definitions/VirtualCpAddressData"
IpOverEthernetAddressData:
description: >
This type represents network address data for IP over Ethernet.
* NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present.
* NOTE 2: Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present.
* NOTE 3: If the CP instance represents a subport in a trunk, segmentationId shall be present.
Otherwise it shall not be present.
* NOTE 4: 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: object
anyOf:
- required:
- macAddress
- required:
- ipAddresses
properties:
macAddress:
description: >
MAC address. If this attribute is not present, it shall be chosen by
$ref: "#/definitions/MacAddress"
segmentationType:
description: >
Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
Permitted values:
- VLAN: the subport uses VLAN as encapsulation type.
- INHERIT: the subport gets its segmentation type from the network it’s connected to.
This attribute may be present for CP instances that represent subports in a trunk and shall be
absent otherwise. If this attribute is not present for a subport CP instance, default value VLAN shall be used.
type: string
enum:
- VLAN
- INHERIT
segmentationId:
description: >
Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
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. See note 1.
type: array
items:
type: object
required:
- type
oneOf:
- required:
- fixedAddresses
- required:
- numDynamicAddresses
- required:
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). See note 2.
type: array
items:
$ref: "#/definitions/IpAddress"
numDynamicAddresses:
description: >
Number of dynamic addresses to assign (from the subnet defined
by "subnetId" if provided). See note 2.
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. See note 2.
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"
VirtualCpAddressData:
description: >
This type represents network address data for a virtual CP.
* NOTE 1: The loadBalancerIp and the loadBalancerSourceRanges attributes are only used if the
CIS cluster is set up to be able to configure an external load balancer. Otherwise, it shall be ignored.
* NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container
cluster will assign an IP address.
* NOTE 3: The attribute is only relevant if the virtual CP is instantiated in a cluster that supports configuration of IP
address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for
Kubernetes® that supports configuration of address pools for load balancer services.
* NOTE 4: The loadBalancerIp, addressPoolName and the externalIp attributes shall not be present at the same time.
type: object
required:
- type
properties:
type:
description: >
The type of the IP addresses.
Permitted values: IPV4, IPV6.
type: string
enum:
- IPV4
- IPV6
loadBalancerIp:
Fixed address to assign to an external load balancer.
externalIp:
description: >
An external IP address assigned to the virtual CP. This IP address is not managed by CISM. See note 4.
$ref: "#/definitions/IpAddress"
Name of an address pool from which the CIS cluster will assign an IP address to the virtual CP. See notes 3 and 4.
loadBalancerSourceRanges:
description: >
List of client IP address ranges allowed to access an external load balancer. See note 1.
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"
ExtVirtualLinkData:
This type represents an external VL.
* NOTE 1: The information about the VIM connection referenced by the VIM connection id is known to the VNFM.
Moreover, the identifier of the VIM connection provides scope to the resourceId.
Ikram Haq
committed
* NOTE 2: A link port is not needed for an external CP instance that exposes a CP in the following cases:
1) For a virtual IP CP directly exposed as an external CP:
1.1) No dedicated IP address is allocated as virtual IP address, as indicated in the VNFD.
1.2) A dedicated IP address is allocated as virtual IP address, but the NFVO indicates that no port is
needed (createExtLinkPort in VnfExtCpconfig set to false).
2) For a virtual IP CP exposed as an external CP via a floating IP address:
2.1) No dedicated IP address is allocated as virtual IP address, as indicated in the VNFD, and the VNFC
CP associated to the virtual IP CP is also exposed via a floating IP address.
3) For a VIRTUAL CP exposed as an external CP.
4) For a VNFC CP exposed as an external CP in a secondary container cluster external network.
* NOTE 3: An example of the network attachment definition resource when the container infrastructure service
management is a Kubernetes® instance is a network attachment definition (NAD).
- resourceId
- extCps
The identifier of the external VL instance. The identifier is
assigned by the NFV-MANO entity that manages this VL instance.
$ref: "#/definitions/Identifier"
vimConnectionId:
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. See note 1.
$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. Entries in the list of external
CP data that are unchanged need not be supplied if the ExtVirtualLinkData structure is part
of a request or response that modifies the external connectivity.
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 except in the cases defined
type: array
items:
$ref: "#/definitions/ExtLinkPortData"
Externally provided network attachment definition
resource(s) that provide the specification of the interface
to attach external CPs to this external VL. See note 3.
It is only applicable if the external VL is realized by a
secondary container cluster network. It shall not be
present otherwise.
type: array
items:
$ref: "#/definitions/NetAttDefResourceData"
ScaleInfo:
description: >
This type represents the scale level of a VNF instance related to a scaling aspect.
type: object
required:
- aspectId
- scaleLevel
properties:
aspectId:
description: >
Identifier of the scaling aspect.
$ref: "#/definitions/IdentifierInVnfd"
vnfdId:
description: >
Identifier of the VNFD.
Shall be present in case the value differs from the vnfdId
attribute of the VnfInstance (e.g. during a "Change
current VNF package" operation or due to its final
failure).
$ref: "#/definitions/Identifier"
scaleLevel:
description: >
Indicates the scale level. The minimum value shall be 0
and the maximum value shall be <= maxScaleLevel as
AdditionalResourceInfo:
description: >
This type represents additional resource information which resource and resource type
specific, and which is available from the VIM or the CISM or the resource provider.
* NOTE: At least one attribute shall be present.
type: object
properties:
hostName:
description: >
Name of the host where the resource is allocated. It shall
be present for compute resources in the scope of the
CISM and shall be absent otherwise. See note.
type: string
persistentVolume:
description: >
Name of the persistent volume to which the persistent
volume claim representing the storage resource is bound.
It may be present for storage resources in the scope of
the CISM and shall be absent otherwise. See note.
type: string
additionalInfo:
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
description: >
Information related to other properties directly owned by
the resource and available from the VIM or CISM or the
resource provider. See note.
$ref: "#/definitions/KeyValuePairs"
NetAttDefResourceData:
description: >
This type represents a network attachment definition resource that provides the specification of
the interface to be used to connect one or multiple connection points to a secondary container
cluster network realizing a VL.
type: object
required:
- netAttDefResourceId
- resourceHandle
properties:
netAttDefResourceId:
description: >
Identifier of this network attachment definition resource
as provided by the entity that has created it.
$ref: "#/definitions/Identifier"
resourceHandle:
description: >
Resource handle of the resource identifying the network
attachment definition resource that provides the
specification of the interface to attach the connection
points to a secondary container cluster network.
$ref: "#/definitions/ResourceHandle"
Identifier:
An identifier with the intention of being globally unique.
type: string
AffectedCertificate:
description: >
This type provides input information about added, deleted and modified certificate contents.
type: object
required:
- certificateInfoId
- changeType
properties:
certificateInfoId:
description: >
Identifier of certificate information.
$ref: "#/definitions/Identifier"
certificateBaseProfileId:
description: >
Identifier of certificate base profile.
$ref: "#/definitions/Identifier"
securityPolicyId:
description: >
Identifier of security policy.
$ref: "#/definitions/Identifier"
cmfInfoId:
description: >
Identifier of CMF information.
$ref: "#/definitions/Identifier"
certificateContentId:
description: >
Identifier of certificate content.
$ref: "#/definitions/Identifier"
changeType:
description: >
Signals the type of change.
type: string
enum:
- ADD
- REMOVE
- MODIFY
CertificateInfo:
description: >
Represents information about certificates, including configuration details and contents.
type: object
required:
- id
properties:
id:
description: >
Identifier of this certificate information.
$ref: "#/definitions/Identifier"
certificateConfigurationInfo:
description: >
Configuration for certificate management such as certificate profile, information of CMF, and security policy.
$ref: '#/definitions/CertificateConfigurationInfo'
certificateContents:
description: >
Information for contents of issued certificates. The information contained in this attribute may be
updated over time during the VNF LCM, e.g., certificate(s) renewal.
type: array
items:
$ref: '#/definitions/CertificateContent'
CertificateContent:
description: >
This type provides input information related to certificate content.
type: object
required:
- id
- certificateDescId
- certificateType
properties:
id:
description: Identifier of this certificate.
$ref: "#/definitions/Identifier"
certficateDescId:
description: Identifier of certificate description in VNFD to be used to issue this certificate.
$ref: "#/definitions/IdentifierInVnfd"
certificateType:
description: Type of this certificate.
enum:
- VNFCI_CERT
- VNFOAM_CERT
supportedCertificateManagements:
description: Describes supported certificate management information.
$ref: "#/definitions/KeyValuePairs"
version:
description: Version of this certificate.
$ref: "#/definitions/Version"
serialNumber:
description: Serial number of this certificate.
description: Algorithm of this certificate's signature.
description: Issuer of this certificate.
type: string
description: Start date of valid period for this certificate.
$ref: "#/definitions/DateTime"
description: End date of valid period for this certificate.
$ref: "#/definitions/DateTime"
description: Subject of this certificate.
type: string
description: Algorithm of this certificate's public key.
description: Public key of this certificate.
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
certificateExtensions:
$ref: "#/definitions/KeyValuePairs"
description: Extension of this certificate.
CertificateConfigurationInfo:
description: >
This type provides input information related to certificate management.
type: object
required:
- securityPolicy
properties:
certificateBaseProfile:
description: >
Information for certificate profile.
type: array
$ref: "#/definitions/CertificateBaseProfile"
securityPolicy:
description: >
Information for security policy to be satisfied for certificate.
type: array
items:
$ref: "#/definitions/SecurityPolicy"
delegationSupportedCertificateManagements:
description: >
Describes supported certificate management information.
$ref: "#/definitions/KeyValuePairs"
cmfInfo:
description: >
Information of CMF.
type: object
$ref: "#/definitions/CmfInfo"
SecurityPolicy:
description: >
This type provides input information related to security policy for certificate management.
description: Identifier of this security policy.
type: string
$ref: "#/definitions/Identifier"
maxValidityPeriod:
description: Allowed max validity period for certificates.
type: integer
allowedAlgorithm:
description: Allowed signature algorithm.
type: string
minimumKeyLength:
description: Minimum key length for certificates.
type: integer
CertificateBaseProfile:
description: >
This type provides input information to override certificate base profile for
certificate management
NOTE : At least one overriding attributes shall be present, otherwise shall be absent.
required:
- id
properties:
description: The identifier of this certificate profile.
type: string
$ref: "#/definitions/Identifier"
issuer:
type: string
description: Issuer of certificates. See note.
issuerUniqueIdentifier:
type: string
description: Identifier of this issuer of certificates. See note.
$ref: "#/definitions/Identifier"
subject:
description: Subject of certificates. See note.
$ref: '#/definitions/CertSubjectData'
subjectUniqueIdentifier:
description: Identifier of this subject of certificates. See note.
type: string
$ref: "#/definitions/Identifier"
basicConstraints:
type: string
description: >
Basic constraints of certificates. See note.
issuerAltName:
description: Alternative name of issuer of certificates in this NS. See note.
description: Alternative name of subject of certificates. Shall be present when this certificate is used for encrypted
communication using IP address and subjectAltName attribute of CertificateBaseProfile in CertificateDesc of
VNFD is empty (see ETSI GS NFV-IFA 011 [7],clause 7.1.19.4). See note
description: Name constraints of certificates. See note.
type: string
CertSubjectData:
description: >
This type provides input information related to subject of certificate.
* NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
type: object
properties:
commonName:
description: Information of certification target subject FQDN. See note.
description: Information of certification target subject Organization. See note.
description: Information of certification target subject Country. See note.
description: Information of certification target subject State. See note.
description: Information of certification target subject Locality. See note.
description: Information of certification contact email address. See note.
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
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
UnsignedInt:
description: >
Unsigned integer number
type: integer
minimum: 0
IdentifierInVnfd:
description: >
An identifier that is unique within a VNF descriptor.
type: string
IdentifierInVim:
description: >
An identifier maintained by the VIM or the CISM 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
Checksum: #no definition found
description: >
Cheksum description
type: string
########################################################################################################################
# TO CHECK IF INCLUDE THESE DATA TYPES IN ANOTHER DEF FILES
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"
ExtLinkPortData:
description: >
This type represents an externally provided link port to be used to
connect an external connection point to an external VL.
* NOTE: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
type: object
required:
- id
- resourceHandle
properties:
id:
Identifier of this link port as provided by the entity that has
created the link port.
$ref: "#/definitions/Identifier"
resourceHandle:
Reference to the virtualised resource realizing this link port.
$ref: "#/definitions/ResourceHandle"
trunkResourceId:
description: >
Identifier of the trunk resource in the VIM.
Shall be present if the present link port corresponds to the parent
port that the trunk resource is associated with. See note.
$ref: "#/definitions/IdentifierInVim"
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.
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.
type: string
enum:
- INSTANTIATE
- SCALE
- SCALE_TO_LEVEL
- CHANGE_FLAVOUR
- TERMINATE
- HEAL
- OPERATE
- CHANGE_EXT_CONN
- CHANGE_VNFPKG
- CREATE_SNAPSHOT
- REVERT_TO_SNAPSHOT
LcmOperationType:
description: >
The enumeration LcmOpType defines the permitted values to represent
VNF lifecycle operation types in VNF lifecycle management operation
occurrence resources and VNF lifecycle management operation occurrence
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.
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.
SELECT_DEPL_MODS | Represents the "Select VNF deployable modules" LCM operation
type: string
enum:
- INSTANTIATE
- SCALE
- SCALE_TO_LEVEL
- CHANGE_FLAVOUR
- TERMINATE
- HEAL
- OPERATE
- CHANGE_EXT_CONN
- CREATE_SNAPSHOT
- REVERT_TO_SNAPSHOT
- CHANGE_VNFPKG
ProblemDetails:
#SOL003 location: 4.3.5.3
description: >
The definition of the general "ProblemDetails" data structure from
IETF RFC 7807 is reproduced inthis structure. Compared to the
general framework defined in IETF RFC 7807, 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 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
type: object
required:
- status
- detail
properties:
type:
description: >
A URI reference according to IETF RFC 3986 that identifies the
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
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"?
* NOTE 1 : 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.
* NOTE 2: As a less secure alternative to OAUTH2_CLIENT_CERT which uses mutual authentication based on X.509
certificates, this mode which uses client password to authenticate may be used in the access token request
toward the authorization server (as defined by IETF RFC 6749 [7]), only to support legacy implementations
(version 3.4.1 or earlier version of the present document). See clause 8.1 for more details.
* NOTE 3: The following values that were included up to version 3.4.1 of the present document have been removed:
"BASIC" (to signal the use of the basic HTTP authentication) has been removed because it is insecure.
"TLS_CERT" to signal an alternative non-token based authorization method using TLS certificates has been
removed because the method is no longer supported.
* NOTE 4: The client certificate is established by means outside the scope of the present document.
Defines the types of Authentication / Authorization which the API
consumer is willing to accept when receiving a notification.
Permitted values (see note 3):
* OAUTH2_CLIENT_CREDENTIALS: In every
HTTP request to the notification endpoint, use
an OAuth 2.0 token, obtained using the client
credentials grant type after authenticating
using client identifier and client password
towards the token endpoint.
* OAUTH2_CLIENT_CERT: In every HTTP
request to the notification endpoint, use an
OAuth 2.0 token, obtained using the client
credentials grant type after mutually
authenticating using client identifier and X.509
certificates towards the token endpoint.
type: string
enum:
- OAUTH2_CLIENT_CREDENTIALS
- OAUTH2_CLIENT_CERT
paramsOauth2ClientCert:
Parameters for authentication/authorization using
OAUTH2_CLIENT_CERT.
Shall be present if authType is "OAUTH2_CLIENT_CERT" and the contained
information has not been provisioned out of band.
Shall be absent otherwise.
type: object
required:
- clientId
- certificateRef
- tokenEndpoint
clientId:
Client identifier to be used in the access token request
of the OAuth 2.0 client credentials grant type. The client
identifier is unique in the scope of the tokenEndpoint.
certificateRef:
Fingerprint of the client certificate. The hash function
shall use SHA256 or higher. See note 4.
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
required:
- type
- value
properties:
type:
description: >
The type of the fingerprint.
Permitted values:
- x5t#S256: The SHA-256 thumbprint of the
X.509 certificate as defined in section 4.1.8 of
IETF RFC 7515 [23].
$ref: "#/definitions/String"
enum:
- x5t#S256
value:
description: >
The fingerprint value as defined by the type.
$ref: "#/definitions/String"
tokenEndpoint:
description: >
The token endpoint from which the access token can be
obtained.
$ref: "#/definitions/Uri"
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.
See note 2.
type: object
properties:
clientId:
description: >
Client identifier to be used in the access token request
of the OAuth 2.0 client credentials grant type. The client
identifier is unique in the scope of the tokenEndpoint.
Shall be present if it has not been provisioned out of
band.
See note 1.
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. See
note 1.
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"
LcmCoordResultType:
description: >
The enumeration LcmCoordResultType defines the permitted values
to represent the result of executing an LCM coordination action.
The coordination result also implies the action to be performed by
the VNFM as the follow-up to this coordination.
Value | Description
------|------------
CONTINUE | The related LCM operation shall be continued, staying in the state "PROCESSING".
ABORT | The related LCM operation shall be aborted by transitioning into the state "FAILED_TEMP".
CANCELLED | The coordination action has been cancelled upon request of the API consumer, i.e. the VNFM.
The related LCM operation shall be aborted by transitioning into the state "FAILED_TEMP".
type: string
enum:
- CONTINUE
- ABORT
- CANCELLED
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
LcmOperationForCoordType:
description: >
The enumeration LcmOperationForCoordType defines the permitted values to
represent VNF lifecycle operation types in VNF LCM operation coordination actions.
* 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.
* 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.
type: string
enum:
- INSTANTIATE
- SCALE
- SCALE_TO_LEVEL
- CHANGE_FLAVOUR
- TERMINATE
- HEAL
- OPERATE
- CHANGE_EXT_CONN
- MODIFY_INFO
- CREATE_SNAPSHOT
- REVERT_TO_SNAPSHOT
- CHANGE_VNFPKG