Skip to content
GitLab
Commit bf37c069 authored by Samir Medjiah's avatar Samir Medjiah
Browse files

CIM & PM: added missing data types and fixes

parent a89c013e
Hide whitespace changes
Inline Side-by-side
src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml
View file @ bf37c069
......@@ -771,7 +771,7 @@ components:
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: "##Identifier"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
type:
description: >
Type of NFV-MANO functional entity.
......@@ -796,7 +796,7 @@ components:
softwareVersion:
description: >
The version of the software of the NFV-MANO functional entity.
$ref: "##Version"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Version"
manoEntityComponents:
description: >
The deployed NFV-MANO functional entity components which realize the
......@@ -807,7 +807,7 @@ components:
type: array
items:
$ref: "#/components/schemas/ManoEntityComponent"
minminItems: 0
minItems: 0
manoServices:
description: >
Information about the NFV-MANO services provided by the NFV-MANO
......@@ -815,7 +815,7 @@ components:
type: array
items:
$ref: "#/components/schemas/ManoService"
minminItems: 1
minItems: 1
manoConfigurableParams:
description: >
Information and current values of the configurable parameters.
......@@ -853,7 +853,7 @@ components:
NOTE: The information about the NFV-MANO services offered by a
specific type of NFV-MANO functional entity is specified by the
manoServices attribute.
$ref: "#/components/schemas/nfvoSpecificInfo"
$ref: "#/components/schemas/NfvoSpecificInfo"
vnfmSpecificInfo:
description: >
The information specific to a VNFM entity.
......@@ -887,171 +887,1520 @@ components:
properties:
self:
description: URI of this resource.
$ref: "##Link"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
manoServiceInterfaces:
description: Link to the "NFV-MANO service interfaces" resource.
$ref: "##Link"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
peerEntities:
description: Link to "Peer entities" resource.
$ref: "##Link"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
changeState:
description: Link to the "Change state" task resource.
$ref: "##Link"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
changeStateOpOccs:
description: Link to the "Change state operation occurrences" resource.
$ref: "##Link"
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
ManoConfigModificationRequest:
description: >
This type represents attribute modifications for configuration parameters
of an NFV-MANO functional entity.
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: >
New content of certain entries in the "clockSyncs" attribute array in
the "ManoEntityConfigurableParams", as defined below this table.
type: array
items:
$ref: "#/components/schemas/ClockSyncInfo"
clockSyncsDeleteIds:
description: >
List of identifiers entries to be deleted from the "clockSyncs"
attribute array in the "ManoEntityConfigurableParams", as defined
below this table.
type: array
items:
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
defaultLogCompileBySizeValue:
description: >
New value of the "defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_comps.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
New value of the "defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_comps.yaml#/components/schemas/UnsignedInt"
manoServiceModifications:
description: >
New content of certain entries in the "manoServices" attribute array
in the "ManoEntity", as defined below this table.
type: array
items:
type: object
properties:
id:
description: >
Identifier of the NFV-MANO service to modify.
$ref: "../components/SOL009_comps.yaml#/components/schemas/IdentifierInManoEntity"
name:
description: >
New value for the "name" attribute in the "ManoService".
NOTE: At least one of these attributes shall be provided if requesting
a modification of the NFV-MANO service identified by "id".
type: string
description:
description: >
New value for the "description" attribute in the "ManoService".
NOTE: At least one of these attributes shall be provided if requesting
a modification of the NFV-MANO service identified by "id".
type: string
required:
- id
type:
ManoConfigModifications:
description: >
type:
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: array
items:
$ref: "#/components/schemas/ClockSyncInfo"
clockSyncsDeleteIds:
description: >
If present, this attribute signals modifications of certain entries in
"clockSyncs" attribute in "ManoEntityConfigurableParams", as defined
in clause 5.6.2.3.
type: array
items:
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
defaultLogCompileBySizeValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_comps.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue:
description: >
If present, this attribute signals modifications of the
"defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref: "../components/SOL009_comps.yaml#/components/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: "../components/SOL009_comps.yaml#/components/schemas/IdentifierInManoEntity"
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
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: "#/components/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_comps.yaml#/components/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.
type:
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../components/SOL009_comps.yaml#/components/schemas/SubscriptionAuthentication"
required:
- callbackUri
CimSubscription:
description: >
type:
This type represents a subscription related to notifications about
NFV-MANO configuration and information management changes
type: object
properties:
id:
description: >
Identifier that identifies the subscription
$ref: "../components/SOL009_comps.yaml#/components/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: "#/components/schemas/CimNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
properties:
self:
description: >
URI of this resource.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Link"
required:
- self
required:
- id
- callbackUri
- _links
InformationChangedNotification:
description: >
type:
This type represents a notification that is sent when data about
configuration and information of the NFV-MANO functional entity
have been changed.
type: object
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"InformationChangedNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
informationChangedTime:
description: >
Timestamp indicating when the information was changed.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
manoEntityId:
description: >
Identifier of the MANO entity of which the information was changed.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
changedInfo:
description: >
Data about the changed configuration and information of the NFV-MANO
functional entity.
$ref: "../components/SOL009_comps.yaml#/components/schemas/KeyValuePairs"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
self:
description: >
Link to the related subscription.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
required:
- self
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
ChangeStateRequest:
description: >
type:
This type represents request parameters for changing the state of a managed entity.
type: object
properties:
operationalStateChange:
description: >
A change of operational state. Shall be present if the state change request
refers to the operational state.
NOTE: 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.
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: "#/components/schemas/ChangeOperationalStateEnumType"
stopType:
description: >
It signals the type of stop.
NOTE: 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.
$ref: "#/components/schemas/StopEnumType"
gracefulStopTimeout:
description: >
The time internal (in seconds) to wait for the entity to be taken out
of service during graceful stop.
NOTE: 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: integer
required:
- operationalStateAction
administrativeStateChange:
description: >
A change of administrative state. Shall be present if the state change request
refers to the administrative state.
NOTE: 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.
type: object
properties:
administrativeStateAction:
description: >
The desired administrative state to change the managed object to.
$ref: "#/components/schemas/ChangeAdministrativeStateEnumType"
required:
- administrativeStateAction
ChangeStateOpOcc:
description: >
type:
This type represents a Change state operation occurrence.
type: object
properties:
id:
description: >
Identifier of this change state operation occurrence.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
operationState:
description: >
The state of the "change state operation occurrence".
$ref: "#/components/schemas/ChangeStateOpOccStateEnumType"
stateEnteredTime:
description: >
Date-time when the current state was entered.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
startTime:
description: >
Date-time of the start of the operation.
$ref: "../components/SOL009_comps.yaml#/components/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: "../components/SOL009_comps.yaml#/components/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: "#/components/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: "#/components/schemas/ChangeAdministrativeStateEnumType"
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.
required:
- id
- operationState
- stateEnteredTime
- startTime
- managedObjectRef
ChangeStateNotification:
description: >
This type represents a Change state operation occurrence.
type: object
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple times
due to multiple subscriptions, the "id" attribute of all these notifications
shall have the same value.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ChangeStateNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
timestamp:
description: >
Date-time of the generation of the notification.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
changeStateOpOccId:
description: >
Identifier of the change state operation occurrence associated to the
notification.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
stateChangedTime:
description: >
Timestamp indicating when the state on the managed object was changed.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
changeStateOperationState:
description: >
The state of the "change state operation occurrence".
$ref: "#/components/schemas/ChangeStateOpOccStateEnumType"
managedObjectRef:
description: >
Reference of the managed object to which the state change notification relates.
The value of the "type" attribute shall be "MANO_ENTITY" or "MANO_SERVICE_IF".
$ref: "#../components/SOL009_comps.yaml#/components/schemas/ManoManagedObjectReference"
operationalState:
description: >
New operational state of the managed object. Shall only be present when
there is a change in the operational state.
$ref: "#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
New administrative state of the managed object. Shall only be present
when there is a change in the administrative state.
$ref: "#/components/schemas/AdministrativeStateEnumType"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the object to which the change
state applies. Shall be present if the object instance is accessible
as a resource.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
changeStateOpOcc:
description: >
Link to the change state operation occurrence that this notification
is related to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
required:
- subscription
- objectInstance
- changeStateOpOcc
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
type:
ManoServiceInterface:
description: >
This type represents an individual NFV-MANO service interface produced by
an NFV-MANO functional entity.
type: object
properties: