docs/ONAP release 2 spec/im/virtuallinkprofile.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

.. 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

Class: VirtualLinkProfile
=========================

+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| **Attribute Name**              | **Type**                        | **Multiplicity** | **Description**       | **Applied Stereotypes**  |
+=================================+=================================+==================+=======================+==========================+
| vnfVirtualLinkDescId            | Identifier                      | 1                | Uniquely              | support:                 |
|                                 | (Reference                      |                  | identifies            | MANDATORY                |
|                                 | to                              |                  | a Vnf VLD.            |                          |
|                                 | VnfVirtualLinkDesc)             |                  |                       |                          |
|                                 |                                 |                  |                       |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| flavourId                       | Identifier                      | 1                | Identifies            | support:                 |
|                                 | (Reference                      |                  | a flavour             | MANDATORY                |
|                                 | to                              |                  | within the            |                          |
|                                 | VirtualLinkDescFlavour)         |                  | VnfVirtualLinkDesc.   |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N             | Specifies             | support:                 |
|                                 |                                 |                  | affinity or           | MANDATORY                |
|                                 |                                 |                  | anti-affinity         |                          |
|                                 |                                 |                  | rules                 |                          |
|                                 |                                 |                  | applicable            |                          |
|                                 |                                 |                  | between the           |                          |
|                                 |                                 |                  | VLs based             |                          |
|                                 |                                 |                  | on this               |                          |
|                                 |                                 |                  | VnfVirtualLinkDesc.   |                          |
|                                 |                                 |                  |                       |                          |
|                                 |                                 |                  | When the              |                          |
|                                 |                                 |                  | cardinality           |                          |
|                                 |                                 |                  | is greater            |                          |
|                                 |                                 |                  | than 1,               |                          |
|                                 |                                 |                  | both                  |                          |
|                                 |                                 |                  | affinity              |                          |
|                                 |                                 |                  | rule(s) and           |                          |
|                                 |                                 |                  | anti-affinity         |                          |
|                                 |                                 |                  | rule(s) with          |                          |
|                                 |                                 |                  | different             |                          |
|                                 |                                 |                  | scopes are            |                          |
|                                 |                                 |                  | applicable            |                          |
|                                 |                                 |                  | to the VLs            |                          |
|                                 |                                 |                  | based on this         |                          |
|                                 |                                 |                  | VnfVirtualLinkDesc.   |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| affinityOrAntiAffinityGroupId   | Identifier                      | 0..N             | Identifier(s)         | support:                 |
|                                 |                                 |                  | of the                | MANDATORY                |
|                                 |                                 |                  | affinity or           |                          |
|                                 |                                 |                  | anti-affinity         |                          |
|                                 |                                 |                  | group(s) the          |                          |
|                                 |                                 |                  | VnfVirtualLinkDesc    |                          |
|                                 |                                 |                  | belongs to.           |                          |
|                                 |                                 |                  |                       |                          |
|                                 |                                 |                  | NOTE: Each            |                          |
|                                 |                                 |                  | identifier            |                          |
|                                 |                                 |                  | references            |                          |
|                                 |                                 |                  | an affinity           |                          |
|                                 |                                 |                  | or                    |                          |
|                                 |                                 |                  | anti-affinity         |                          |
|                                 |                                 |                  | group which           |                          |
|                                 |                                 |                  | expresses             |                          |
|                                 |                                 |                  | affinity or           |                          |
|                                 |                                 |                  | anti-affinity         |                          |
|                                 |                                 |                  | relationship          |                          |
|                                 |                                 |                  | between the           |                          |
|                                 |                                 |                  | VL(s) using           |                          |
|                                 |                                 |                  | this                  |                          |
|                                 |                                 |                  | VnfVirtualLinkDesc    |                          |
|                                 |                                 |                  | and the               |                          |
|                                 |                                 |                  | VL(s) using           |                          |
|                                 |                                 |                  | other                 |                          |
|                                 |                                 |                  | VnfVirtualLinkDesc(s) |                          |
|                                 |                                 |                  | in the same group.    |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| maxBitRateRequirements          | LinkBitrateRequirements         | 1                | Specifies             | support:                 |
|                                 |                                 |                  | the maximum           | MANDATORY                |
|                                 |                                 |                  | bitrate               |                          |
|                                 |                                 |                  | requirements          |                          |
|                                 |                                 |                  | for a VL              |                          |
|                                 |                                 |                  | instantiated          |                          |
|                                 |                                 |                  | according             |                          |
|                                 |                                 |                  | to this               |                          |
|                                 |                                 |                  | profile.              |                          |
|                                 |                                 |                  |                       |                          |
|                                 |                                 |                  | NOTE: These           |                          |
|                                 |                                 |                  | attributes            |                          |
|                                 |                                 |                  | are used to           |                          |
|                                 |                                 |                  | control               |                          |
|                                 |                                 |                  | scaling               |                          |
|                                 |                                 |                  | boundaries.           |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| minBitRateRequirements          | LinkBitrateRequirements         | 1                | Specifies             | support:                 |
|                                 |                                 |                  | the minimum           | MANDATORY                |
|                                 |                                 |                  | bitrate               |                          |
|                                 |                                 |                  | requirements          |                          |
|                                 |                                 |                  | for a VL              |                          |
|                                 |                                 |                  | instantiated          |                          |
|                                 |                                 |                  | according             |                          |
|                                 |                                 |                  | to this               |                          |
|                                 |                                 |                  | profile.              |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| initiationParameters            | KeyValuePair                    | 0..N             | Specifies             | support:                 |
|                                 |                                 |                  | initiation            | MANDATORY                |
|                                 |                                 |                  | parameters            |                          |
|                                 |                                 |                  | for the               | valueRange:              |
|                                 |                                 |                  | virtual               |  specified               |
|                                 |                                 |                  | link.                 | values                   |
|                                 |                                 |                  |                       | include:                 |
|                                 |                                 |                  |                       | cidr,                    |
|                                 |                                 |                  |                       | allocationPools          |
|                                 |                                 |                  |                       | (represented             |
|                                 |                                 |                  |                       | by                       |
|                                 |                                 |                  |                       | [starting                |
|                                 |                                 |                  |                       | ip address,              |
|                                 |                                 |                  |                       | ending ip                |
|                                 |                                 |                  |                       | address]),               |
|                                 |                                 |                  |                       | gatewayIp,               |
|                                 |                                 |                  |                       | networkName,             |
|                                 |                                 |                  |                       | segmentationId,          |
|                                 |                                 |                  |                       | physicalNetwork.         |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| networkType                     | Enum                            | 0..1             | Type of the           | support:                 |
|                                 |                                 |                  | network.              | MANDATORY                |
|                                 |                                 |                  |                       |                          |
|                                 |                                 |                  |                       | valueRange:              |
|                                 |                                 |                  |                       | "VLAN",                  |
|                                 |                                 |                  |                       | "VXLAN"                  |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| dhcpEnabled                     | Boolean                         | 0..1             | Indicating            | support:                 |
|                                 |                                 |                  | whether               | MANDATORY                |
|                                 |                                 |                  | DHCP is               |                          |
|                                 |                                 |                  | enabled.              |                          |
|                                 |                                 |                  | Default is            |                          |
|                                 |                                 |                  | "FALSE" if            |                          |
|                                 |                                 |                  | not                   |                          |
|                                 |                                 |                  | specified             |                          |
|                                 |                                 |                  | otherwise.            |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+
| vlanTransparent                 | Boolean                         | 0..1             | Indicating            | support:                 |
|                                 |                                 |                  | whether               | MANDATORY                |
|                                 |                                 |                  | "VLAN                 |                          |
|                                 |                                 |                  | Transparent           |                          |
|                                 |                                 |                  | Mode" is              |                          |
|                                 |                                 |                  | supported.            |                          |
|                                 |                                 |                  | Default is            |                          |
|                                 |                                 |                  | "FALSE" if            |                          |
|                                 |                                 |                  | not                   |                          |
|                                 |                                 |                  | specified             |                          |
|                                 |                                 |                  | otherwise.            |                          |
+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+