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"