Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL009
Commits
f1a6b25f
Commit
f1a6b25f
authored
Jan 19, 2022
by
Giacomo Bernini
Browse files
fixed issue#2 for NFVManoConfigurationAndInformationManagement
parent
4bdfdd1a
Pipeline
#10358
failed with stage
in 0 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
src/SOL009/NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml
View file @
f1a6b25f
...
...
@@ -677,1759 +677,7 @@ paths:
$ref
:
../components/SOL009_resp.yaml#/components/responses/504
components
:
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.
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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Identifier"
type
:
description
:
>
Type of NFV-MANO functional entity.
$ref
:
"
#/components/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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Version"
manoEntityComponents
:
description
:
>
The deployed NFV-MANO functional entity components which realize the
NFV-MANO functional entity. See note 5.
type
:
array
items
:
$ref
:
"
#/components/schemas/ManoEntityComponent"
minItems
:
0
manoServices
:
description
:
>
Information about the NFV-MANO services provided by the NFV-MANO
functional entity.
type
:
array
items
:
$ref
:
"
#/components/schemas/ManoService"
minItems
:
1
manoConfigurableParams
:
description
:
>
Information and current values of the configurable parameters.
This attribute can be modified with the PATCH method.
$ref
:
"
#/components/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
:
"
../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
administrativeState
:
description
:
>
The administrative state of the NFV-MANO functional entity application.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
usageState
:
description
:
>
The usage state of the NFV-MANO functional entity application.
$ref
:
"
#/components/schemas/UsageStateEnumType"
nfvoSpecificInfo
:
description
:
>
The information specific to an NFVO entity. See note 1 and not 4.
$ref
:
"
#/components/schemas/NfvoSpecificInfo"
vnfmSpecificInfo
:
description
:
>
The information specific to a VNFM entity. See note 2 and not 4.
$ref
:
"
#/components/schemas/VnfmSpecificInfo"
vimSpecificInfo
:
description
:
>
The information specific to an VIM entity. See note 3 and not 4.
$ref
:
"
#/components/schemas/VimSpecificInfo"
wimSpecificInfo
:
description
:
>
The information specific to a WIM entity. See notes 4 and note 6.
$ref
:
"
#/components/schemas/WimSpecificInfo"
_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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Link"
manoServiceInterfaces
:
description
:
Link to the "NFV-MANO service interfaces" resource.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/Link"
peerEntities
:
description
:
Link to "Peer entities" resource.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/Link"
changeState
:
description
:
Link to the "Change state" task resource.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/Link"
changeStateOpOccs
:
description
:
Link to the "Change state operation occurrences" resource.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/Link"
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
:
"
#/components/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue
:
description
:
>
New value of the "defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue
:
description
:
>
New value of the "defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
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
:
"
../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
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
:
"
#/components/schemas/ClockSyncInfo"
defaultLogCompileBySizeValue
:
description
:
>
If present, this attribute signals modifications of the
"defaultLogCompileBySizeValue" attribute in the
"ManoEntityConfigurableParams".
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
defaultLogCompileByTimerValue
:
description
:
>
If present, this attribute signals modifications of the
"defaultLogCompileByTimerValue" attribute in the
"ManoEntityConfigurableParams".
$ref
:
"
../components/SOL009_schemas.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_schemas.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
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
:
"
#/components/schemas/CimNotificationsFilter"
callbackUri
:
description
:
>
The URI of the endpoint to send the notification to.
$ref
:
"
../components/SOL009_schemas.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.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref
:
"
../components/SOL009_schemas.yaml#/components/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
:
"
../components/SOL009_schemas.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_schemas.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_schemas.yaml#/components/schemas/Link"
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
:
"
#/components/schemas/ChangeOperationalStateEnumType"
stopType
:
description
:
>
It signals the type of stop. See note 2.
$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. 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
:
"
#/components/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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Identifier"
operationState
:
description
:
>
The state of the "change state operation occurrence".
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/ChangeStateOpOccStateEnumType"
stateEnteredTime
:
description
:
>
Date-time when the current state was entered.
$ref
:
"
../components/SOL009_schemas.yaml#/components/schemas/DateTime"
startTime
:
description
:
>
Date-time of the start of the operation.
$ref
:
"
../components/SOL009_schemas.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_schemas.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.
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
:
"
../components/SOL009_schemas.yaml#/components/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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Version"
providerSpecificApiVersion
:
description
:
>
Provider-specific software API version.
$ref
:
"
../components/SOL009_schemas.yaml#/components/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
:
"
../components/SOL009_schemas.yaml#/components/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
:
"
../components/SOL009_schemas.yaml#/components/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
:
"
../components/SOL009_schemas.yaml#/components/schemas/Uri"
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
: