Newer
Older
schemas:
ManoEntity:
description: >
This type represents an NFV-MANO functional entity.
* NOTE 1: It shall be present when "type" attribute is "NFVO", and it shall be absent in any other case.
* NOTE 2: It shall be present when "type" attribute is "VNFM", and it shall be absent in any other case.
* NOTE 3: It shall be present when "type" attribute is "VIM", and it shall be absent in any other case.
* NOTE 4: The information about the NFV-MANO services offered by a specific type of NFV-MANO functional
entity is specified by the manoServices attribute.
* NOTE 5: It is optional for the API producer to support the "manoEntityComponents" attribute.
* NOTE 6: It shall be present when "type" attribute is "WIM", and it shall be absent in any other case.
* NOTE 7: It shall be present when "type" attribute is "CISM", and it shall be absent in any other case.
type: object
required:
- id
- type
- name
- description
- provider
- softwareVersion
- manoConfigurableParams
- manoApplicationState
- _links
properties:
id:
description: >
Identifier of the NFV-MANO functional entity. The identifier shall be set during
the initial deployment of the NFV-MANO functional entity and its value allocated
based on network operator policies. The value of this identifier shall be unique
at least in the scope of the NFV-MANO deployment.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
type:
description: >
Type of NFV-MANO functional entity.
$ref: "#/definitions/schemas/ManoEntityEnumType"
name:
description: >
Human-readable name of the NFV-MANO functional entity.
This attribute can be modified with the PATCH method.
type: string
description:
description: >
Human-readable description of the NFV-MANO functional entity.
This attribute can be modified with the PATCH method.
type: string
provider:
description: >
Information about the provider of the NFV-MANO functional entity.
It typically includes the name of the provider.
type: string
softwareVersion:
description: >
The version of the software of the NFV-MANO functional entity.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
softwareInfo:
description: >
Additional information about the software used to realize the NFV-MANO
functional entity. For instance, the attribute can provide information
about sourced software and corresponding release(s) used to build the
entity’s software.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
manoEntityComponents:
description: >
The deployed NFV-MANO functional entity components which realize the
NFV-MANO functional entity. See note 5.
type: array
items:
$ref: "#/definitions/schemas/ManoEntityComponent"
minItems: 0
manoServices:
description: >
Information about the NFV-MANO services provided by the NFV-MANO
functional entity.
type: array
items:
$ref: "#/definitions/schemas/ManoService"
minItems: 1
manoConfigurableParams:
description: >
Information and current values of the configurable parameters.
This attribute can be modified with the PATCH method.
$ref: "#/definitions/schemas/ManoConfigurableParams"
manoApplicationState:
description: >
Information and current values of the NFV-MANO functional entity’s application state.
type: object
required:
- operationalState
- administrativeState
- usageState
properties:
operationalState:
description: >
The operational state of the NFV-MANO functional entity application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
administrativeState:
description: >
The administrative state of the NFV-MANO functional entity application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
usageState:
description: >
The usage state of the NFV-MANO functional entity application.
$ref: "#/definitions/schemas/UsageStateEnumType"
nfvoSpecificInfo:
description: >
The information specific to an NFVO entity. See note 1 and not 4.
$ref: "#/definitions/schemas/NfvoSpecificInfo"
vnfmSpecificInfo:
description: >
The information specific to a VNFM entity. See note 2 and not 4.
$ref: "#/definitions/schemas/VnfmSpecificInfo"
vimSpecificInfo:
description: >
The information specific to an VIM entity. See note 3 and not 4.
$ref: "#/definitions/schemas/VimSpecificInfo"
wimSpecificInfo:
description: >
The information specific to a WIM entity. See notes 4 and note 6.
$ref: "#/definitions/schemas/WimSpecificInfo"
cismSpecificInfo:
description: >
The information specific to a CISM entity, See notes 4 and 7.
$ref: "#/definitions/schemas/CismSpecificInfo"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- manoServiceInterfaces
- peerEntities
- changeState
- changeStateOpOccs
properties:
self:
description: URI of this resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
manoServiceInterfaces:
description: Link to the "NFV-MANO service interfaces" resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
peerEntities:
description: Link to "Peer entities" resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
changeState:
description: Link to the "Change state" task resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
changeStateOpOccs:
description: Link to the "Change state operation occurrences" resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
CismSpecificInfo:
description: >
This type represents information attributes specific to a CISM entity, and that
can be relevant to more than one NFV-MANO service offered by a CISM entity. It
shall comply with the provisions defined in table 5.6.3.14-1.
NOTE: No attributes are specified in the present document version. The definition of attributes is left for future specification.
type: object
properties:
none:
type: object
ManoConfigModificationRequest:
description: >
This type represents attribute modifications for configuration parameters
of an NFV-MANO functional entity.
* NOTE: At least one of these attributes shall be provided if requesting a modification
of the NFV-MANO service identified by "id".
type: object
properties:
name:
description: >
New value of the "name" attribute in "ManoEntity".
type: string
description:
description: >
New value of the "description" attribute in "ManoEntity".
type: string
clockSyncs:
description: >
Modifications of the "clockSyncs" attribute in the "ManoEntityConfigurableParams".
If present, these modifications shall be applied according to the rules of JSON Merge PATCH
(see IETF RFC 7396).
type: object
additionalProperties:
$ref: "#/definitions/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue:
description: >
New value of the "defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
New value of the "defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
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
manoServiceModifications:
description: >
New content of certain entries in the "manoServices" attribute array
in the "ManoEntity", as defined below this table.
The following provisions shall apply when modifying an attribute that is an array of structured
"manoServiceModifications".
Assumptions:
A) "oldList" is the array to be modified, "newList" is the array that contains the changes.
B) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList".
C) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that has the same
content of "id" attribute as the "newEntry".
D) In any array of objects, the content of "id" is unique (i.e. there are no two entries
with the same content of "id").
Provisions:
1) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList", the values of
the sub-attributes of "oldEntry" shall be replaced by the value of the sub-attributes in the "newEntry".
2) If the "newEntry" in "newList" has no corresponding "oldEntry" in "oldList" (i.e. the "id" is
not found), the modification operation will fail as a whole and an error message shall be raised.
type: array
items:
type: object
required:
- id
properties:
id:
description: >
Identifier of the NFV-MANO service to modify.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
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
name:
description: >
New value for the "name" attribute in the "ManoService". See note.
type: string
description:
description: >
New value for the "description" attribute in the "ManoService". See note.
type: string
ManoConfigModifications:
description: >
This type represents attribute modifications that were performed on the
"NFV-MANO entity" resource of the producer NFV-MANO functional entity.
The attributes that can be included consist of those requested to be
modified explicitly in the "ManoConfigModificationRequest" data structure.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name"
attribute in "ManoEntity", as defined in clause 5.6.2.3
type: string
description:
description: >
If present, this attribute signals modifications of the "description"
attribute in "ManoEntity", as defined in clause 5.6.2.3.
type: string
clockSyncs:
description: >
If present, this attribute signals modifications of the "clockSyncs" attribute in
"ManoEntityConfigurableParams", as defined in clause 5.6.2.3.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
manoServiceModifications:
description: >
If present, this attribute signals modifications of the "manoServices"
attribute array in the "ManoEntity", as defined in clause 5.6.2.3.
type: array
items:
type: object
properties:
id:
description: >
Identifier of the NFV-MANO service that has been modified.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
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
name:
description: >
If present, this attribute signals modification of the "name"
attribute in the "ManoService".
type: string
description:
description: >
If present, this attribute signals modification of the
"description" attribute in the "ManoService".
type: string
required:
- id
CimSubscriptionRequest:
description: >
This type represents a subscription request related to notifications
about NFV-MANO configuration and information management changes.
type: object
required:
- callbackUri
properties:
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/definitions/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/SubscriptionAuthentication"
CimSubscription:
description: >
This type represents a subscription related to notifications about
NFV-MANO configuration and information management changes
type: object
required:
- id
- callbackUri
- _links
properties:
id:
description: >
Identifier that identifies the subscription
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/definitions/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
properties:
self:
description: >
URI of this resource.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
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
required:
- self
ChangeStateRequest:
description: >
This type represents request parameters for changing the state of a managed entity.
* NOTE 1: In the present document version, a request shall only include an operational state change
(attribute "operationalStateChange") or an administrative state change request (attribute
"administrativeStateChange"), but not both.
* NOTE 2: The "stopType" shall only be provided when the "operationalStateAction" attribute is equal
to "STOP" or "RESTART". The "gracefulStopTimeout" shall be absent when the "stopType" attribute
is equal to "FORCEFUL", and may be provided otherwise.
type: object
properties:
operationalStateChange:
description: >
A change of operational state. Shall be present if the state change request
refers to the operational state. See note 1.
but not both.
type: object
properties:
operationalStateAction:
description: >
The desired operation state to change the managed object to. In case of
changing the state of an NFV-MANO service interface the value
"RESTART" shall not be used.
$ref: "#/definitions/schemas/ChangeOperationalStateEnumType"
stopType:
description: >
It signals the type of stop. See note 2.
$ref: "#/definitions/schemas/StopEnumType"
gracefulStopTimeout:
description: >
The time internal (in seconds) to wait for the entity to be taken out
of service during graceful stop. See note 2.
type: integer
required:
- operationalStateAction
administrativeStateChange:
description: >
A change of administrative state. Shall be present if the state change request
refers to the administrative state. See note 1.
but not both.
type: object
required:
- administrativeStateAction
properties:
administrativeStateAction:
description: >
The desired administrative state to change the managed object to.
$ref: "#/definitions/schemas/ChangeAdministrativeStateEnumType"
ChangeStateOpOcc:
description: >
This type represents a Change state operation occurrence.
type: object
required:
- id
- operationState
- stateEnteredTime
- startTime
- managedObjectRef
properties:
id:
description: >
Identifier of this change state operation occurrence.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
operationState:
description: >
The state of the "change state operation occurrence".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ChangeStateOpOccStateEnumType"
stateEnteredTime:
description: >
Date-time when the current state was entered.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
managedObjectRef:
description: >
Reference of the managed object to which the change state operation
occurrence relates. The value of the "type" attribute shall be
"MANO_ENTITY" or "MANO_SERVICE_IF".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference"
changeOperationalStateRequest:
description: >
The type of the change of operational state that was requested. Shall
be present if the change of state operation triggered a change of
operational state.
$ref: "#/definitions/schemas/ChangeOperationalStateEnumType"
changeAdministrativeStateRequest:
description: >
The type of the change of administrative state that was requested. Shall
be present if the change of state operation triggered a change of
administrative state.
$ref: "#/definitions/schemas/ChangeAdministrativeStateEnumType"
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
operationParams:
description: >
Input parameters of the change state operation. This attribute shall be
formatted according to the request data type of the related change state
operation.
The following mapping between operationType and the data type of this
attribute shall apply:
- CHANGE_STATE: ChangeStateRequest
This attribute shall be present if this data type is returned in a response
to reading an individual resource, and may be present according to the chosen
attribute selector parameter if this data type is returned in a response to
a query of a container resource.
ManoServiceInterface:
description: >
This type represents an individual NFV-MANO service interface produced by
an NFV-MANO functional entity.
* NOTE 1: The information to be provided in this attribute shall relate to the specification and
version of the specification. For instance, "ETSI GS NFV-SOL 003 (V2.4.1)".
* NOTE 2: If this attribute is not present, the value of this parameter is undefined. Overload is
handled by the error handling schemes defined by the applicable API specification.
* NOTE 3: Due to the security sensitive information associated to the attribute, based on access
control policies, the API consumer might have read only, write only, read/write, or no access
at all to the attribute's value. In case the API consumer is not allowed to read the value of
the security sensitive attribute, the attribute shall be omitted when the information is to be
provided in a response message, and shall be provided otherwise. In case the API consumer is
not allowed to modify the value of the security sensitive attribute, and the modification request
includes new attribute values, the whole modification request shall be rejected, and proper
error information returned.
type: object
required:
- id
- name
- type
- standardVersion
- providerSpecificApiVersion
- apiVersion
- apiEndpoint
- supportedOperations
- interfaceState
properties:
id:
description: >
Identifier of the NFV-MANO functional entity interface.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
name:
description: >
Human-readable name of the NFV-MANO functional entity interface.
This attribute can be modified with the PATCH method.
type: string
type:
description: >
Type of the NFV-MANO service interface produced by the NFV-MANO functional
entity. Valid values are defined in clause 5.6.4.3.
type: string
standardVersion:
description: >
Version of the standard the interface is compliant to. See note 1.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
providerSpecificApiVersion:
description: >
Provider-specific software API version.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
apiVersion:
description: >
API version, in compliance with the version identifiers and parameters
format specified in clause 9.1 of ETSI GS NFV-SOL 013.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
apiEndpoint:
description: >
Exposed API endpoint of the interface.
type: object
properties:
apiRoot:
description: >
Indicates the scheme ("http" or "https"), the host name and optional port,
and an optional sequence of path segments that together represent a prefix
path. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
This attribute can be modified with the PATCH method.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
apiName:
description: >
Indicates the interface name in an abbreviated form. Shall be present
for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each
interface is defined in the standard the interface is compliant to
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiMajorVersion:
description: >
Indicates the current major version of the API. Shall be present for
ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined
in the standard the interface is compliant to (see also clause 4.1 of
ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiUri:
description: >
URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs,
the following prefix structure is used (see also clause 4.1 of ETSI
GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion}
For APIs not specified by ETSI NFV as part of the RESTful NFV-MANO APIs,
this attribute can be modified with the PATCH method. For RESTful NFV-MANO
APIs specified by ETSI NFV, this attribute shall not be modified. Instead,
changes are handled indirectly via patching of the "apiRoot" attribute’s
value.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
required:
- apiUri
maxConcurrentIntOpNumber:
description: >
Maximum number of concurrent operation requests supported on this interface. See note 2.
type: integer
supportedOperations:
description: >
Information about supported operations of this interface.
type: array
items:
type: object
properties:
operationName:
description: >
Name of the operation supported on the interface.
type: string
maxConcurrentOpNumber:
description: >
Maximum number of concurrent requests supported by the interface operation. See note 2.
type: integer
required:
- operationName
minItems: 1
interfaceState:
description: >
State of the NFV-MANO service interface.
properties:
operationalState:
description: >
The operational state of the NFV-MANO service interface.
$ref: "#/definitions/schemas/InterfaceOperationalStateEnumType"
administrativeState:
description: >
The administrative state of the NFV-MANO service interface.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
usageState:
description: >
The usage state of the NFV-MANO service interface.
$ref: "#/definitions/schemas/UsageStateEnumType"
required:
- operationalState
- administrativeState
- usageState
securityInfo:
description: >
Security related information.
This attribute can be modified with the PATCH method. See note 3.
$ref: "#/definitions/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
Additional attributes that provide metadata describing the NFV-MANO
service interface.
These attributes can be created, modified or removed with the PATCH
method.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
ManoServiceInterfaceModificationRequest:
description: >
This type represents attribute modifications for configuration parameters of
an NFV-MANO service interface of the producer NFV-MANO functional entity.
* NOTE 1: Changing the name does not change the corresponding standardized API name in the resource URI
(refer to "{apiName}" defined in clause 4.1 of ETSI GS NFV-SOL 013).
* NOTE 2: The change of apiRoot or apiUri on an enabled and in use API may be service disruptive. Also,
that change invalidates any related URI that might have been cached at API consumers.
* NOTE 3: Due to the security sensitive information associated to the attribute, based on access control
policies, the API consumer might have read only, write only, read/write, or no access at all
to the attribute's value. In case the API consumer is not allowed to modify the value of the
security sensitive attribute, and the modification request includes new attribute values,
the whole modification request shall be rejected, and proper error information returned.
type: object
properties:
name:
description: >
New value of the "name" attribute in "ManoServiceInterface". See note 1.
type: string
apiRoot:
description: >
New value of the "apiRoot" attribute in "ManoServiceInterface". See note 2.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
apiUri:
description: >
New value of the "apiUri" attribute in "ManoServiceInterface". See note 2.
Shall not be provided if a change of "apiRoot" is present in the request.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
securityInfo:
description: >
New value of the "securityInfo" attribute in "ManoServiceInterface". See note 3.
$ref: "#/definitions/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
Modifications of the "metadata" attribute in "ManoServiceInterface".
If present, these modifications shall be applied according to the rules
of JSON Merge PATCH (see IETF RFC 7396).
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
ManoServiceInterfaceModifications:
description: >
This type represents attribute modifications that were performed on an
Individual NFV-MANO service interface" resource. The attributes that can
be included consist of those requested to be modified explicitly in the
"ManoServiceInterfaceModificationRequest" data structure. If applicable,
additional attributes of the "ManoServiceInterface" data structure that
were modified implicitly shall also be provided.
* NOTE: Due to the security sensitive information associated to the attribute, based on access control
policies, the API consumer might have read only, write only, read/write, or no access at all
to the attribute's value. In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information is to be provided
in a response message.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name" attribute in
"ManoServiceInterface", as defined in clause 5.6.2.11.
type: string
apiRoot:
description: >
If present, this attribute signals modifications of the "apiRoot" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
apiUri:
description: >
If present, this attribute signals modifications of the "apiUri" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
securityInfo:
description: >
If present, this attribute signals modifications of the "securityInfo"
attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. See note.
$ref: "#/definitions/schemas/ServerInterfaceSecurityInfo"
metadata:
description: >
If present, this attribute signals modifications of the "metadata" attribute
in "ManoServiceInterface", as defined in clause 5.6.2.11.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
CreatePeerEntityRequest:
description: >
This type represents request parameters for the creation of a new peer entity resource.
* NOTE: The value of the "peerEntityId" attribute is the same as the value of the "id" attribute
in the "ManoEntity" of the corresponding NFV-MANO functional entity that acts as peer entity,
and shall follow the uniqueness requirements set out in clause 5.6.2.2 for the "id" attribute.
type: object
required:
- peerEntityId
- name
- type
properties:
peerEntityId:
description: >
Identifier of the peer functional entity. See note.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
name:
description: >
Human-readable name of the peer functional entity.
type: string
type:
description: >
Type of the peer functional entity.
$ref: "#/definitions/schemas/PeerEntityEnumType"
description:
description: >
Human-readable description of the peer functional entity.
type: string
consumedManoInterfaces:
description: >
Initial information of the interface consumed by the NFV-MANO functional entity
from the peer functional entity.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ConsumedManoInterfaceInfo"
peerEntityState:
description: >
Current values of the state of the peer functional entity.
type: object
properties:
operationalState:
description: >
TThe operation state of the peer functional entity’s application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
administrativeState:
description: >
The administrative state of the peer functional entity’s application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
required:
- operationalState
- administrativeState
PeerEntity:
description: >
This type represents an individual peer entity.
* NOTE 1: The value of the "peerEntityId" attribute is the same as the value of the "id" attribute in the
"ManoEntity" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall
follow the uniqueness requirements set out in clause 5.6.2.2 for the "id" attribute.
* NOTE 2: ETSI GS NFV-IFA 031 [1] defines an additional attribute named "apiDiscoveryEndpoint" in the
PeerManoEntity. The modelling of this attribute is not specified in the present document version.
type: object
required:
- id
- peerEntityId
- name
- type
- peerEntityState
properties:
id:
description: >
Identifier of the resource representing the peer functional entity.
This identifier is allocated by the producer NFV-MANO functional entity.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
peerEntityId:
description: >
Identifier of the peer functional entity. See note 1.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
name:
description: >
Human-readable name of the peer functional entity.
This attribute can be modified with the PATCH method.
type: string
type:
description: >
Type of the peer functional entity.
$ref: "#/definitions/schemas/PeerEntityEnumType"
description:
description: >
Human-readable description of the peer functional entity.
This attribute can be modified with the PATCH method.
type: string
consumedManoInterfaces:
description: >
Information of the interface consumed by the NFV-MANO functional entity
from the peer functional entity.
This attribute can be modified with the PATCH method.
The keys of the map, each of which identifies information about a particular
consumed NFV-MANO interface, are managed by the API consumer and referenced
from other data structures via the "consumedManoInterfaceIds" attribute.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ConsumedManoInterfaceInfo"
peerEntityState:
description: >
State of the peer functional entity as provided by the API consumer when
creating the resource or when updating it with the PATCH method.
type: object
properties:
operationalState:
description: >
The operational state of the peer functional entity’s application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
administrativeState:
description:
The administrative state of the peer functional entity’s application.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
required:
- operationalState
- administrativeState
PeerEntityConfigModificationRequest:
description: >
This type represents attribute modifications for configuration parameters of a peer entity.
* NOTE: Due to the security sensitive information contained within the attribute (refer to "securityInfo"
within the "ConsumedManoInterfaceInfo"), based on access control policies, the API consumer might have
read only, write only, read/write, or no access at all to the attribute's value. In case the
API consumer is not allowed to modify the value of the security sensitive attribute, and the
modification request includes new attribute values, the whole modification request shall be rejected,
and proper error information returned.
type: object
properties:
name:
description: >
New value of the "name" attribute in "PeerEntity".
type: string
description:
description: >
New value of the "description" attribute in "PeerEntity", or "null" to
remove the attribute.
type: string
consumedManoInterfaces:
description: >
Modification of the "consumedManoInterfaces" attribute
in the "PeerEntity", as defined below this table.
If present, these modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396). See note.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ConsumedManoInterfaceInfo"
operationalState:
description: >
New content of the "operationalState" attribute in the "peerEntityState"
structure in the "PeerEntity".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
administrativeState:
description: >
New content of the "administrativeState" attribute in the "peerEntityState"
structure in the "PeerEntity".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
PeerEntityConfigModifications:
description: >
This type represents attribute modifications that were performed on an
"Individual peer entity" resource. The attributes that can be included
consist of those requested to be modified explicitly in the
"PeerEntityConfigModificationRequest" data structure. If applicable,
additional attributes of the "PeerEntity" data structure that were
modified implicitly shall also be provided.
* NOTE: Due to the security sensitive information contained within the attribute (refer to "securityInfo"
within the "ConsumedManoInterfaceInfo"), based on access control policies, the API consumer might have
read only, write only, read/write, or no access at all to the attribute's value. In case the
API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall
be omitted when the information is to be provided in a response message.
type: object
properties:
name:
description: >
If present, this attribute signals modifications of the "name" attribute
in "PeerEntity", as defined in clause 5.6.2.15.
type: string
description:
description: >
If present, this attribute signals modifications of the "description"
attribute in "PeerEntity", as defined in clause 5.6.2.15.
type: string
consumedManoInterfaces:
description: >
If present, this attribute signals modifications of the
"consumedManoInterfaces" attribute in "PeerEntity", as defined in
clause 5.6.2.15. See note.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ConsumedManoInterfaceInfo"
operationalState:
description: >
If present, this attribute signals modifications of the "operationalState"
attribute in the "peerEntityState" structure in the "PeerEntity", as defined
in clause 5.6.2.15.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
administrativeState:
description: >
If present, this attribute signals modifications of the "administrativeState"
attribute in the "peerEntityState" structure in the "PeerEntity", as defined
in clause 5.6.2.15.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
ManoConfigurableParams:
description: >
# Warning: No definition found in the document
ManoConfigurableParams
#referenced
ManoEntityComponent:
description: >
This type represents information of a deployed component realizing part of an
NFV-MANO functional entity. It is optional for the API producer to support
this type.
type: object
required:
- id
properties:
id:
description: >
Identifier of the NFV-MANO functional entity component.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
manoServiceIds:
description: >
References to the NFV-MANO services that depend on the NFV-MANO functional
entity component. The identifier of the ManoService is referred. A service
may depend on multiple components. Multiple services may depend on the same
component.
type: array
items:
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
ManoService:
description: >
This type represents information about an NFV-MANO service provided by the
NFV-MANO functional entity.
* NOTE: A cardinality greater than one supports having different interface versions or api Endpoints
to be used for accessing the same instance of an NFV-MANO service.
type: object
required:
- id
- name
- description
- manoServiceInterfaceIds
- _links
properties:
id:
description: >
Identifier of the NFV-MANO service.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
name:
description: >
Human-readable name of the NFV-MANO service.
This attribute can be modified with the PATCH method.
type: string
description:
description: >
Human-readable description of the NFV-MANO service.
This attribute can be modified with the PATCH method.
type: string
manoServiceInterfaceIds:
description: >
Reference to the NFV-MANO interfaces associated to the NFV-MANO service.
If cardinality is greater than one, the type of ManoServiceInterface
(see clause 5.6.3.3) shall be the same. The identifier of the
ManoServiceInterface is referred. See note
type: array
items:
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IdentifierInManoEntity"
minItems: 1
_links:
description: >
Links to resources related to this resource.
type: object
properties:
manoServiceInterfaces:
description: >
Link to the "individual NFV-MANO service interface" resources with
information about the associated interfaces to the NFV-MANO service.
type: array
items:
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Link"
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
minItems: 1
required:
- manoServiceInterfaces
NfvoSpecificInfo:
description: >
This type represents information attributes specific to an NFVO entity,
and that can be relevant to more than one NFV-MANO service offered by an NFVO entity.
* NOTE 1: The information to be provided in this attribute shall relate to the specification and version
of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)".
NOTE 2: If this attribute is not present, the value of this parameter is undefined.
type: object
required:
- supportedVnfdFormats
- supportedNsdFormats
properties:
maxOnboardedNsdNum:
description: >
Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.
type: integer
maxOnboardedVnfPkgNum:
description: >
Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.
type: integer
supportedVnfdFormats:
description: >
Supported VNFD data formats.
type: object
properties:
vnfdFormat:
description: >
Name of the VNFD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the VNFD is compliant to. See note 1.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
required:
- vnfdFormat
- standardVersion
supportedNsdFormats:
description: >
Supported NSD data formats.
type: object
properties:
nsdFormat:
description: >
Name of the NSD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the NSD is compliant to. See note 1.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
required:
- nsdFormat
- standardVersion
VnfmSpecificInfo:
description: >
This type represents information attributes specific to a VNFM entity,
and that can be relevant to more than one NFV-MANO service offered by a VNFM entity.
* NOTE: The information to be provided in this attribute shall relate to the specification and version
of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)".
type: object
required:
- resoruceMgmtModeSupport
- managedVnfInstanceInfos
- supportedVnfdFormats
properties:
resoruceMgmtModeSupport:
description: >
The supported resource management modes of the VNFM.
Permitted values:
- DIRECT: The VNFM supports direct mode only.
- INDIRECT: The VNFM supports indirect mode only.
- BOTH: The VNFM supports both direct and indirect mode.
type: string
enum:
- DIRECT
- INDIRECT
- BOTH
managedVnfInstanceInfos:
description: >
The kinds of VNF instances that can be managed, e.g. to determine the
compatibility of a VNF with certain VNFM according to the vnfmInfo
attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).
type: array
items:
type: string
minItems: 1
supportedVnfdFormats:
description: >
Supported VNFD data formats.
type: array
items:
type: object
properties:
vnfdFormat:
description: >
Name of the VNFD format.
Permitted values:
- TOSCA: The VNFD follows TOSCA definition, according to ETSI
GS NFV-SOL 001 standard.
- YANG: The VNFD follows YANG definition according to ETSI
GS NFV-SOL 006 standard.
type: string
enum:
- TOSCA
- YANG
standardVersion:
description: >
Name and version of the standard the VNFD is compliant to. See note
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
required:
- vnfdFormat
- standardVersion
minItems: 1
VimSpecificInfo:
description: >
This type represents information attributes specific to a VIM entity,
and that can be relevant to more than one NFV MANO service offered by
a VIM entity. It shall comply with the provisions defined in table
5.6.3.6-1.
The present document version does not specify the support for
"maximum number of virtualised resources (attribute "maxVirtualResourceNum")"
as specified in clause 7.2.9.2 of ETSI GS NFV IFA 031 [1].
NOTE: Recommendations on appropriate algorithms and key lengths are given e.g.,
in NIST Special Publication 800-57 Part 3 Revision 1 [i.26] or in documents
related to local legislation.
type: object
required:
- imageContainerFormats
- imageDiskFormats
- imageSignatureVerification
- imageDigestAlgorithms
properties:
imageContainerFormats:
description: >
List of supported image container formats. Container format indicates whether a
software image is in a file that also contains metadata about the actual software.
Valid values are all values for "container_format" as defined in ETSI GS NFV-SOL 001
[16] and all values for "container-format" as defined in ETSI GS NFV-SOL 006 [i.17].
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
type: array
items:
type: string
imageDiskFormats:
description: >
List of supported image disk formats. The Disk format of a software image is the format
of the underlying disk image.
Valid values are all values for "disk_format" as defined in ETSI GS NFV-SOL 001 [16] and
all values of "disk-format" as defined in ETSI GS NFV-SOL 006 [i.17].
type: array
items:
type: string
imageSignatureVerification:
description: >
Information about the supported mechanisms, algorithms, and protocols for verifying the
signature of software images.
type: object
required:
- signatureVerificationAlgorithms
properties:
additionalVerificationCapabilities:
description: >
List of additional image signature verification capabilities. The "key" in the KeyValuePairs
determines the name of the capability, and the "value" shall indicate whether or not the
capability is enabled. Examples of capabilities can include performing a validation of the
image’s signing certificate during the image signature verification.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
signatureVerificationAlgorithms:
description: >
List of algorithms for verifying the signature of software images that are supported by the VIM.
type: array
items:
type: object
required:
- algorithm
- keyLengths
properties:
algorithm:
description: >
The name of the algorithm. Permitted values are: "RSA", "DSA", "ECDSA".
type: string
keyLengths:
description: >
List of supported key lengths of the algorithm. The key length indicates the number of bits,
such as “256”, “512”, etc. See note.
type: array
items:
type: string
additionalAlgParams:
description: >
Additional parameters specific to the signature verification algorithm.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
imageDigestAlgorithms:
description: >
List of supported digest algorithms that can be used for digital signatures.
type: array
items:
type: object
required:
- algorithm
- keyLengths
properties:
algorithm:
description: >
The name of the algorithm. Permitted values are: “SHA2“,“SHA3“.
type: string
keyLengths:
description: >
List of supported key lengths of the algorithm. The key length indicates the number of bits,
such as “256”, “512”, etc. See note.
type: array
items:
type: string
WimSpecificInfo:
description: >
This type represents information attributes specific to a WIM entity,
and that can be relevant to more than one NFV MANO service offered by
a WIM entity.
type: object
required:
- maxMscsNums
- maxMsncNum
- mscsLayerProtocolSupport
properties:
maxMscsNums:
description: >
Maximum number of MSCS that the WIM can manage.
type: object
required:
- numMscs
properties:
numMscs:
description: >
Maximum number of MSCS.
type: integer
criteriaNumMscs:
description: >
Reference criteria for derivation/computation of the referred maximum number of MSCS in
attribute "numMscs". Shall be provided if specific criteria has been taken into account
for deriving the referred number.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
maxMsncNum:
description: >
Maximum number of MSNC that the WIM can manage
type: object
required:
- numMsnc
properties:
numMsnc:
description: >
Maximum number of MSNC..
type: integer
criteriaNumMsnc:
description: >
Reference criteria for derivation/computation of the referred maximum
number of MSNC in attribute "numMsnc".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
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
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
mscsLayerProtocolSupport:
description: >
List of protocols of particular layers used to realize an MSCS
that are supported by the WIM.
Permitted values:
- EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.
- EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.
- VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified
in IETF RFC 4761 and IETF RFC.
- VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2
Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.
- VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.
- BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.
type: string
enum:
- EVPN_BGP_MPLS
- EVPN_VPWS
- VPLS_BGP
- VPLS_LDP_L2TP
- VPWS_LDP_L2TP
- BGP_IP_VPN
ManoEntityConfigurableParams:
description: >
This type represents list of parameters that can be configured on the
NFV MANO functional entity.
type: object
required:
- clockSyncs
- defaultLogCompileBySizeValue
- defaultLogCompileByTimerValue
properties:
clockSyncs:
description: >
Properties of the clock synchronization to be used by the NFV-MANO
functional entity.
The keys of the map, each of which identifies a particular ClockSyncInfo
structure, are managed by the API consumer.
type: object
additionalProperties:
$ref: "#/definitions/schemas/ClockSyncInfo"
minItems: 1
defaultLogCompileBySizeValue:
description:
Default value for the log compilation by size to be used.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description:
Default value for the log compilation by timer to be used.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/UnsignedInt"
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
ConsumedManoInterfaceInfo:
description: >
This type represents an interface consumed by the producer NFV MANO
functional entity from another peer functional entity.
* NOTE 1: The information to be provided in this attribute shall relate to the specification and its version.
For instance, "ETSI GS NFV-SOL 003 (V2.4.1)".
* NOTE 2: Due to the security sensitive information associated to the attribute, based on access control
policies, the API consumer might have read only, write only, read/write, or no access at all to
the attribute's value. In case the API consumer is not allowed to read the value of the security
sensitive attribute, the attribute shall be omitted when the information is to be provided in a
response message, and shall be provided otherwise. In case the API consumer is not allowed to
modify the value of the security sensitive attribute, and the modification request includes new
attribute values, the whole modification request shall be rejected, and proper error information returned.
type: object
required:
- id
- name
- type
- standardVersion
- apiVersion
- apiEndpoint
properties:
name:
description: >
Human-readable name of the NFV-MANO interface.
type: string
type:
description: >
Type of the NFV-MANO service interface consumed by the NFV-MANO
functional entity. Valid values are defined in clause 5.6.4.3.
type: string
standardVersion:
description: >
Version of the standard the interface is compliant to. See note 1.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
apiVersion:
description: >
API version, in compliance with the version identifiers and parameters
format specified in clause 9.1 of ETSI GS NFV-SOL 013.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Version"
apiEndpoint:
description: >
Consumable API endpoint of the interface.
It provides the information relevant about the protocol, host and port,
and path where the interface API can be accessed.
type: object
properties:
apiRoot:
description: >
Indicates the scheme ("http" or "https"), the host name and optional
port, and an optional sequence of path segments that together
represent a prefix path. Shall be present for ETSI NFV specified
RESTful NFV-MANO APIs (see also clause 4.1 of ETSI GS NFV-SOL 013).
May be present otherwise.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
apiName:
description: >
Indicates the interface name in an abbreviated form. Shall be present
for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each
interface is defined in the standard the interface is compliant to
(see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiMajorVersion:
description: >
Indicates the current major version of the API. Shall be present for
ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined
in the standard the interface is compliant to (see also clause 4.1
of ETSI GS NFV-SOL 013). May be present otherwise.
type: string
apiUri:
description: >
URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs,
the following prefix structure is used (see also clause 4.1 of ETSI
GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion}
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
required:
- apiUri
securityInfo:
description: >
Security related information including credentials information if needed
for consuming the API. See note 2.
$ref: "#/definitions/schemas/ClientInterfaceSecurityInfo"
CimNotificationsFilter:
description: >
This type represents a subscription filter related to notifications
about NFV-MANO configuration and information management.
* NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names
of the notification types to facilitate automated code generation systems.
type: object
properties:
manoEntitySubscriptionFilter:
description: >
Filter criteria to select the NFV-MANO functional entity and its
associated managed objects.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoEntitySubscriptionFilter"
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- InformationChangedNotification
- ChangeStateNotification
See note.
type: array
items:
type: string
enum:
- InformationChangedNotification
- ChangeStateNotification
ClockSyncInfo:
description: >
This type represents parameters for connecting to an NTP server.
* NOTE: Either ipAddress or hostname shall be set, but not both at the same time.
type: object
required:
- type
properties:
type:
description: >
Type of clock synchronization.
Permitted values:
- NTP: For Network Time Protocol (NTP) based clock synchronization.
- OTHER: For other types of clock synchronization.
type: string
enum:
- NTP
- OTHER
ntpServerInfo:
description: >
Information for the NTP based clock synchronization. Shall be present if type = "NTP".
type: object
properties:
ipAddress:
description: >
IP address of the NTP server. See note
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/IpAddress"
hostname:
description: >
Indicates the hostname of the NTP server. See note.
type: string
otherClockSyncParams:
description: >
Information for the other types of clock synchronization.
May be present if type = "OTHER".
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
ServerInterfaceSecurityInfo:
description: >
This type represents security related information of an NFV-MANO
service interface produced by an NFV-MANO functional entity.
* NOTE: Provided configuration of the OAuth 2.0 authorization server information and configuration
shall be supported, and dynamic configuration may be supported.
type: object
required:
- authType
- oauthServerInfo
properties:
authType:
description: >
Type of API request authorization to be used by the API producer.
The support of authorization methods for the API producer is specified
in clause 8.3.6 of ETSI GS NFV-SOL 013.
Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749.
type: array
items:
type: string
enum:
- TLS_TUNNEL
- OAUTH2
minItems: 1
oauthServerInfo:
description: >
OAuth 2.0 authorization server information and configuration.
type: object
required:
- providedConfiguration
- tlsCipherSuites
properties:
dynamicDiscovery:
description: >
Configuration data used when performing dynamic discovery of
the authorization server identifier. See note.
type: object
required:
- webFingerHost
properties:
webFingerHost:
description: >
Server where the WebFinger service is hosted. When used,
the request to the WebFinger resource shall conform as specified
in clause 5.1.3 of ETSI GS NFV-SEC 022.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
providedConfiguration:
description: >
Configuration data used to setup the authorization server identifier. See note.
type: object
required:
- authServerId
properties:
authServerId:
description: >
Authorization server identifier as defined in ETSI GS NFV-SEC 022.
$ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Uri"
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
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
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
tlsCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the
API producer when performing the SSL or TLS negotiation with the
authorization server. Valid values of cipher suites are defined
in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
tlsTunnelInfo:
description: >
Information and configuration related to the use of TLS tunnel.
Shall be present if authType contains "TLS_TUNNEL".
type: object
properties:
tlsTunnelCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the API
producer when performing the SSL or TLS negotiation with the API client.
Valid values of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
required:
- tlsTunnelCipherSuites
ClientInterfaceSecurityInfo:
description: >
This type represents security related information for accessing an NFV-MANO
service interface produced by an NFV-MANO functional entity.
* NOTE: Provided configuration of the OAuth 2.0 authorization server information and configuration
shall be supported, and dynamic configuration may be supported.
type: object
required:
- authType
- oauthServerInfo
properties:
authType:
description: >
Type of API request authorization to be used by the API consumer accessing
the API.
The support of authorization methods for the API consumer is specified in
clause 8.3.6 of ETSI GS NFV-SOL 013.
Permitted values:
- TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
- OAUTH2: Using access token, as defined by the OAuth 2.0 specification
in IETF RFC 6749.
type: array
items:
type: string
enum:
- TLS_TUNNEL
- OAUTH2
minItems: 1
oauthServerInfo:
description: >
OAuth 2.0 authorization server information and configuration.
type: object
properties:
dynamicDiscovery:
description: >
Configuration data used when performing dynamic discovery of the authorization
server identifier. See note.
type: object
required:
- webFingerHost
properties:
webFingerHost:
description: >
Server where the WebFinger service is hosted. When used, the request to
the WebFinger resource shall conform as specified in clause 5.1.3 of
ETSI GS NFV-SEC 022.
type: string
format: uri
providedConfiguration:
description: >
Configuration data used to setup the authorization server identifier. See note.
type: object
required:
- authServerId
properties:
authServerId:
description: >
Authorization server identifier as defined in ETSI GS NFV-SEC 022.
type: string
format: uri
tlsCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the API consumer when
performing the SSL or TLS negotiation with the authorization server. Valid values
of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
tlsTunnelInfo:
description: >
Information and configuration related to the use of TLS tunnel. Shall be
present if authType contains "TLS_TUNNEL".
type: object
properties:
tlsTunnelCipherSuites:
description: >
List of cipher suites that shall be declared as supported by the API
consumer when performing the SSL or TLS negotiation with the API producer.
Valid values of cipher suites are defined in IETF RFC 8447.
type: array
items:
type: string
minItems: 1
#referenced simple data types
ManoServiceInterfaceTypeShortName:
description: >
For the RESTful NFV-MANO APIs, valid values are all values for "apiName" as defined
in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.
For the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid
values are defined in table 5.6.4.3-1.
NOTE: The table is expected to be updated, by removing the corresponding listed entries,
once the interfaces are specified as a RESTful NFV-MANO API.
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
Acronym string value Description
"sim" Represents the "Software Image Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vcrm" Represents the "Virtualised Compute Resources Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vcrim" Represents the "Virtualised Compute Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vcrcam" Represents the "Virtualised Compute Resources Capacity Management" interface produced by a VIM (refer to IFA005).
"vcrcn" Represents the "Virtualised Compute Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006).
"vcfm" Represents the "Virtualised Compute Flavour Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vnrm" Represents the "Virtualised Network Resources Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vnrim" Represents the "Virtualised Network Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vnrcam" Represents the "Virtualised Network Resources Capacity Management" interface produced by a VIM (refer to IFA005).
"vnrcn" Represents the "Virtualised Network Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006).
"nfpm" Represents the "Network Forwarding Path Management" interface produced by a VIM (refer to IFA005).
"vsrm" Represents the "Virtualised Storage Resources Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vsrim" Represents the "Virtualised Storage Resources Information Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vsrcam" Represents the "Virtualised Storage Resources Capacity Management" interface produced by a VIM (refer to IFA005).
"vsrcn" Represents the "Virtualised Storage Resources Change Notification" interface produced by a VIM (refer to IFA005 and IFA006).
"vrpm" Represents the "Virtualised Resources Performance Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vrfm" Represents the "Virtualised Resources Fault Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vcrmm" Represents the "Virtualised Compute Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vnrmm" Represents the "Virtualised Network Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vsrmm" Represents the "Virtualised Storage Resources Reservation Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vrrcn" Represents the "Virtualised Resources Reservation Change Notification" interface produced by a VIM (refer to IFA005 and IFA006).
"vcrqm" Represents the "Virtualised Compute Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vnrqm" Represents the "Virtualised Network Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vsrqm" Represents the "Virtualised Storage Resources Quota Management" interface produced by a VIM (refer to IFA005 and IFA006).
"vrqcn" Represents the "Virtualised Resources Quota Change Notification" interface produced by a VIM (refer to IFA005 and IFA006).
"chrm" Represents the "Compute Host Reservation Management" interface produced by a VIM (refer to IFA005).
"chcam" Represents the "Compute Host Capacity Management" interface produced by a VIM (refer to IFA005).
"vnfspkgm" Represents the "VNF Snapshot Package Management" interface produced by a VNFM (refer to IFA007 and IFA013). This value is deprecated and it can be removed in subsequent versions of the present document. ETSI GS NFV SOL 005 [11] has specified to use the string "vnfsnapshotpkgm" as "apiName".
"vcrm_ind" Represents the indirect "Virtualised Compute Resources Management" interface produced by an NFVO (refer to IFA007).
"vcrim_ind" Represents the indirect "Virtualised Compute Resources Information Management" interface produced by an NFVO (refer to IFA007).
"vcrcn_ind" Represents the indirect "Virtualised Compute Resources Change Notification" interface produced by an NFVO (refer to IFA007).
"vsrm_ind" Represents the indirect "Virtualised Storage Resources Management" interface produced by an NFVO (refer to IFA007).
"vsrim_ind" Represents the indirect "Virtualised Storage Resources Information Management" interface produced by an NFVO (refer to IFA007).
"vsrcn_ind" Represents the indirect "Virtualised Storage Resources Change Notification" interface produced by an NFVO (refer to IFA007).
"vnrm_ind" Represents the indirect "Virtualised Network Resources Management" interface produced by an NFVO (refer to IFA007).
"vnrim_ind" Represents the indirect "Virtualised Network Resources Information Management" interface produced by an NFVO (refer to IFA007).
"vnrcn_ind" Represents the indirect "Virtualised Network Resources Change Notification" interface produced by an NFVO (refer to IFA007).
"vcrrm_ind" Represents the indirect "Virtualised Compute Resources Reservation Management" interface produced by an NFVO (refer to IFA007).
"vsrrm_ind" Represents the indirect "Virtualised Storage Resources Reservation Management" interface produced by an NFVO (refer to IFA007).
"vnrrm_ind" Represents the indirect "Virtualised Network Resources Reservation Management" interface produced by an NFVO (refer to IFA007).
"vrrcn_ind" Represents the indirect "Virtualised Resources Reservation Change Notification" interface produced by an NFVO (refer to IFA007).
"vrpm_ind" Represents the indirect "Virtualised Resources Performance Management" interface produced by an NFVO (refer to IFA007).
"vrfm_ind" Represents the indirect "Virtualised Resources Fault Management" interface produced by an NFVO (refer to IFA007).
"vcrqm_ind" Represents the indirect "Virtualised Resources Compute Quota Management" interface produced by an NFVO (refer to IFA007).
"vsrqm_ind" Represents the indirect "Virtualised Storage Resources Quota Management" interface produced by an NFVO (refer to IFA007).
"vnrqm_ind" Represents the indirect "Virtualised Network Resources Quota Management" interface produced by an NFVO (refer to IFA007).
"vrqcn_ind" Represents the indirect "Virtualised Resources Quota Change Notification" interface produced by an NFVO (refer to IFA007).
"lcmcoord" Represents the "LCM Coordination" interface produced by an EM and OSS (refer to IFA008 and IFA013).
"mscsm" Represents the "MSCS Management" interface produced by a WIM (refer to IFA032).
"mscscapm" Represents the "(MSCS) Capacity Management" interface produced by a WIM (refer to IFA032).
"mscsfm" Represents the "(MSCS) Fault Management" interface produced by a WIM (refer to IFA032).
"mscspm" Represents the "(MSCS) Performance Management" interface produced by a WIM (refer to IFA032).
"cismwkldm" Represents the "OS container workload management" service interface produced by a CISM (refer to IFA040).
"cismcompm" Represents the "OS container compute management" service interface produced by a CISM (refer to IFA040).
"cismstrgm" Represents the "OS container storage management" service interface produced by a CISM (refer to IFA040).
"cismnetwm" Represents the "OS container network management" service interface produced by a CISM (refer to IFA040).
"cismcfgm" Represents the "OS container configuration management" service interface produced by a CISM (refer to IFA040).
NOTE: "IFA005", "IFA006", "IFA007", "IFA008", "IFA013", "IFA032", "IFA040" are used as a shorthand for the
specifications ETSI GS NFV-IFA 005 [i.5], ETSI GS NFV-IFA 006 [i.6], ETSI GS NFV-IFA 007 [i.7],
ETSI GS NFV IFA 008 [i.8], ETSI GS NFV-IFA 013 [i.9], ETSI GS NFV-IFA 032 [i.18] and
ETSI GS NFV-IFA 040 [i.27], respectively.
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
type: string
UsageStateEnumType:
description: >
The enumeration UsageStateEnumType defines values representing the usage
state of a managed entity.
The UsageStateEnumType shall comply with the provisions:
- IN_USE The managed entity is currently being used.
- NOT_IN_USE The managed entity is currently not being used.
type: string
enum:
- IN_USE
- NOT_IN_USE
ChangeOperationalStateEnumType:
description: >
The enumeration ChangeOperationalStateEnumType defines permitted values
for the change state operation.
The ChangeOperationalStateEnumType shall comply with the provisions:
- START To start the managed entity.
- STOP To stop the managed entity.
- RESTART To stop and start again the managed entity.
type: string
enum:
- START
- STOP
- RESTART
ChangeAdministrativeStateEnumType:
description: >
The enumeration ChangeAdministrativeStateEnumType defines permitted values
for the change of administrative state operation.
The ChangeAdministrativeStateEnumType shall comply with the provisions:
- LOCK To lock the managed entity.
- UNLOCK To unlock the managed entity.
type: string
enum:
- LOCK
- UNLOCK
InterfaceOperationalStateEnumType:
description: >
The enumeration InterfaceOperationalStateEnumType defines values representing
the operational state of an NFV-MANO service interface type of managed entity.
The InterfaceOperationalStateEnumType shall comply with the provisions :
- STARTED The managed entity is operational.
- STOPPED The managed entity is not operational.
- STOPPING The managed entity is in the transition to stop.
- STARTING The managed entity is in the transition to start and become operational.
type: string
enum:
- STARTED
- STOPPED
- STOPPING
- STARTING
StopEnumType:
description: >
The enumeration ChangeStateOpOccStateEnumType defines permitted values
for the change state operation. It shall comply with the provisions:
- GRACEFUL To stop the managed entity immediately after accepting the request.
- FORCEFUL To stop the managed entity attempting to gracefully discharge the entity from service.
type: string
enum:
- GRACEFUL
- FORCEFUL
ManoEntityEnumType:
description: >
The enumeration ManoEntityEnumType defines the permitted values to
represent NFV-MANO functional entities. It shall comply with
the provisions :
- NFVO The NFV-MANO functional entity is an NFVO.
- VNFM The NFV-MANO functional entity is a VNFM.
- VIM The NFV-MANO functional entity is a VIM.
- WIM The NFV-MANO functional entity is a WIM.
- CISM The NFV-MANO functional entity is a CISM.
type: string
enum:
- NFVO
- VNFM
- VIM
- WIM
PeerEntityEnumType:
description: >
The enumeration PeerEntityEnumType defines the permitted values
to represent peer functional entities. it shall complains with
the provisions :
- NFVO The peer functional entity is an NFVO.
- VNFM The peer functional entity is a VNFM.
- VIM The peer functional entity is a VIM.
- WIM The peer functional entity is a WIM.
- CISM The peer functional entity is a CISM.
- EM The peer functional entity is an EM.
- OSS The peer functional entity is an OSS/BSS.
type: string
enum:
- NFVO
- VNFM
- VIM
- WIM