diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ONAP Model Spec/im/NSD1.PNG | bin | 163858 -> 0 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/NSDR4.PNG | bin | 0 -> 159420 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/Nested Service final for Rst.PNG | bin | 0 -> 179392 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/PNFD.rst | 384 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/Service.rst | 5484 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst | 613 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/ServiceModel-Service order.rst | 393 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/ServiceOrderR4.PNG | bin | 0 -> 349690 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/index.rst | 8 |
9 files changed, 1396 insertions, 5486 deletions
diff --git a/docs/ONAP Model Spec/im/NSD1.PNG b/docs/ONAP Model Spec/im/NSD1.PNG Binary files differdeleted file mode 100644 index d72e016..0000000 --- a/docs/ONAP Model Spec/im/NSD1.PNG +++ /dev/null diff --git a/docs/ONAP Model Spec/im/NSDR4.PNG b/docs/ONAP Model Spec/im/NSDR4.PNG Binary files differnew file mode 100644 index 0000000..acd2c5d --- /dev/null +++ b/docs/ONAP Model Spec/im/NSDR4.PNG diff --git a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG b/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG Binary files differnew file mode 100644 index 0000000..1c58c42 --- /dev/null +++ b/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG diff --git a/docs/ONAP Model Spec/im/PNFD.rst b/docs/ONAP Model Spec/im/PNFD.rst new file mode 100644 index 0000000..1da1ce9 --- /dev/null +++ b/docs/ONAP Model Spec/im/PNFD.rst @@ -0,0 +1,384 @@ +PnfdModel +~~~~~~~~~ + +Classes +------- + +Pnf +~~~ + +An implementation of a NF via a tightly coupled software and hardware system. + +**Parent class:** NetworkFunction + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ============================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ============================================ +\_pnfExtCp PnfExtCp 1..\* OpenModelAttribute External CP of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id String 1 Experimental Identifier of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 0..1 Experimental + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +type String 1 Experimental Description of the type of network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Experimental Description of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +role String 1 Experimental Role the network function will be providing. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================ + +PnfExtCp +~~~~~~~~ + +External CP of the PNF. + +**Parent class:** Cp + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ============= ========= ================================== ======================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ============= ========= ================================== ======================================================================================================================================================================== +cpd invalid 1 OpenModelAttribute Cpd used to deploy this PNF CP. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpId Identifier 1 OpenModelAttribute Identifier of the connection point instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpName String 1 OpenModelAttribute Name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpNameAlt String 1 OpenModelAttribute alternative name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpType String 1 OpenModelAttribute Generic description of the type of Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpRole String 1 OpenModelAttribute Role in the network this Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpFunction String 1 OpenModelAttribute English description of the function this specific Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpDescription String 1 OpenModelAttribute Cp description + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpBandwidth String 1 OpenModelAttribute Cp assigned (actual) bandwidth + + - isInvariant: false Cp (max? assigned?) bandwidth + + - valueRange: no range constraint + + - support: MANDATORY +provStatus String 1 OpenModelAttribute provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +adminsStatus String 1 OpenModelAttribute Administrative status of the connection point. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +protocol String 1 OpenModelAttribute Protocol used by the Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +trunkMode Boolean 1 OpenModelAttribute Indicator whether the Cp is in trunk mode + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +addressType String 1 OpenModelAttribute Type of address: MAC address or IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L2addressData L2AddressData 0..1 OpenModelAttribute Only present when addressType is MAC address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L3addressData L3AddressData 0..1 OpenModelAttribute Only present when addressType is IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============= ========= ================================== ======================================================================================================================================================================== + +PnfExtCpd +~~~~~~~~~ + +A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. + +**Parent class:** ExtCpd + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +PnfProfile +~~~~~~~~~~ + +The PnfProfile class describes additional data for a given PNF instance used in a DF. + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +========================== ========================= ========= ================================== ======================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +========================== ========================= ========= ================================== ======================================================================================================================================== +pnfProfileId Identifier 1 OpenModelAttribute Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\* OpenModelAttribute Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ========================= ========= ================================== ======================================================================================================================================== + +Pnfd +~~~~ + +The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================== ========= ================================== ==================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ================== ========= ================================== ==================================================================================================================== +pnfdId Identifier 1 OpenModelAttribute Identifier of this Pnfd class. It uniquely identifies the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +provider String 1 OpenModelAttribute Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version Version 1 OpenModelAttribute Identifies the version of the PNFD + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +security SecurityParameters 0..1 OpenModelAttribute Provides a signature to prevent tampering. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +functionDescription String 1 OpenModelAttribute Describes the PNF function. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +pnfdInvariantId Identifier 1 OpenModelAttribute Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. + + - isInvariant: true + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Provides the human readable name of the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_pnfExtCpd PnfExtCpd 1..\* OpenModelAttribute Specifies the characteristics of one or more connection points where to connect the PNF to a VL. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================== ========= ================================== ==================================================================================================================== + +Data Types +---------- + +SwVersion +~~~~~~~~~ + +The software versions associated with the pnfd + +Applied stereotypes: + +- Future + +================== ======== ========= ========== ================================== ===================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +================== ======== ========= ========== ================================== ===================== +active String 1 RW OpenModelAttribute The active software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +passive String 0..\* RW OpenModelAttribute The passive software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +recovery String 0..\* RW OpenModelAttribute The recovery software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========== ================================== =====================
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Service.rst b/docs/ONAP Model Spec/im/Service.rst deleted file mode 100644 index 8e11e2c..0000000 --- a/docs/ONAP Model Spec/im/Service.rst +++ /dev/null @@ -1,5484 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Service Model -~~~~~~~~~~~~~ - -.. contents:: - :depth: 3 -.. - - -Classes -======= - -Attachment ----------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------------+-----------------+ -| **Attribute | **Type** | **Mult.** | **Stereotypes** | **Description** | -| Name** | | | | | -+=============+=============+=============+===================+=================+ -| id | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| href | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| name | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| description | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| type | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| uri | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| mimeType | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| validFor | TimePeriod | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ - -Attachment ----------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------------+-----------------+ -| **Attribute | **Type** | **Mult.** | **Stereotypes** | **Description** | -| Name** | | | | | -+=============+=============+=============+===================+=================+ -| id | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| name | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| description | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| type | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ -| url | String | 1 | OpenModelAttribute| | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ - -CpdPool -------- - -The CpdPool class specifies a pool of descriptors of connection points -and service access points. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------------+-----------------+ -| **Attribute | **Type** | **Mult.** | **Stereotypes** | **Description** | -| Name** | | | | | -+=============+=============+=============+===================+=================+ -| cpdPoolId | Identifier | 1 | OpenModelAttribute| Identifier | -| | | | | of this | -| | | | | CpdPool | -| | | | - isInvariant: | class. It | -| | | | false | identifies | -| | | | | a pool of | -| | | | | descriptors | -| | | | - valueRange: | of connection | -| | | | no | points and | -| | | | range | NS SAPs. | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+-------------+-------------+-------------+-------------------+-----------------+ - -Dependencies ------------- - -The Dependencies class provides indications on the order in which VNFs -associated to different VNF Profiles and/or nested NSs associated to -different NS Profiles are to be instantiated. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-----------------------------+----------------+-------------+-------------------+-----------------+ -| **Attribute | **Type** | **Mult.** | **Stereotypes** | **Description** | -| Name** | | | | | -+=============================+================+=============+===================+=================+ -| \_primaryProfileReference | NsOrVnfProfile | 1..\* | OpenModelAttribute| References a | -| | | | | VnfProfile | -| | | | - isInvariant: | or NsProfile. | -| | | | false | NOTE: NFV | -| | | | | Management | -| | | | - valueRange: | and | -| | | | no | Orchestration | -| | | | range | functions | -| | | | constraint | shall | -| | | | | instantiate | -| | | | | VNFs from | -| | | | - support: | the | -| | | | MANDATORY | VnfProfile | -| | | | | and/or | -| | | | | nested NSs | -| | | | | from the | -| | | | | NsProfile | -| | | | | referenced | -| | | | | in the | -| | | | | primary | -| | | | | attribute | -| | | | | before | -| | | | | instantiating | -| | | | | VNFs from | -| | | | | the | -| | | | | VnfProfile | -| | | | | and/or | -| | | | | nested NSs | -| | | | | from the | -| | | | | NsProfile | -| | | | | referenced | -| | | | | in the | -| | | | | secondary | -| | | | | attribute. | -+-----------------------------+----------------+-------------+-------------------+-----------------+ -| \_secondaryProfileReference | NsOrVnfProfile | 1..\* | OpenModelAttribute| References a | -| | | | | VnfProfile | -| | | | - isInvariant: | or | -| | | | false | NsProfile. | -| | | | | NOTE: NFV | -| | | | | Management | -| | | | - valueRange: | and | -| | | | no | Orchestration | -| | | | range | functions | -| | | | constraint | shall | -| | | | | instantiate | -| | | | | VNFs from | -| | | | - support: | the | -| | | | MANDATORY | VnfProfile | -| | | | | and/or | -| | | | | nested NSs | -| | | | | from the | -| | | | | NsProfile | -| | | | | referenced | -| | | | | in the | -| | | | | primary | -| | | | | attribute | -| | | | | before | -| | | | | instantiating | -| | | | | VNFs from | -| | | | | the | -| | | | | VnfProfile | -| | | | | and/or | -| | | | | nested NSs | -| | | | | from the | -| | | | | NsProfile | -| | | | | referenced | -| | | | | in the | -| | | | | secondary | -| | | | | attribute. | -+-----------------------------+----------------+-------------+-------------------+-----------------+ - -NetworkServiceInstance ----------------------- - -A composition of Network Functions and defined by its functional and -behavioural specification. NOTE: The Network Service (NS) contributes to -the behaviour of the higher layer service, which is characterized by at -least performance, dependability, and security specifications. The -end-to-end network service behaviour is the result of the combination of -the individual network function behaviours as well as the behaviours of -the network infrastructure composition mechanism. - -**Parent class:** ServiceComponentInstance - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| nsInstanceI | Identifier | 1 | OpenModelAt | Identifier | -| d | | | tribute | of this | -| | | | | NetworkServ | -| | | | - isInvari | ice, | -| | | | ant: | identifying | -| | | | false | the NS | -| | | | | instance. | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| nsName | String | 1 | OpenModelAt | Human | -| | | | tribute | readable | -| | | | | name of the | -| | | | - isInvari | NS | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | Human | -| | | | tribute | readable | -| | | | | description | -| | | | - isInvari | of the NS | -| | | | ant: | instance | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nf | NetworkFunc | 0..\* | OpenModelAt | Reference | -| | tion | | tribute | to | -| | | | | consistitue | -| | | | - isInvari | nt | -| | | | ant: | VNFs and | -| | | | false | PNFs on | -| | | | | this NS. | -| | | | - valueRan | NOTE: | -| | | | ge: | Cardinality | -| | | | no | of zero is | -| | | | range | only valid | -| | | | const | for a | -| | | | raint | non-instant | -| | | | | iated | -| | | | - support: | NS. | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsVirtual | NsVirtualLi | 0..\* | OpenModelAt | Information | -| Link | nk | | tribute | on the VLs | -| | | | | of this NS. | -| | | | - isInvari | NOTE: | -| | | | ant: | Cardinality | -| | | | false | of zero is | -| | | | | only valid | -| | | | - valueRan | for a | -| | | | ge: | non-instant | -| | | | no | iated | -| | | | range | NS. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_sap | Sap | 0..\* | OpenModelAt | Information | -| | | | tribute | on the SAPs | -| | | | | of this NS. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nestedNsi | NetworkServ | 0..\* | OpenModelAt | Reference | -| | iceInstance | | tribute | to | -| | | | | information | -| | | | - isInvari | on nested | -| | | | ant: | NSs of this | -| | | | false | NS. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_vnffg | Vnffg | 0..\* | OpenModelAt | Information | -| | | | tribute | on the | -| | | | | VNFFGs of | -| | | | - isInvari | this NS. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| instanceId | Identifier | 1 | OpenModelAt | Uniquely | -| | | | tribute | identifies | -| | | | | this | -| | | | - isInvari | instance of | -| | | | ant: | a service | -| | | | false | component. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name | -| | | | tribute | assigned to | -| | | | | the service | -| | | | - isInvari | component | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelInvari | Uuid | 1 | OpenModelAt | Constant | -| antUuid | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | component | -| | | | false | model. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelUuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | component | -| | | | false | model (this | -| | | | | uuid is | -| | | | - valueRan | changed for | -| | | | ge: | every major | -| | | | no | version of | -| | | | range | the service | -| | | | const | component). | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelVersio | String | 1 | OpenModelAt | The service | -| n | | | tribute | version in | -| | | | | SDC | -| | | | - isInvari | catalog. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| selfLink | Uri | 1 | OpenModelAt | URL to | -| | | | tribute | endpoint | -| | | | | where more | -| | | | - isInvari | details can | -| | | | ant: | be gotten. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| orchestrati | String | 1 | OpenModelAt | Orchestrati | -| onStatus | | | tribute | on | -| | | | | status of | -| | | | - isInvari | the service | -| | | | ant: | component | -| | | | false | instance. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of service | -| | | | - isInvari | component | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 0..\* | OpenModelAt | | -| mponentInst | onentInstan | | tribute | | -| ance | ce | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -Nfpd ----- - -The Nfpd class associates traffic flow criteria to a list of descriptors -associated to the connection points and service access points to be -visited by traffic flows matching these criteria. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| nfpdId | invalid | 1 | OpenModelAt | Identifies | -| | | | tribute | this nfpd | -| | | | | class | -| | | | - isInvari | within a | -| | | | ant: | VNFFGD. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| nfpRule | invalid | 1 | OpenModelAt | Provides an | -| | | | tribute | NFP | -| | | | | classificat | -| | | | - isInvari | ion | -| | | | ant: | and | -| | | | false | selection | -| | | | | rule. The | -| | | | - valueRan | rule may be | -| | | | ge: | expressed | -| | | | no | as a | -| | | | range | criteria | -| | | | const | constructed | -| | | | raint | out of | -| | | | | atomic | -| | | | - support: | assertions | -| | | | MANDA | linked by | -| | | | TORY | Boolean | -| | | | | operators | -| | | | | AND, OR and | -| | | | | NOT. NOTE: | -| | | | | Examples of | -| | | | | atomic | -| | | | | assertions | -| | | | | are | -| | | | | assertions | -| | | | | on packet | -| | | | | header | -| | | | | fields' | -| | | | | values, | -| | | | | date and | -| | | | | time | -| | | | | ranges, | -| | | | | etc. | -+-------------+-------------+-------------+-------------+-------------+ -| cpd | invalid | 1 | OpenModelAt | References | -| | | | tribute | the | -| | | | | descriptor | -| | | | - isInvari | of a | -| | | | ant: | connection | -| | | | false | point to be | -| | | | | traversed | -| | | | - valueRan | by the | -| | | | ge: | traffic | -| | | | no | flows | -| | | | range | matching | -| | | | const | the | -| | | | raint | criteria. | -| | | | | This shall | -| | | | - support: | be a | -| | | | MANDA | connection | -| | | | TORY | point | -| | | | | attached to | -| | | | | one of the | -| | | | | constituent | -| | | | | VNFs and | -| | | | | PNFs of the | -| | | | | parent | -| | | | | VNFFG, or a | -| | | | | SAP of one | -| | | | | of the | -| | | | | constituent | -| | | | | nested NSs | -| | | | | of the | -| | | | | parent | -| | | | | VNFFG. | -| | | | | NOTE: When | -| | | | | multiple | -| | | | | values are | -| | | | | provided, | -| | | | | the order | -| | | | | is | -| | | | | significant | -| | | | | and | -| | | | | specifies | -| | | | | the | -| | | | | sequence of | -| | | | | connection | -| | | | | points to | -| | | | | be | -| | | | | traversed. | -+-------------+-------------+-------------+-------------+-------------+ - -NsLevel -------- - -The NsLevel class describes the details of an NS level. An NS level -consists of a list of involved entities, i.e. VNFs, VLs and/or nested -NSs. For each involved VNF/nested NS, the number of instances required -by the NS level is specified. For each involved VL, the bitrate -requirements corresponding to the NS level are specified. NS levels -shall be used in the context of NS instantiation and in this case they -are referred to as NS instantiation levels. Every VNF, VL and nested NS -whose descriptor is referenced by the NS DF shall be involved in an NS -instantiation level of the parent NS. If no instances of a given -VNF/nested NS have to be deployed at NS instantiation time, the -numberOfInstances attribute in the corresponding -VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. NS levels -may be used in the context of NS scaling and in this case they are -referred to as NS scale levels. Only a subset of the VNFs, VLs and -nested NSs whose descriptor is referenced by the NS DF may be involved -in an NS scale level of the parent NS. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| nsLevelId | Identifier | 1 | OpenModelAt | Identifier | -| | | | tribute | of this | -| | | | | NsLevel | -| | | | - isInvari | class. It | -| | | | ant: | uniquely | -| | | | false | identifies | -| | | | | an NS level | -| | | | - valueRan | within the | -| | | | ge: | DF. | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | Human | -| | | | tribute | readable | -| | | | | description | -| | | | - isInvari | of the NS | -| | | | ant: | level. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vnfToLevelM | VnfToLevelM | 0..\* | OpenModelAt | Specifies | -| apping | apping | | tribute | the profile | -| | | | | of the VNFs | -| | | | - isInvari | involved in | -| | | | ant: | this NS | -| | | | false | level and, | -| | | | | for each of | -| | | | - valueRan | them, the | -| | | | ge: | required | -| | | | no | number of | -| | | | range | instances. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| virtualLink | VirtualLink | 0..\* | OpenModelAt | Specifies | -| ToLevelMapp | ToLevelMapp | | tribute | the profile | -| ing | ing | | | of the VLs | -| | | | - isInvari | involved in | -| | | | ant: | this NS | -| | | | false | level and, | -| | | | | for each of | -| | | | - valueRan | them, the | -| | | | ge: | needed | -| | | | no | bandwidth. | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| nsToLevelMa | NsToLevelMa | 0..\* | OpenModelAt | Specifies | -| pping | pping | | tribute | the profile | -| | | | | of the | -| | | | - isInvari | nested NSs | -| | | | ant: | involved in | -| | | | false | this NS | -| | | | | level and, | -| | | | - valueRan | for each of | -| | | | ge: | them, the | -| | | | no | required | -| | | | range | number of | -| | | | const | instances. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -NsLinkPort ----------- - -Respresents the port of a NS VL. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -NsOrVnfProfile --------------- - -This is an abstract proxy class, allowing to provide reference to either -NsProfile or VnfProfile. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -NsProfile ---------- - -The NsProfile class specifies the profile to be used for a nested NS. - -**Parent class:** NsOrVnfProfile - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| nsProfileId | Identifier | 1 | OpenModelAt | Identifies | -| | | | tribute | an NS | -| | | | | profile. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| minNumberOf | Integer | 1 | OpenModelAt | Minimum | -| Instances | | | tribute | number of | -| | | | | nested NS | -| | | | - isInvari | instances | -| | | | ant: | based on | -| | | | false | the | -| | | | | referenced | -| | | | - valueRan | NSD that is | -| | | | ge: | permitted | -| | | | no | to exist | -| | | | range | for this | -| | | | const | NsProfile. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| maxNumberOf | Integer | 1 | OpenModelAt | Maximum | -| Instances | | | tribute | number of | -| | | | | nested NS | -| | | | - isInvari | instances | -| | | | ant: | based on | -| | | | false | the | -| | | | | referenced | -| | | | - valueRan | NSD that is | -| | | | ge: | permitted | -| | | | no | to exist | -| | | | range | for this | -| | | | const | NsProfile. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| affinityOrA | AffinityOrA | 0..\* | OpenModelAt | Identifies | -| ntiaffinity | ntiAffinity | | tribute | an affinity | -| GroupId | Group | | | or | -| | | | - isInvari | anti-affini | -| | | | ant: | ty | -| | | | false | group the | -| | | | | NSs created | -| | | | - valueRan | according | -| | | | ge: | to this | -| | | | no | NsProfile | -| | | | range | belong to. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsdf | NsDf | 0..1 | OpenModelAt | Identifies | -| | | | tribute | the | -| | | | | applicable | -| | | | - isInvari | NS DF | -| | | | ant: | within the | -| | | | false | scope of | -| | | | | the NSD. | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsLevel | NsLevel | 0..1 | OpenModelAt | Identifies | -| | | | tribute | the NS | -| | | | | level | -| | | | - isInvari | within the | -| | | | ant: | referenced | -| | | | false | NS DF to be | -| | | | | used in the | -| | | | - valueRan | context of | -| | | | ge: | the parent | -| | | | no | NS | -| | | | range | instantiati | -| | | | const | on. | -| | | | raint | If not | -| | | | | present, | -| | | | - support: | the default | -| | | | MANDA | NS | -| | | | TORY | instantiati | -| | | | | on | -| | | | | level as | -| | | | | declared in | -| | | | | the | -| | | | | referenced | -| | | | | NSD shall | -| | | | | be used. | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsd | NetworkServ | 1 | OpenModelAt | Identifies | -| | iceDescript | | tribute | the NSD | -| | or | | | applicable | -| | | | - isInvari | to NS | -| | | | ant: | instantiate | -| | | | false | d | -| | | | | according | -| | | | - valueRan | to this | -| | | | ge: | profile. | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -NsScalingAspect ---------------- - -The NsScalingAspect class describes the details of an NS scaling aspect. -An NS scaling aspect is an abstraction representing a particular -"dimension" or "property" along which a given NS can be scaled. Defining -NS levels, in this context also known as NS scale levels, within an NS -scaling aspect allows to scale NS instances "by steps", i.e. to -increase/decrease their capacity in a discrete manner moving from one NS -scale level to another. Scaling by a single step does not imply that -exactly one instance of each entity involved in the NS scale level is -created or removed. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| nsScalingAs | Identifier | 1 | OpenModelAt | Identifier | -| pectId | | | tribute | of this | -| | | | | NsScalingAs | -| | | | - isInvari | pect | -| | | | ant: | class. It | -| | | | false | Uniquely | -| | | | | identifies | -| | | | - valueRan | the NS | -| | | | ge: | scaling | -| | | | no | aspect in | -| | | | range | an NSD. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | Provides a | -| | | | tribute | human | -| | | | | readable | -| | | | - isInvari | name of the | -| | | | ant: | NS scaling | -| | | | false | aspect. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | Provides a | -| | | | tribute | human | -| | | | | readable | -| | | | - isInvari | description | -| | | | ant: | of the NS | -| | | | false | scaling | -| | | | | aspect. | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsLevel | NsLevel | 1..\* | OpenModelAt | Describes | -| | | | tribute | the details | -| | | | | of an NS | -| | | | - isInvari | level. | -| | | | ant: | NOTE: Only | -| | | | false | a subset of | -| | | | | the VNFs, | -| | | | - valueRan | VLs and | -| | | | ge: | nested NSs | -| | | | no | whose | -| | | | range | descriptor | -| | | | const | is | -| | | | raint | referenced | -| | | | | by the NS | -| | | | - support: | DF may be | -| | | | MANDA | involved in | -| | | | TORY | an NS scale | -| | | | | level of | -| | | | | the parent | -| | | | | NS. | -+-------------+-------------+-------------+-------------+-------------+ - -NsVirtualLink -------------- - -This class provides run-time information about an NS VL instance. - -**Parent class:** VirtualLink - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| virtualNetw | invalid | 1 | OpenModelAt | Virtualised | -| ork | | | tribute | network | -| | | | | resource(s) | -| | | | - isInvari | realizing | -| | | | ant: | this VL. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_linkPort | LinkPort | 1..\* | OpenModelAt | Link ports | -| | | | tribute | of this VL. | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlInstanceI | Identifier | 1 | OpenModelAt | Identifier | -| d | | | tribute | of the | -| | | | | virtual | -| | | | - isInvari | link | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlName | String | 1 | OpenModelAt | An | -| | | | tribute | intelligent | -| | | | | or human | -| | | | - isInvari | readable | -| | | | ant: | name of the | -| | | | false | virtual | -| | | | | link | -| | | | - valueRan | instance. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlNameAlt | String | 1 | OpenModelAt | Additional | -| | | | tribute | intelligent | -| | | | | or human | -| | | | - isInvari | readable | -| | | | ant: | name of the | -| | | | false | virtual | -| | | | | link | -| | | | - valueRan | instance. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlType | String | 1 | OpenModelAt | Generic | -| | | | tribute | description | -| | | | | of the type | -| | | | - isInvari | of Virtual | -| | | | ant: | Link | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlRole | String | 1 | OpenModelAt | Role in the | -| | | | tribute | network | -| | | | | this | -| | | | - isInvari | virtual | -| | | | ant: | link will | -| | | | false | be | -| | | | | providing | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlFunction | String | 1 | OpenModelAt | English | -| | | | tribute | description | -| | | | | of the | -| | | | - isInvari | function | -| | | | ant: | this | -| | | | false | specific | -| | | | | virtual | -| | | | - valueRan | link will | -| | | | ge: | be | -| | | | no | providing | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlBandwidth | String | 1 | OpenModelAt | virtual | -| | | | tribute | link | -| | | | | assigned | -| | | | - isInvari | (actual) | -| | | | ant: | bandwidth | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| provStatus | String | 1 | OpenModelAt | provisionin | -| | | | tribute | g | -| | | | | status, | -| | | | - isInvari | used as a | -| | | | ant: | trigger for | -| | | | false | operational | -| | | | | monitoring | -| | | | - valueRan | of this | -| | | | ge: | resource by | -| | | | no | service | -| | | | range | assurance | -| | | | const | systems | -| | | | raint | valid value | -| | | | | example: | -| | | | - support: | PROVISIONED | -| | | | MANDA | , | -| | | | TORY | PREPROVISIO | -| | | | | NED, | -| | | | | CAPPED | -+-------------+-------------+-------------+-------------+-------------+ -| adminStatus | String | 1 | OpenModelAt | Administrat | -| | | | tribute | ive | -| | | | | status of | -| | | | - isInvari | the virtual | -| | | | ant: | link | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| minBitRateR | LinkBitrate | 1 | OpenModelAt | Specifies | -| equirements | Requirement | | tribute | the minimum | -| | s | | | bitrate | -| | | | - isInvari | requirement | -| | | | ant: | s | -| | | | false | for the | -| | | | | virtual | -| | | | - valueRan | link | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| maxBitRateR | LinkBitrate | 1 | OpenModelAt | Specifies | -| equirements | Requirement | | tribute | the maximum | -| | s | | | bitrate | -| | | | - isInvari | requirement | -| | | | ant: | s | -| | | | false | for the | -| | | | | virtual | -| | | | - valueRan | link | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| dhcpEnabled | Boolean | 1 | OpenModelAt | Indicates | -| | | | tribute | whether | -| | | | | DHCP is | -| | | | - isInvari | enabled | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlanTranspa | Boolean | 1 | OpenModelAt | Indicates | -| rent | | | tribute | whether | -| | | | | VLAn | -| | | | - isInvari | transparent | -| | | | ant: | mode is | -| | | | false | supported | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlTrunkMode | Boolean | 1 | OpenModelAt | Indicates | -| Enabled | | | tribute | whether | -| | | | | Trunk Mode | -| | | | - isInvari | is enabled | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlanIdOuter | Integer | 1 | OpenModelAt | Outer vlan | -| | | | tribute | tag | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| vlanIdInner | Integer | 1 | OpenModelAt | Inner vlan | -| | | | tribute | tag | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| connectivit | Connectivit | 1 | OpenModelAt | Identified | -| yType | yType | | tribute | the | -| | | | | layerProtoc | -| | | | - isInvari | ol | -| | | | ant: | and | -| | | | false | flowPattern | -| | | | | used by the | -| | | | - valueRan | virtual | -| | | | ge: | link | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -OrderItemRelationship ---------------------- - -Enables specifying any kind of relastionships between ServiceOrderItems - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| type | String | 1 | OpenModelAt | The type of | -| | | | tribute | relationshi | -| | | | | p | -| | | | - isInvari | such as | -| | | | ant: | contains, | -| | | | false | relies on. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -OrderRelationship ------------------ - -An assocation between two ServiceOrders. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| type | String | 1 | OpenModelAt | A | -| | | | tribute | categorizat | -| | | | | ion | -| | | | - isInvari | of the | -| | | | ant: | relationshi | -| | | | false | p, | -| | | | | such as | -| | | | - valueRan | bulk, | -| | | | ge: | parent/chil | -| | | | no | d, | -| | | | range | and so | -| | | | const | forth. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -OrderState ----------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -Pnf ---- - -An implementation of a NF via a tightly coupled software and hardware -system. - -**Parent class:** NetworkFunction - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| \_pnfExtCp | PnfExtCp | 1..\* | OpenModelAt | External CP | -| | | | tribute | of the PNF. | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -PnfExtCp --------- - -External CP of the PNF. - -**Parent class:** Cp - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| cpd | invalid | 1 | OpenModelAt | Cpd used to | -| | | | tribute | deploy this | -| | | | | PNF CP. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpId | Identifier | 1 | OpenModelAt | Identifier | -| | | | tribute | of the | -| | | | | connection | -| | | | - isInvari | point | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpName | String | 1 | OpenModelAt | Name of the | -| | | | tribute | Cp | -| | | | | instance. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpNameAlt | String | 1 | OpenModelAt | alternative | -| | | | tribute | name of the | -| | | | | Cp | -| | | | - isInvari | instance. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpType | String | 1 | OpenModelAt | Generic | -| | | | tribute | description | -| | | | | of the type | -| | | | - isInvari | of Cp | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpRole | String | 1 | OpenModelAt | Role in the | -| | | | tribute | network | -| | | | | this Cp | -| | | | - isInvari | will be | -| | | | ant: | providing | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpFunction | String | 1 | OpenModelAt | English | -| | | | tribute | description | -| | | | | of the | -| | | | - isInvari | function | -| | | | ant: | this | -| | | | false | specific Cp | -| | | | | will be | -| | | | - valueRan | providing | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpDescripti | String | 1 | OpenModelAt | Cp | -| on | | | tribute | description | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpBandwidth | String | 1 | OpenModelAt | Cp (max? | -| | | | tribute | assigned?) | -| | | | | bandwidth | -| | | | - isInvari | | -| | | | ant: | Cp assigned | -| | | | false | (actual) | -| | | | | bandwidth | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| provStatus | String | 1 | OpenModelAt | provisionin | -| | | | tribute | g | -| | | | | status, | -| | | | - isInvari | used as a | -| | | | ant: | trigger for | -| | | | false | operational | -| | | | | monitoring | -| | | | - valueRan | of this | -| | | | ge: | resource by | -| | | | no | service | -| | | | range | assurance | -| | | | const | systems | -| | | | raint | valid value | -| | | | | example: | -| | | | - support: | PROVISIONED | -| | | | MANDA | , | -| | | | TORY | PREPROVISIO | -| | | | | NED, | -| | | | | CAPPED | -+-------------+-------------+-------------+-------------+-------------+ -| adminsStatu | String | 1 | OpenModelAt | Administrat | -| s | | | tribute | ive | -| | | | | status of | -| | | | - isInvari | the | -| | | | ant: | connection | -| | | | false | point. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| protocol | String | 1 | OpenModelAt | Protocol | -| | | | tribute | used by the | -| | | | | Cp | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| trunkMode | Boolean | 1 | OpenModelAt | Indicator | -| | | | tribute | whether the | -| | | | | Cp is in | -| | | | - isInvari | trunk mode | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| addressType | String | 1 | OpenModelAt | Type of | -| | | | tribute | address: | -| | | | | MAC address | -| | | | - isInvari | or IP | -| | | | ant: | address | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| L2addressDa | L2AddressDa | 0..1 | OpenModelAt | Only | -| ta | ta | | tribute | present | -| | | | | when | -| | | | - isInvari | addressType | -| | | | ant: | is MAC | -| | | | false | address | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| L3addressDa | L3AddressDa | 0..1 | OpenModelAt | Only | -| ta | ta | | tribute | present | -| | | | | when | -| | | | - isInvari | addressType | -| | | | ant: | is IP | -| | | | false | address | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -PnfProfile ----------- - -The PnfProfile class describes additional data for a given PNF instance -used in a DF. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| pnfProfileI | Identifier | 1 | OpenModelAt | Identifier | -| d | | | tribute | of this | -| | | | | PnfProfile | -| | | | - isInvari | class. It | -| | | | ant: | uniquely | -| | | | false | identifies | -| | | | | a | -| | | | - valueRan | PnfProfile. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| pnfVirtualL | NsVirtualLi | 1..\* | OpenModelAt | Defines the | -| inkConnecti | nkConnectiv | | tribute | connection | -| vity | ity | | | information | -| | | | - isInvari | of the PNF, | -| | | | ant: | it contains | -| | | | false | connection | -| | | | | relationshi | -| | | | - valueRan | p | -| | | | ge: | between a | -| | | | no | PNF | -| | | | range | connection | -| | | | const | point and a | -| | | | raint | NS virtual | -| | | | | Link. | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ResourceDescriptor ------------------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| id | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| href | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| type | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| resourceTyp | String | 1 | OpenModelAt | | -| e | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| resourceRol | String | 1 | OpenModelAt | | -| e | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| version | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -Sap ---- - -Provides information on a Service Access Point (SAP) of a NS - -**Parent class:** Cp - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -ServiceAtomicDescriptor ------------------------ - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| serviceatom | ServiceAtom | 0..\* | OpenModelAt | | -| icinstance | icInstance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| invariantUu | Uuid | 1 | OpenModelAt | Constant | -| id | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| uuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model (this | -| | | | false | uuid is | -| | | | | changed for | -| | | | - valueRan | every major | -| | | | ge: | version of | -| | | | no | the | -| | | | range | service) | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name of | -| | | | tribute | the service | -| | | | | model | -| | | | - isInvari | designed. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model | -| | | | false | designed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| category | String | 1..\* | OpenModelAt | A | -| | | | tribute | predefined | -| | | | | list which | -| | | | - isInvari | identifies | -| | | | ant: | the | -| | | | false | construct's | -| | | | | category. | -| | | | - valueRan | There is a | -| | | | ge: | predefined | -| | | | no | list of | -| | | | range | service | -| | | | const | categories. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| version | String | 1 | OpenModelAt | The service | -| | | | tribute | model | -| | | | | version. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceType | String | 1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field | -| | | | - isInvari | defining a | -| | | | ant: | generic | -| | | | false | type (like | -| | | | | category) | -| | | | - valueRan | of the | -| | | | ge: | service. | -| | | | no | E.g. this | -| | | | range | field can | -| | | | const | be used for | -| | | | raint | defining | -| | | | | the service | -| | | | - support: | as | -| | | | MANDA | "TRANSPORT" | -| | | | TORY | . | -+-------------+-------------+-------------+-------------+-------------+ -| serviceRole | String | 0..1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field for | -| | | | - isInvari | shortcode | -| | | | ant: | that | -| | | | false | defines the | -| | | | | function | -| | | | - valueRan | that the | -| | | | ge: | service is | -| | | | no | providing. | -| | | | range | E.g. | -| | | | const | "MISVPN" or | -| | | | raint | "AIM". | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| icon | String | 1 | OpenModelAt | The icon | -| | | | tribute | path of the | -| | | | | service. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceComp | Uuid | 1 | OpenModelAt | The service | -| onentUuid | | | tribute | component | -| | | | | descriptor | -| | | | - isInvari | UUIDs that | -| | | | ant: | the service | -| | | | false | includes | -| | | | | (relationhi | -| | | | - valueRan | p | -| | | | ge: | to Service | -| | | | no | Component). | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceIn | ServiceInst | 0..\* | OpenModelAt | | -| stance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 1..\* | OpenModelAt | | -| mponentDesc | onentDescri | | tribute | | -| riptor | ptor | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 0..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceinst | ServiceInst | 0..\* | OpenModelAt | | -| ance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 1..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| resourcedes | ResourceDes | 0..1 | OpenModelAt | | -| criptor | criptor | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceAtomicInstance ---------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -ServiceCandidate (ServiceCatalogItem) -------------------------------------- - -A ServiceCandidate (ServiceCatalogItem) is an entity that makes a -ServiceSpecification available to a catalog. A ServiceCandidate and its -associated ServiceSpecification may be "published" (made visible) in any -number of ServiceCatalogs, or in none. One ServiceSpecification can be -composed of other ServiceSpecifications. These ServiceSpecifications may -also be published. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| ID | String | 1 | OpenModelAt | A unique | -| | | | tribute | identifier | -| | | | | for the | -| | | | - isInvari | ServiceCand | -| | | | ant: | idate | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | A word or | -| | | | tribute | phrase that | -| | | | | a | -| | | | - isInvari | ServiceCand | -| | | | ant: | idate | -| | | | false | is known | -| | | | | and | -| | | | - valueRan | distinguish | -| | | | ge: | ed | -| | | | no | from other | -| | | | range | ServiceCand | -| | | | const | idates. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | A narrative | -| | | | tribute | that | -| | | | | explains | -| | | | - isInvari | the | -| | | | ant: | ServiceCand | -| | | | false | idate. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| validFor | EDate | 1 | OpenModelAt | The period | -| | | | tribute | of time | -| | | | | during | -| | | | - isInvari | which the | -| | | | ant: | ServiceCand | -| | | | false | idate | -| | | | | is | -| | | | - valueRan | applicable. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| status | String | 1 | OpenModelAt | The | -| | | | tribute | condition | -| | | | | at which | -| | | | - isInvari | the | -| | | | ant: | ServiceCand | -| | | | false | idate | -| | | | | exists such | -| | | | - valueRan | as planned, | -| | | | ge: | active and | -| | | | no | Obsolete. | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceCatalog --------------- - -A ServiceCatalog is a collection of ServiceCandidates representing -ServiceSpecifications. ServiceCandidates define the underlying services -that support a ProductOffering. ServiceCandidates are exposed to one or -more Product Catalogs to be utilized to configure one or more -ProductOfferings. ServiceCandidates can be exposed to one or more -Service Catalogs to be utilized or incorporated in one or more -ServiceCandidates. A collection may consist of similar -ServiceCandidates, such as a collection of broadband -ServiceCatalogCandidates or a collection of wireless -ServiceCatalogCandidates. A Service Catalog contents can expose a -collection of ServiceCandidates to be utilized internal/external to an -enterprise. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -ServiceCharacteristic ---------------------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| name | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| valueType | String | 1 | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceComponentDescriptor --------------------------- - -ServcieComponentDescriptor is used to model the design time -representation of a service component or network service. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| invariantUu | Uuid | 1 | OpenModelAt | Constant | -| id | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | Service | -| | | | ant: | Component | -| | | | false | model. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| uuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | Service | -| | | | ant: | Component | -| | | | false | model (this | -| | | | | uuid is | -| | | | - valueRan | changed for | -| | | | ge: | every major | -| | | | no | version of | -| | | | range | the service | -| | | | const | component). | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name of | -| | | | tribute | the service | -| | | | | component. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of service | -| | | | - isInvari | component. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| version | String | 1 | OpenModelAt | The version | -| | | | tribute | of service | -| | | | | component. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| designer | String | 1 | OpenModelAt | The | -| | | | tribute | designer of | -| | | | | the service | -| | | | - isInvari | component. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 0..\* | OpenModelAt | | -| mponentDesc | onentDescri | | tribute | | -| riptor | ptor | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 0..\* | OpenModelAt | | -| mponentInst | onentInstan | | tribute | | -| ance | ce | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceComponentInstance ------------------------- - -ServiceComponentInstance is used to model the run time representation of -a service component. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| instanceId | Identifier | 1 | OpenModelAt | Uniquely | -| | | | tribute | identifies | -| | | | | this | -| | | | - isInvari | instance of | -| | | | ant: | a service | -| | | | false | component. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name | -| | | | tribute | assigned to | -| | | | | the service | -| | | | - isInvari | component | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelInvari | Uuid | 1 | OpenModelAt | Constant | -| antUuid | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | component | -| | | | false | model. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelUuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | component | -| | | | false | model (this | -| | | | | uuid is | -| | | | - valueRan | changed for | -| | | | ge: | every major | -| | | | no | version of | -| | | | range | the service | -| | | | const | component). | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelVersio | String | 1 | OpenModelAt | The service | -| n | | | tribute | version in | -| | | | | SDC | -| | | | - isInvari | catalog. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| selfLink | Uri | 1 | OpenModelAt | URL to | -| | | | tribute | endpoint | -| | | | | where more | -| | | | - isInvari | details can | -| | | | ant: | be gotten. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| orchestrati | String | 1 | OpenModelAt | Orchestrati | -| onStatus | | | tribute | on | -| | | | | status of | -| | | | - isInvari | the service | -| | | | ant: | component | -| | | | false | instance. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of service | -| | | | - isInvari | component | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 0..\* | OpenModelAt | | -| mponentInst | onentInstan | | tribute | | -| ance | ce | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceCompositeDescriptor --------------------------- - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| servicecomp | ServiceComp | 0..\* | OpenModelAt | | -| ositeinstan | ositeInstan | | tribute | | -| ce | ce | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| servicedesc | ServiceDesc | 1..\* | OpenModelAt | | -| riptor | riptor | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| invariantUu | Uuid | 1 | OpenModelAt | Constant | -| id | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| uuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model (this | -| | | | false | uuid is | -| | | | | changed for | -| | | | - valueRan | every major | -| | | | ge: | version of | -| | | | no | the | -| | | | range | service) | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name of | -| | | | tribute | the service | -| | | | | model | -| | | | - isInvari | designed. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model | -| | | | false | designed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| category | String | 1..\* | OpenModelAt | A | -| | | | tribute | predefined | -| | | | | list which | -| | | | - isInvari | identifies | -| | | | ant: | the | -| | | | false | construct's | -| | | | | category. | -| | | | - valueRan | There is a | -| | | | ge: | predefined | -| | | | no | list of | -| | | | range | service | -| | | | const | categories. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| version | String | 1 | OpenModelAt | The service | -| | | | tribute | model | -| | | | | version. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceType | String | 1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field | -| | | | - isInvari | defining a | -| | | | ant: | generic | -| | | | false | type (like | -| | | | | category) | -| | | | - valueRan | of the | -| | | | ge: | service. | -| | | | no | E.g. this | -| | | | range | field can | -| | | | const | be used for | -| | | | raint | defining | -| | | | | the service | -| | | | - support: | as | -| | | | MANDA | "TRANSPORT" | -| | | | TORY | . | -+-------------+-------------+-------------+-------------+-------------+ -| serviceRole | String | 0..1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field for | -| | | | - isInvari | shortcode | -| | | | ant: | that | -| | | | false | defines the | -| | | | | function | -| | | | - valueRan | that the | -| | | | ge: | service is | -| | | | no | providing. | -| | | | range | E.g. | -| | | | const | "MISVPN" or | -| | | | raint | "AIM". | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| icon | String | 1 | OpenModelAt | The icon | -| | | | tribute | path of the | -| | | | | service. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceComp | Uuid | 1 | OpenModelAt | The service | -| onentUuid | | | tribute | component | -| | | | | descriptor | -| | | | - isInvari | UUIDs that | -| | | | ant: | the service | -| | | | false | includes | -| | | | | (relationhi | -| | | | - valueRan | p | -| | | | ge: | to Service | -| | | | no | Component). | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceIn | ServiceInst | 0..\* | OpenModelAt | | -| stance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 1..\* | OpenModelAt | | -| mponentDesc | onentDescri | | tribute | | -| riptor | ptor | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 0..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceinst | ServiceInst | 0..\* | OpenModelAt | | -| ance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 1..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| resourcedes | ResourceDes | 0..1 | OpenModelAt | | -| criptor | criptor | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceCompositeInstance ------------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| serviceinst | ServiceInst | 1..\* | OpenModelAt | | -| ance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceDescAtomic ------------------ - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -ServiceDescComposite --------------------- - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -ServiceDescriptor ------------------ - -ServiceDescriptor is used to model the design time representation of a -service. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| invariantUu | Uuid | 1 | OpenModelAt | Constant | -| id | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| uuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model (this | -| | | | false | uuid is | -| | | | | changed for | -| | | | - valueRan | every major | -| | | | ge: | version of | -| | | | no | the | -| | | | range | service) | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| name | String | 1 | OpenModelAt | The name of | -| | | | tribute | the service | -| | | | | model | -| | | | - isInvari | designed. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | The | -| | | | tribute | description | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model | -| | | | false | designed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| category | String | 1..\* | OpenModelAt | A | -| | | | tribute | predefined | -| | | | | list which | -| | | | - isInvari | identifies | -| | | | ant: | the | -| | | | false | construct's | -| | | | | category. | -| | | | - valueRan | There is a | -| | | | ge: | predefined | -| | | | no | list of | -| | | | range | service | -| | | | const | categories. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| version | String | 1 | OpenModelAt | The service | -| | | | tribute | model | -| | | | | version. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceType | String | 1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field | -| | | | - isInvari | defining a | -| | | | ant: | generic | -| | | | false | type (like | -| | | | | category) | -| | | | - valueRan | of the | -| | | | ge: | service. | -| | | | no | E.g. this | -| | | | range | field can | -| | | | const | be used for | -| | | | raint | defining | -| | | | | the service | -| | | | - support: | as | -| | | | MANDA | "TRANSPORT" | -| | | | TORY | . | -+-------------+-------------+-------------+-------------+-------------+ -| serviceRole | String | 0..1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field for | -| | | | - isInvari | shortcode | -| | | | ant: | that | -| | | | false | defines the | -| | | | | function | -| | | | - valueRan | that the | -| | | | ge: | service is | -| | | | no | providing. | -| | | | range | E.g. | -| | | | const | "MISVPN" or | -| | | | raint | "AIM". | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| icon | String | 1 | OpenModelAt | The icon | -| | | | tribute | path of the | -| | | | | service. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceComp | Uuid | 1 | OpenModelAt | The service | -| onentUuid | | | tribute | component | -| | | | | descriptor | -| | | | - isInvari | UUIDs that | -| | | | ant: | the service | -| | | | false | includes | -| | | | | (relationhi | -| | | | - valueRan | p | -| | | | ge: | to Service | -| | | | no | Component). | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceIn | ServiceInst | 0..\* | OpenModelAt | | -| stance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 1..\* | OpenModelAt | | -| mponentDesc | onentDescri | | tribute | | -| riptor | ptor | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 0..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceinst | ServiceInst | 0..\* | OpenModelAt | | -| ance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| attachment | Attachment | 1..\* | OpenModelAt | | -| | | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| resourcedes | ResourceDes | 0..1 | OpenModelAt | | -| criptor | criptor | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceInstance ---------------- - -ServiceInstance is used to model the run time representation of a -service. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| serviceInst | Identifier | 1 | OpenModelAt | Uniquely | -| anceId | | | tribute | identifies | -| | | | | this | -| | | | - isInvari | instance of | -| | | | ant: | a service. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceInst | String | 1 | OpenModelAt | The name | -| anceName | | | tribute | assigned to | -| | | | | the | -| | | | - isInvari | service-ins | -| | | | ant: | tance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceInst | String | 1 | OpenModelAt | The | -| anceDescrip | | | tribute | description | -| tion | | | | assigned to | -| | | | - isInvari | the | -| | | | ant: | service-ins | -| | | | false | tance. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelInvari | Uuid | 1 | OpenModelAt | Constant | -| antUuid | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model | -| | | | false | (relationsh | -| | | | | ip | -| | | | - valueRan | to service | -| | | | ge: | model). | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelUuid | Uuid | 1 | OpenModelAt | Versioned | -| | | | tribute | identifier | -| | | | | of the | -| | | | - isInvari | service | -| | | | ant: | model | -| | | | false | (relationsh | -| | | | | ip | -| | | | - valueRan | to service | -| | | | ge: | model). | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| modelVersio | String | 1 | OpenModelAt | The service | -| n | | | tribute | model | -| | | | | version in | -| | | | - isInvari | SDC | -| | | | ant: | catalog. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceType | String | 0..1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field | -| | | | - isInvari | defining a | -| | | | ant: | generic | -| | | | false | type (like | -| | | | | category) | -| | | | - valueRan | of the | -| | | | ge: | service. | -| | | | no | E.g. this | -| | | | range | field can | -| | | | const | be used for | -| | | | raint | defining | -| | | | | the service | -| | | | - support: | as | -| | | | MANDA | "TRANSPORT" | -| | | | TORY | . | -+-------------+-------------+-------------+-------------+-------------+ -| serviceRole | String | 1 | OpenModelAt | An optional | -| | | | tribute | string | -| | | | | field for | -| | | | - isInvari | shortcode | -| | | | ant: | that | -| | | | false | defines the | -| | | | | function | -| | | | - valueRan | that the | -| | | | ge: | service is | -| | | | no | providing. | -| | | | range | E.g. | -| | | | const | "MISVPN" or | -| | | | raint | "AIM". | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| selfLink | Uri | 1 | OpenModelAt | URL to | -| | | | tribute | endpoint | -| | | | | where more | -| | | | - isInvari | details can | -| | | | ant: | be gotten. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| orchestrati | String | 1 | OpenModelAt | Orchestrati | -| onStatus | | | tribute | on | -| | | | | status of | -| | | | - isInvari | the service | -| | | | ant: | instance. | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| serviceComp | Identifier | 1 | OpenModelAt | The service | -| onentInstan | | | tribute | component | -| ceId | | | | instance ID | -| | | | - isInvari | that the | -| | | | ant: | service | -| | | | false | instance | -| | | | | includes. | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceIn | ServiceInst | 0..\* | OpenModelAt | | -| stance | ance | | tribute | | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceCo | ServiceComp | 1..\* | OpenModelAt | | -| mponentInst | onentInstan | | tribute | | -| ance | ce | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -.. _serviceinstance-1: - -ServiceInstance ---------------- - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -ServiceOrder ------------- - -A type of Request that represents a Customer Order's products decomposed -into the services through which the products are realized. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| id | String | 1 | OpenModelAt | Unique | -| | | | tribute | identifier | -| | | | | for | -| | | | - isInvari | Interaction | -| | | | ant: | . | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| externalId | String | 1 | OpenModelAt | ID given by | -| | | | tribute | the order | -| | | | | requester | -| | | | - isInvari | and only | -| | | | ant: | understanda | -| | | | false | ble | -| | | | | by him (to | -| | | | - valueRan | facilitate | -| | | | ge: | his | -| | | | no | searches | -| | | | range | afterwards) | -| | | | const | . | -| | | | raint | It could an | -| | | | | order | -| | | | - support: | number | -| | | | MANDA | reference | -| | | | TORY | from the | -| | | | | triggering | -| | | | | system (OM) | -+-------------+-------------+-------------+-------------+-------------+ -| priority | OrderPriori | 1 | OpenModelAt | A way that | -| | ty | | tribute | can be used | -| | | | | by order | -| | | | - isInvari | requester | -| | | | ant: | to | -| | | | false | prioritize | -| | | | | orders in | -| | | | - valueRan | Service | -| | | | ge: | Order | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| description | String | 1 | OpenModelAt | Narrative | -| | | | tribute | that | -| | | | | explains | -| | | | - isInvari | the | -| | | | ant: | interaction | -| | | | false | and details | -| | | | | about the | -| | | | - valueRan | interaction | -| | | | ge: | , | -| | | | no | such as why | -| | | | range | the | -| | | | const | interaction | -| | | | raint | is taking | -| | | | | place. | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| category | String | 1 | OpenModelAt | Used to | -| | | | tribute | categorize | -| | | | | the order - | -| | | | - isInvari | Requester | -| | | | ant: | valued it | -| | | | false | and this | -| | | | | category | -| | | | - valueRan | can be | -| | | | ge: | useful for | -| | | | no | the Service | -| | | | range | Order | -| | | | const | Management | -| | | | raint | system | -| | | | | and/or | -| | | | - support: | requester | -| | | | MANDA | (e.g. | -| | | | TORY | "broadband" | -| | | | | , | -| | | | | "TV | -| | | | | option",). | -+-------------+-------------+-------------+-------------+-------------+ -| state | OrderState | 1 | OpenModelAt | State of | -| | | | tribute | the order | -| | | | | | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| completionD | EDate | 1 | OpenModelAt | The date on | -| ate | | | tribute | which an | -| | | | | interaction | -| | | | - isInvari | is closed | -| | | | ant: | or | -| | | | false | completed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| requestedSt | EDate | 1 | OpenModelAt | The date | -| artDate | | | tribute | that was | -| | | | | requested | -| | | | - isInvari | to start | -| | | | ant: | processing | -| | | | false | the order. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| requestedCo | EDate | 1 | OpenModelAt | The date on | -| mpletionDat | | | tribute | which an | -| e | | | | interaction | -| | | | - isInvari | is closed | -| | | | ant: | or | -| | | | false | completed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| expectedCom | EDate | 1 | OpenModelAt | The date on | -| pletionDate | | | tribute | which an | -| | | | | interaction | -| | | | - isInvari | is expected | -| | | | ant: | to be | -| | | | false | completed. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| startDate | EDate | 1 | OpenModelAt | The date on | -| | | | tribute | which an | -| | | | | interaction | -| | | | - isInvari | is started. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| notificatio | String | 1 | OpenModelAt | Contact | -| nContact | | | tribute | attached to | -| | | | | the order | -| | | | - isInvari | to send | -| | | | ant: | back | -| | | | false | information | -| | | | | regarding | -| | | | - valueRan | this order | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_serviceOr | ServiceOrde | 1..\* | OpenModelAt | Reference | -| derItem | rItem | | tribute | to | -| | | | | ServiceOrde | -| | | | - isInvari | rItem | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| OrderDate | EDate | 1 | OpenModelAt | The date | -| | | | tribute | the order | -| | | | | was placed. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -ServiceOrderItem ----------------- - -The purpose for the ServiceOrder expressed in terms of a -ServiceSpecification or a Service. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| id | String | 1 | OpenModelAt | Identifier | -| | | | tribute | of the line | -| | | | | item | -| | | | - isInvari | (generally | -| | | | ant: | it is a | -| | | | false | sequence | -| | | | | number 01, | -| | | | - valueRan | 02, 03, | -| | | | ge: | ...). | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| action | Action | 1 | OpenModelAt | The action | -| | | | tribute | to take for | -| | | | | an | -| | | | - isInvari | Interaction | -| | | | ant: | Item, | -| | | | false | such as | -| | | | | add, | -| | | | - valueRan | change, | -| | | | ge: | remove. | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| state | OrderState | 1 | OpenModelAt | State of | -| | | | tribute | the order | -| | | | | item: | -| | | | - isInvari | described | -| | | | ant: | in the | -| | | | false | state | -| | | | | machine | -| | | | - valueRan | diagram. | -| | | | ge: | This is the | -| | | | no | requested | -| | | | range | state. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| Quantity | Integer | 1 | OpenModelAt | Quantity of | -| | | | tribute | an | -| | | | | interaction | -| | | | - isInvari | item | -| | | | ant: | involved in | -| | | | false | an | -| | | | | interaction | -| | | | - valueRan | . | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -Value ------ - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| value | String | 1 | OpenModelAt | The value | -| | | | tribute | of a given | -| | | | | ServiceChar | -| | | | - isInvari | acteristic | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -VirtualLinkProfile ------------------- - -The VirtualLinkProfile class specifies a profile for instantiating VLs -of a particular NS DF according to a specific VLD and VL DF. - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| virtualLink | Identifier | 1 | OpenModelAt | Uniquely | -| ProfileId | | | tribute | identifies | -| | | | | this | -| | | | - isInvari | VirtualLink | -| | | | ant: | Profile | -| | | | false | class. | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| flavourId | VirtualLink | 1 | OpenModelAt | Identifies | -| | Df | | tribute | a flavour | -| | | | | within the | -| | | | - isInvari | VLD. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| localAffini | LocalAffini | 0..\* | OpenModelAt | Specifies | -| tyOrAntiAff | tyOrAntiAff | | tribute | affinity | -| inityRule | inityRule | | | and | -| | | | - isInvari | anti-affini | -| | | | ant: | ty | -| | | | false | rules | -| | | | | applicable | -| | | | - valueRan | between VLs | -| | | | ge: | instantiate | -| | | | no | d | -| | | | range | from the | -| | | | const | referenced | -| | | | raint | VLD. | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| affinityOrA | AffinityOrA | 0..\* | OpenModelAt | Identifies | -| ntiAffinity | ntiAffinity | | tribute | an affinity | -| GroupId | Group | | | or | -| | | | - isInvari | anti-affini | -| | | | ant: | ty | -| | | | false | group the | -| | | | | VLs | -| | | | - valueRan | instantiate | -| | | | ge: | d | -| | | | no | according | -| | | | range | to the | -| | | | const | VlProfile | -| | | | raint | belong to. | -| | | | | NOTE : Each | -| | | | - support: | identifier | -| | | | MANDA | references | -| | | | TORY | an affinity | -| | | | | or | -| | | | | anti-affini | -| | | | | ty | -| | | | | group which | -| | | | | expresses | -| | | | | affinity or | -| | | | | anti-affini | -| | | | | ty | -| | | | | relationshi | -| | | | | p | -| | | | | between the | -| | | | | VL(s) using | -| | | | | this | -| | | | | VirtualLink | -| | | | | Profile | -| | | | | and the | -| | | | | VL(s) using | -| | | | | other | -| | | | | VirtualLink | -| | | | | Profile(s) | -| | | | | in the same | -| | | | | group. | -+-------------+-------------+-------------+-------------+-------------+ -| maxBitrateR | LinkBitrate | 1 | OpenModelAt | Specifies | -| equirements | Requirement | | tribute | the maximum | -| | s | | | bitrate | -| | | | - isInvari | requirement | -| | | | ant: | s | -| | | | false | for a VL | -| | | | | instantiate | -| | | | - valueRan | d | -| | | | ge: | according | -| | | | no | to this | -| | | | range | profile. | -| | | | const | NOTE: These | -| | | | raint | attributes | -| | | | | are used to | -| | | | - support: | control | -| | | | MANDA | scaling | -| | | | TORY | boundaries. | -+-------------+-------------+-------------+-------------+-------------+ -| minBitrateR | LinkBitrate | 1 | OpenModelAt | Specifies | -| equirements | Requirement | | tribute | the minimum | -| | s | | | bitrate | -| | | | - isInvari | requirement | -| | | | ant: | s | -| | | | false | for a VL | -| | | | | instantiate | -| | | | - valueRan | d | -| | | | ge: | according | -| | | | no | to this | -| | | | range | profile. | -| | | | const | NOTE: These | -| | | | raint | attributes | -| | | | | are used to | -| | | | - support: | control | -| | | | MANDA | scaling | -| | | | TORY | boundaries. | -+-------------+-------------+-------------+-------------+-------------+ -| \_nsVirtual | NsVirtualLi | 1 | OpenModelAt | Uniquely | -| LinkDesc | nkDesc | | tribute | references | -| | | | | a VLD. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -VnfProfile ----------- - -The VnfProfile class specifies a profile for instantiating VNFs of a -particular NS DF according to a specific VNFD and VNF DF. - -**Parent class:** NsOrVnfProfile - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| vnfProfileI | Identifier | 1 | OpenModelAt | Identifier | -| d | | | tribute | of this | -| | | | | vnfProfile | -| | | | - isInvari | class. It | -| | | | ant: | uniquely | -| | | | false | identifies | -| | | | | a | -| | | | - valueRan | VnfProfile. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| instantiati | Identifier | 0..1 | OpenModelAt | Identifier | -| onLevel | | | tribute | of the | -| | | | | instantiati | -| | | | - isInvari | on | -| | | | ant: | level of | -| | | | false | the VNF DF | -| | | | | to be used | -| | | | - valueRan | for | -| | | | ge: | instantiati | -| | | | no | on. | -| | | | range | If not | -| | | | const | present, | -| | | | raint | the default | -| | | | | instantiati | -| | | | - support: | on | -| | | | MANDA | level as | -| | | | TORY | declared in | -| | | | | the VNFD | -| | | | | shall be | -| | | | | used. | -+-------------+-------------+-------------+-------------+-------------+ -| minNumberOf | Integer | 1 | OpenModelAt | Minimum | -| Instances | | | tribute | number of | -| | | | | instances | -| | | | - isInvari | of the VNF | -| | | | ant: | based on | -| | | | false | this VNFD | -| | | | | that is | -| | | | - valueRan | permitted | -| | | | ge: | to exist | -| | | | no | for this | -| | | | range | VnfProfile. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| maxNumberOf | Integer | 1 | OpenModelAt | Maximum | -| Instances | | | tribute | number of | -| | | | | instances | -| | | | - isInvari | of the VNF | -| | | | ant: | based on | -| | | | false | this VNFD | -| | | | | that is | -| | | | - valueRan | permitted | -| | | | ge: | to exist | -| | | | no | for this | -| | | | range | VnfProfile. | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| localAffini | LocalAffini | 0..\* | OpenModelAt | Specifies | -| tyOrAntiAff | tyOrAntiAff | | tribute | affinity | -| inityRule | inityRule | | | and | -| | | | - isInvari | anti-affini | -| | | | ant: | ty | -| | | | false | rules | -| | | | | applicable | -| | | | - valueRan | between VNF | -| | | | ge: | instances | -| | | | no | created | -| | | | range | from this | -| | | | const | profile. | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| affinityOrA | invalid | 1 | OpenModelAt | Identifier( | -| ntiAffinity | | | tribute | s) | -| GroupId | | | | of the | -| | | | - isInvari | affinity or | -| | | | ant: | anti-affini | -| | | | false | ty | -| | | | | group(s) | -| | | | - valueRan | the | -| | | | ge: | VnfProfile | -| | | | no | belongs to. | -| | | | range | NOTE: Each | -| | | | const | identifier | -| | | | raint | references | -| | | | | an affinity | -| | | | - support: | or | -| | | | MANDA | anti-affini | -| | | | TORY | ty | -| | | | | group which | -| | | | | expresses | -| | | | | affinity or | -| | | | | anti-affini | -| | | | | ty | -| | | | | relationshi | -| | | | | ps | -| | | | | between the | -| | | | | VNF | -| | | | | instance(s) | -| | | | | created | -| | | | | using this | -| | | | | VnfProfile | -| | | | | and the VNF | -| | | | | instance(s) | -| | | | | created | -| | | | | using other | -| | | | | VnfProfile( | -| | | | | s) | -| | | | | in the same | -| | | | | group. | -+-------------+-------------+-------------+-------------+-------------+ -| nsVirtualLi | NsVirtualLi | 1..\* | OpenModelAt | Defines the | -| nkConnectiv | nkConnectiv | | tribute | connection | -| ity | ity | | | information | -| | | | - isInvari | of the VNF, | -| | | | ant: | it contains | -| | | | false | connection | -| | | | | relationshi | -| | | | - valueRan | p | -| | | | ge: | between a | -| | | | no | VNF | -| | | | range | connection | -| | | | const | point and a | -| | | | raint | NS virtual | -| | | | | Link. | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_vnfDf | VnfDf | 1 | OpenModelAt | Identifies | -| | | | tribute | a flavour | -| | | | | within the | -| | | | - isInvari | VNFD. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| \_vnfd | Vnfd | 0..1 | OpenModelAt | Reference | -| | | | tribute | to the | -| | | | | VNFD. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -Vnffg ------ - -A graph of logical links connecting NF nodes,where at least one node is -a VNF, for the purpose of describing traffic flow between these network -functions - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Future - -+-------------+-------------+-------------+-------------+-------------+ -| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti | -| Name** | | | es** | on** | -+=============+=============+=============+=============+=============+ -| vnffgId | invalid | 1 | OpenModelAt | Identier of | -| | | | tribute | this Vnffg | -| | | | | class. | -| | | | - isInvari | | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| nfId | invalid | 1 | OpenModelAt | Identifier | -| | | | tribute | of the | -| | | | | constituent | -| | | | - isInvari | NFs of the | -| | | | ant: | VNFFG | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| virtualLink | invalid | 1..\* | OpenModelAt | Identifier( | -| Id | | | tribute | s) | -| | | | | of the | -| | | | - isInvari | constituent | -| | | | ant: | VL | -| | | | false | instance(s) | -| | | | | of the | -| | | | - valueRan | VNFFG. | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ -| cpId | invalid | 1 | OpenModelAt | Identifiers | -| | | | tribute | of the CP | -| | | | | instances | -| | | | - isInvari | attached to | -| | | | ant: | the | -| | | | false | constituent | -| | | | | VNFs and | -| | | | - valueRan | PNFs or the | -| | | | ge: | sap | -| | | | no | instances | -| | | | range | of the | -| | | | const | VNFFG. | -| | | | raint | NOTE: It | -| | | | | indicates | -| | | | - support: | an | -| | | | MANDA | exhaustive | -| | | | TORY | list of all | -| | | | | the CP | -| | | | | instances | -| | | | | and SAP | -| | | | | instances | -| | | | | of the | -| | | | | VNFFG. | -+-------------+-------------+-------------+-------------+-------------+ -| nfp | invalid | 1 | OpenModelAt | Information | -| | | | tribute | on the NFPs | -| | | | | of this | -| | | | - isInvari | VNFFG. | -| | | | ant: | | -| | | | false | | -| | | | | | -| | | | - valueRan | | -| | | | ge: | | -| | | | no | | -| | | | range | | -| | | | const | | -| | | | raint | | -| | | | | | -| | | | - support: | | -| | | | MANDA | | -| | | | TORY | | -+-------------+-------------+-------------+-------------+-------------+ - -Data Types -========== - -NsToLevelMapping ----------------- - -The NsToLevelMapping datatype specifies the profile to be used for a -nested NS involved in a given NS level and the required number of -instances. - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| nsProfile | invalid | 1 | RW | OpenModel | Identifie | -| Id | | | | Attribute | s | -| | | | | | the | -| | | | | - isInva | profile | -| | | | | riant: | to be | -| | | | | fal | used for | -| | | | | se | a nested | -| | | | | | NS | -| | | | | - valueR | involved | -| | | | | ange: | in the NS | -| | | | | no | level. | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| numberOfI | Integer | 1 | RW | OpenModel | Specifies | -| nstances | | | | Attribute | the | -| | | | | | number of | -| | | | | - isInva | nested NS | -| | | | | riant: | instances | -| | | | | fal | required | -| | | | | se | for the | -| | | | | | NS scale | -| | | | | - valueR | level. | -| | | | | ange: | NOTE 1: | -| | | | | no | It shall | -| | | | | ran | be in the | -| | | | | ge | range of | -| | | | | con | minNumber | -| | | | | straint | OfInstanc | -| | | | | | es-maxNum | -| | | | | - suppor | berOfInst | -| | | | | t: | ances, | -| | | | | MAN | as | -| | | | | DATORY | specified | -| | | | | | in the | -| | | | | | reference | -| | | | | | d | -| | | | | | NsProfile | -| | | | | | . | -| | | | | | NOTE 2: | -| | | | | | When the | -| | | | | | correspon | -| | | | | | ding | -| | | | | | NS level | -| | | | | | is used | -| | | | | | in the | -| | | | | | context | -| | | | | | of NS | -| | | | | | instantia | -| | | | | | tion, | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | attribute | -| | | | | | specifies | -| | | | | | the | -| | | | | | number of | -| | | | | | nested NS | -| | | | | | instances | -| | | | | | to be | -| | | | | | deployed. | -| | | | | | NOTE 3: | -| | | | | | When the | -| | | | | | correspon | -| | | | | | ding | -| | | | | | NS level | -| | | | | | is used | -| | | | | | in the | -| | | | | | context | -| | | | | | of NS | -| | | | | | scaling, | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | attribute | -| | | | | | does not | -| | | | | | specify | -| | | | | | the | -| | | | | | number of | -| | | | | | nested NS | -| | | | | | instances | -| | | | | | to be | -| | | | | | added/rem | -| | | | | | oved | -| | | | | | when | -| | | | | | reaching | -| | | | | | that NS | -| | | | | | scale | -| | | | | | level. | -| | | | | | The | -| | | | | | actual | -| | | | | | number of | -| | | | | | nested NS | -| | | | | | instances | -| | | | | | to be | -| | | | | | added/rem | -| | | | | | oved | -| | | | | | can be | -| | | | | | derived | -| | | | | | by | -| | | | | | subtracti | -| | | | | | ng | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | declared | -| | | | | | in the | -| | | | | | source NS | -| | | | | | scale | -| | | | | | level | -| | | | | | from the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | declared | -| | | | | | in the | -| | | | | | target NS | -| | | | | | level of | -| | | | | | the | -| | | | | | scaling | -| | | | | | request. | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -NsVirtualLinkConnectivity -------------------------- - -The NsVirtuallLinkConnectivity datatype describes connection information -between a connection point and a NS virtual Link. - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| virtualLi | invalid | 1 | RW | OpenModel | Reference | -| nkProfile | | | | Attribute | an NS VL | -| Id | | | | | profile. | -| | | | | - isInva | | -| | | | | riant: | | -| | | | | fal | | -| | | | | se | | -| | | | | | | -| | | | | - valueR | | -| | | | | ange: | | -| | | | | no | | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| cpdId | invalid | 1 | RW | OpenModel | Reference | -| | | | | Attribute | s | -| | | | | | the | -| | | | | - isInva | descripto | -| | | | | riant: | r | -| | | | | fal | of a | -| | | | | se | connectio | -| | | | | | n | -| | | | | - valueR | point on | -| | | | | ange: | a VNF/PNF | -| | | | | no | or a SAP | -| | | | | ran | which | -| | | | | ge | connects | -| | | | | con | to | -| | | | | straint | virtual | -| | | | | | links | -| | | | | - suppor | instantia | -| | | | | t: | ted | -| | | | | MAN | from the | -| | | | | DATORY | profile | -| | | | | | identifie | -| | | | | | d | -| | | | | | in the | -| | | | | | virtualLi | -| | | | | | nkProfile | -| | | | | | Id | -| | | | | | attribute | -| | | | | | . | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -TimePeriod ----------- - -A base / value business entity used to represent a period of time, -between two timepoints - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| startDate | EDate | 1 | RW | OpenModel | An | -| Time | | | | Attribute | instant | -| | | | | | of time, | -| | | | | - isInva | starting | -| | | | | riant: | at the | -| | | | | fal | TimePerio | -| | | | | se | d | -| | | | | | Notes: If | -| | | | | - valueR | null, | -| | | | | ange: | then | -| | | | | no | represent | -| | | | | ran | s | -| | | | | ge | to the | -| | | | | con | beginning | -| | | | | straint | of time | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| endDateTi | EDate | 1 | RW | OpenModel | An | -| me | | | | Attribute | instant | -| | | | | | of time, | -| | | | | - isInva | ending at | -| | | | | riant: | the | -| | | | | fal | TimePerio | -| | | | | se | d: | -| | | | | | Notes: If | -| | | | | - valueR | null, | -| | | | | ange: | then | -| | | | | no | represent | -| | | | | ran | s | -| | | | | ge | to the | -| | | | | con | end of | -| | | | | straint | time | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -VirtualLinkToLevelMapping -------------------------- - -The VirtualLinkToLevelMapping datatype specifies the profile to be used -for a VL involved in a given NS level and bitrate requirements. - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| virtualLi | invalid | 1 | RW | OpenModel | Identifie | -| nkProfile | | | | Attribute | s | -| Id | | | | | the | -| | | | | - isInva | profile | -| | | | | riant: | to be | -| | | | | fal | used for | -| | | | | se | a VL | -| | | | | | involved | -| | | | | - valueR | in an NS | -| | | | | ange: | level. | -| | | | | no | | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| bitRateRe | invalid | 1 | RW | OpenModel | Specifies | -| quirement | | | | Attribute | the bit | -| s | | | | | rate | -| | | | | - isInva | requireme | -| | | | | riant: | nts | -| | | | | fal | for the | -| | | | | se | NS level. | -| | | | | | NOTE: It | -| | | | | - valueR | shall be | -| | | | | ange: | in the | -| | | | | no | range of | -| | | | | ran | minBitrat | -| | | | | ge | eRequirem | -| | | | | con | ents | -| | | | | straint | - | -| | | | | | maxBitrat | -| | | | | - suppor | eRequirem | -| | | | | t: | ents, | -| | | | | MAN | as | -| | | | | DATORY | specified | -| | | | | | in the | -| | | | | | reference | -| | | | | | d | -| | | | | | VirtualLi | -| | | | | | nkProfile | -| | | | | | . | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -VnfIndicatorData ----------------- - -The VnfIndicatorData datatype identifies a VNF indicator in a VNFD. - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| vnfdId | invalid | 1 | RW | OpenModel | Identifie | -| | | | | Attribute | s | -| | | | | | a VNFD. | -| | | | | - isInva | | -| | | | | riant: | | -| | | | | fal | | -| | | | | se | | -| | | | | | | -| | | | | - valueR | | -| | | | | ange: | | -| | | | | no | | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| vnfIndica | invalid | 1 | RW | OpenModel | Identifie | -| tor | | | | Attribute | s | -| | | | | | a VNF | -| | | | | - isInva | indicator | -| | | | | riant: | within | -| | | | | fal | the VNFD. | -| | | | | se | | -| | | | | | | -| | | | | - valueR | | -| | | | | ange: | | -| | | | | no | | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -VnfToLevelMapping ------------------ - -The VnfToLevelMapping datatype specifies the profile to be used for a -VNF involved in a given NS level and the required number of instances. - -+-----------+-----------+-----------+-----------+-----------+-----------+ -| **Attribu | **Type** | **Mult.** | **Access* | **Stereot | **Descrip | -| te | | | * | ypes** | tion** | -| Name** | | | | | | -+===========+===========+===========+===========+===========+===========+ -| vnfProfil | invalid | 1 | RW | OpenModel | Identifie | -| eId | | | | Attribute | s | -| | | | | | the | -| | | | | - isInva | profile | -| | | | | riant: | to be | -| | | | | fal | used for | -| | | | | se | a VNF | -| | | | | | involved | -| | | | | - valueR | in an NS | -| | | | | ange: | level. | -| | | | | no | | -| | | | | ran | | -| | | | | ge | | -| | | | | con | | -| | | | | straint | | -| | | | | | | -| | | | | - suppor | | -| | | | | t: | | -| | | | | MAN | | -| | | | | DATORY | | -+-----------+-----------+-----------+-----------+-----------+-----------+ -| numberOfI | Integer | 1 | RW | OpenModel | Specifies | -| nstances | | | | Attribute | the | -| | | | | | number of | -| | | | | - isInva | VNF | -| | | | | riant: | instances | -| | | | | fal | required | -| | | | | se | for an NS | -| | | | | | level. | -| | | | | - valueR | NOTE 1: | -| | | | | ange: | It shall | -| | | | | no | be in the | -| | | | | ran | range of | -| | | | | ge | minNumber | -| | | | | con | OfInstanc | -| | | | | straint | es-maxNum | -| | | | | | berOfInst | -| | | | | - suppor | ances, | -| | | | | t: | as | -| | | | | MAN | specified | -| | | | | DATORY | in the | -| | | | | | reference | -| | | | | | d | -| | | | | | VnfProfil | -| | | | | | e. | -| | | | | | NOTE 2: | -| | | | | | When the | -| | | | | | correspon | -| | | | | | ding | -| | | | | | NS level | -| | | | | | is used | -| | | | | | in the | -| | | | | | context | -| | | | | | of NS | -| | | | | | instantia | -| | | | | | tion, | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | attribute | -| | | | | | specifies | -| | | | | | the | -| | | | | | number of | -| | | | | | VNF | -| | | | | | instances | -| | | | | | to be | -| | | | | | deployed. | -| | | | | | NOTE 3: | -| | | | | | When the | -| | | | | | correspon | -| | | | | | ding | -| | | | | | NS level | -| | | | | | is used | -| | | | | | in the | -| | | | | | context | -| | | | | | of NS | -| | | | | | scaling, | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | attribute | -| | | | | | does not | -| | | | | | specify | -| | | | | | the | -| | | | | | number of | -| | | | | | VNF | -| | | | | | instances | -| | | | | | to be | -| | | | | | added/rem | -| | | | | | oved | -| | | | | | when | -| | | | | | reaching | -| | | | | | that NS | -| | | | | | scale | -| | | | | | level. | -| | | | | | The | -| | | | | | actual | -| | | | | | number of | -| | | | | | VNF | -| | | | | | instances | -| | | | | | to be | -| | | | | | added/rem | -| | | | | | oved | -| | | | | | can be | -| | | | | | derived | -| | | | | | by | -| | | | | | subtracti | -| | | | | | ng | -| | | | | | the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | declared | -| | | | | | in the | -| | | | | | source NS | -| | | | | | scale | -| | | | | | level | -| | | | | | from the | -| | | | | | numberOfI | -| | | | | | nstances | -| | | | | | declared | -| | | | | | in the | -| | | | | | target NS | -| | | | | | level of | -| | | | | | the | -| | | | | | scaling | -| | | | | | request. | -+-----------+-----------+-----------+-----------+-----------+-----------+ - -Enumerations -============ - -Action -------- - -Contains Enumeration Literals: - -- ADD: - -- MODIFY: - -- DELETE: - -- NO_CHANGE: - -OrderPriority --------------- - -A way that can be used by order requester to prioritize orders in -Service Order Management system (from 0 to 4: 0 is the highest priority, -and 4 the lowest). It could be for example valued by BSS based on -customer order requested priority. - -Contains Enumeration Literals: - -- 0: - -- 1: - -- 2: - -- 3: - -- 4: - -OrderState ------------ - -Contains Enumeration Literals: - -- ACKNOWLEDGED: - -- IN_PROGRESS: - -- PENDING: - -- HELD: - -- CANCELLED: - -- COMPLETED: - -- FAILED: - -- PARTIAL: - -- REJECTED: diff --git a/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst b/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst new file mode 100644 index 0000000..bf7ba8c --- /dev/null +++ b/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst @@ -0,0 +1,613 @@ +.. Copyright 2020 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Atomic / Composite Service View +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. contents:: + :depth: 3 +.. + + +|image0| + +Classes +======= + +ServiceAtomicDescriptor +----------------------- + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +====================================== ==================================== ========= ================================== ===================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +====================================== ==================================== ========= ================================== ===================================================================================================================================================== +\_serviceAtomicInstance ServiceAtomicInstance 0..\* OpenModelAttribute An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary The name of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary The description of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary The service model version. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +icon String 1 Preliminary The icon path of the service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +====================================== ==================================== ========= ================================== ===================================================================================================================================================== + +ServiceAtomicInstance +--------------------- + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +orchestrationStatus String 1 Preliminary Orchestration status of the service instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== + +ServiceCompositeDescriptor +-------------------------- + +ServcieCompositeDescriptor is used to model the design time +representation of a service component or network service. + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +====================================== ==================================== ========= ================================== ===================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +====================================== ==================================== ========= ================================== ===================================================================================================================================================== +\_serviceDescriptor ServiceDescriptor 0..\* OpenModelAttribute Describe the nested relationship between multiple Service Descriptors. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_serviceCompositeInstance ServiceCompositeInstance 0..\* OpenModelAttribute An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary The name of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary The description of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary The service model version. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +icon String 1 Preliminary The icon path of the service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +====================================== ==================================== ========= ================================== ===================================================================================================================================================== + +ServiceCompositeInstance +------------------------ + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +orchestrationStatus String 1 Preliminary Orchestration status of the service instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== + +ServiceDescriptor +----------------- + +ServiceDescriptor is used to model the design time representation of a +service. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ========== ========= ================================== ===================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ========== ========= ================================== ===================================================================================================================================================== +serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary The name of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary The description of the service model designed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +version String 1 Preliminary The service model version. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +icon String 1 Preliminary The icon path of the service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========== ========= ================================== ===================================================================================================================================================== + +ServiceInstance +--------------- + +ServiceInstance is used to model the run time representation of a +service. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== +serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL +serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +orchestrationStatus String 1 Preliminary Orchestration status of the service instance. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== + +.. |image0| image:: Nested Service final for Rst.png + diff --git a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/ServiceModel-Service order.rst new file mode 100644 index 0000000..ead6beb --- /dev/null +++ b/docs/ONAP Model Spec/im/ServiceModel-Service order.rst @@ -0,0 +1,393 @@ +.. Copyright 2020 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Service Order +~~~~~~~~~~~~~ + +.. contents:: + :depth: 3 +.. + + +|image0| + +Classes +======= + +OrderItemRelationship +--------------------- + +Enables specifying any kind of relationships between ServiceOrderItems + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ===================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ===================================================== +type String 1 Preliminary The type of relationship such as contains, relies on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ===================================================== + +OrderRelationship +----------------- + +An association between two ServiceOrders. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =============================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =============================================================================== +type String 1 Preliminary A categorization of the relationship, such as bulk, parent/child, and so forth. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =============================================================================== + +ServiceCharacteristic +--------------------- + +A quality or distinctive feature that defines an entity, including the +name of this feature (attribute), and the type of the actual value. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +name String 1 Preliminary Name of dynamic characteristic (attribute). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary Type of the dynamic characteristic value. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +ServiceOrder +------------ + +A type of Request that represents a Customer Order's products decomposed +into the services through which the products are realized. + +**Parent class:** Request + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +======================= ================ ========= ================================== ============================================================================================================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +======================= ================ ========= ================================== ============================================================================================================================================================================= +id String 1 OpenModelAttribute Unique identifier for Interaction. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +externalId String 1 OpenModelAttribute ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +priority OrderPriority 1 OpenModelAttribute A way that can be used by order requester to prioritize orders in Service Order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1 OpenModelAttribute Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option",). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +state OrderState 1 OpenModelAttribute State of the order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +completionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedStartDate EDate 1 OpenModelAttribute The date that was requested to start processing the order. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +expectedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is expected to be completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +startDate EDate 1 OpenModelAttribute The date on which an interaction is started. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +notificationContact String 1 OpenModelAttribute Contact attached to the order to send back information regarding this order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_serviceOrderItem ServiceOrderItem 1..\* OpenModelAttribute Reference to ServiceOrderItem + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +OrderDate EDate 1 OpenModelAttribute The date the order was placed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +======================= ================ ========= ================================== ============================================================================================================================================================================= + +ServiceOrderItem +---------------- + +The purpose for the ServiceOrder expressed in terms of a +ServiceSpecification or a Service. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ========== ========= ================================== ============================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ========== ========= ================================== ============================================================================================= +id String 1 Preliminary Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +action Action 1 Preliminary The action to take for an InteractionItem, such as add, change, remove. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +state OrderState 1 Preliminary State of the order item: described in the state machine diagram. This is the requested state. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Quantity Integer 1 Preliminary Quantity of an interaction item involved in an interaction. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========== ========= ================================== ============================================================================================= + +Value +----- + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +value String 1 Preliminary The value of a given ServiceCharacteristic. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +Enumerations +============ + +Action +------ + +Contains Enumeration Literals: + +- ADD: + +- MODIFY: + +- DELETE: + +- NO_CHANGE: + +OrderPriority +------------- + +A way that can be used by order requester to prioritize orders in +Service Order Management system (from 0 to 4: 0 is the highest priority, +and 4 the lowest). It could be for example valued by BSS based on +customer order requested priority. + +Contains Enumeration Literals: + +- 0: + +- 1: + +- 2: + +- 3: + +- 4: + +OrderState +---------- + +Contains Enumeration Literals: + +- ACKNOWLEDGED: + +- IN_PROGRESS: + +- PENDING: + +- HELD: + +- CANCELLED: + +- COMPLETED: + +- FAILED: + +- PARTIAL: + +- REJECTED: + +.. |image0| image:: ServiceOrderR4.png diff --git a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG b/docs/ONAP Model Spec/im/ServiceOrderR4.PNG Binary files differnew file mode 100644 index 0000000..5283fa0 --- /dev/null +++ b/docs/ONAP Model Spec/im/ServiceOrderR4.PNG diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst index 94c73c8..6645f46 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -1,4 +1,4 @@ -.. Copyright 2019 (China Mobile) +.. Copyright 2020 (China Mobile) .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode .. onap-documentation documentation master file, created by @@ -15,6 +15,10 @@ ONAP Information Model Specifications Root VnfdAndVnfInstance NSD - Service BusinessInteraction VES index + ServiceModel-Nested Service + ServiceModel-Service order + NSDR4 + Nested Service final for Rst + ServiceOrderR4
\ No newline at end of file |
