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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

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

.. contents::
   :depth: 3
..

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

+--------------------+-------------+------------------+-----------------+--------------------------+
| **Attribute Name** | **Type**    | **Multiplicity** | **Description** | **Applied Stereotypes**  |
+====================+=============+==================+=================+==========================+
| vnfVirtualL        | Identifier  | 1                | Uniquely        | support:                 |
| inkDescId          | (Reference  |                  | identifies      | MANDATORY                |
|                    | to          |                  | a Vnf VLD.      |                          |
|                    | VnfVirtualL |                  |                 |                          |
|                    | inkDesc)    |                  |                 |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| flavourId          | Identifier  | 1                | Identifies      | support:                 |
|                    | (Reference  |                  | a flavour       | MANDATORY                |
|                    | to          |                  | within the      |                          |
|                    | VirtualLink |                  | VnfVirtualL     |                          |
|                    | DescFlavour |                  | inkDesc.        |                          |
|                    | )           |                  |                 |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| localAffini        | LocalAffini | 0..N             | Specifies       | support:                 |
| tyOrAntiAff        | tyOrAntiAff |                  | affinity or     | MANDATORY                |
| inityRule          | inityRule   |                  | anti-affini     |                          |
|                    |             |                  | ty              |                          |
|                    |             |                  | rules           |                          |
|                    |             |                  | applicable      |                          |
|                    |             |                  | between the     |                          |
|                    |             |                  | VLs based       |                          |
|                    |             |                  | on this         |                          |
|                    |             |                  | VnfVirtualL     |                          |
|                    |             |                  | inkDesc.        |                          |
|                    |             |                  |                 |                          |
|                    |             |                  | When the        |                          |
|                    |             |                  | cardinality     |                          |
|                    |             |                  | is greater      |                          |
|                    |             |                  | than 1,         |                          |
|                    |             |                  | both            |                          |
|                    |             |                  | affinity        |                          |
|                    |             |                  | rule(s) and     |                          |
|                    |             |                  | anti-affini     |                          |
|                    |             |                  | ty              |                          |
|                    |             |                  | rule(s)         |                          |
|                    |             |                  | with            |                          |
|                    |             |                  | different       |                          |
|                    |             |                  | scopes are      |                          |
|                    |             |                  | applicable      |                          |
|                    |             |                  | to the VLs      |                          |
|                    |             |                  | based on        |                          |
|                    |             |                  | this            |                          |
|                    |             |                  | VnfVirtualL     |                          |
|                    |             |                  | inkDesc.        |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| affinityOrA        | Identifier  | 0..N             | Identifier(     | support:                 |
| ntiAffinity        |             |                  | s)              | MANDATORY                |
| GroupId            |             |                  | of the          |                          |
|                    |             |                  | affinity or     |                          |
|                    |             |                  | anti-affini     |                          |
|                    |             |                  | ty              |                          |
|                    |             |                  | group(s)        |                          |
|                    |             |                  | the             |                          |
|                    |             |                  | VnfVirtualL     |                          |
|                    |             |                  | inkDesc         |                          |
|                    |             |                  | belongs to.     |                          |
|                    |             |                  |                 |                          |
|                    |             |                  | NOTE: Each      |                          |
|                    |             |                  | identifier      |                          |
|                    |             |                  | references      |                          |
|                    |             |                  | an affinity     |                          |
|                    |             |                  | or              |                          |
|                    |             |                  | anti-affini     |                          |
|                    |             |                  | ty              |                          |
|                    |             |                  | group which     |                          |
|                    |             |                  | expresses       |                          |
|                    |             |                  | affinity or     |                          |
|                    |             |                  | anti-affini     |                          |
|                    |             |                  | ty              |                          |
|                    |             |                  | relationshi     |                          |
|                    |             |                  | p               |                          |
|                    |             |                  | between the     |                          |
|                    |             |                  | VL(s) using     |                          |
|                    |             |                  | this            |                          |
|                    |             |                  | VnfVirtualL     |                          |
|                    |             |                  | inkDesc         |                          |
|                    |             |                  | and the         |                          |
|                    |             |                  | VL(s) using     |                          |
|                    |             |                  | other           |                          |
|                    |             |                  | VnfVirtualL     |                          |
|                    |             |                  | inkDesc(s)      |                          |
|                    |             |                  | in the same     |                          |
|                    |             |                  | group.          |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| maxBitRateR        | LinkBitrate | 1                | Specifies       | support:                 |
| equirements        | Requirement |                  | the maximum     | MANDATORY                |
|                    | s           |                  | bitrate         |                          |
|                    |             |                  | requirement     |                          |
|                    |             |                  | s               |                          |
|                    |             |                  | for a VL        |                          |
|                    |             |                  | instantiate     |                          |
|                    |             |                  | d               |                          |
|                    |             |                  | according       |                          |
|                    |             |                  | to this         |                          |
|                    |             |                  | profile.        |                          |
|                    |             |                  |                 |                          |
|                    |             |                  | NOTE: These     |                          |
|                    |             |                  | attributes      |                          |
|                    |             |                  | are used to     |                          |
|                    |             |                  | control         |                          |
|                    |             |                  | scaling         |                          |
|                    |             |                  | boundaries.     |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| minBitRateR        | LinkBitrate | 1                | Specifies       | support:                 |
| equirements        | Requirement |                  | the minimum     | MANDATORY                |
|                    | s           |                  | bitrate         |                          |
|                    |             |                  | requirement     |                          |
|                    |             |                  | s               |                          |
|                    |             |                  | for a VL        |                          |
|                    |             |                  | instantiate     |                          |
|                    |             |                  | d               |                          |
|                    |             |                  | according       |                          |
|                    |             |                  | to this         |                          |
|                    |             |                  | profile.        |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| initiationP        | KeyValuePai | 0..N             | Specifies       | support:                 |
| arameters          | r/NameValue |                  | initiation      | MANDATORY                |
|                    | Pair        |                  | parameters      |                          |
|                    |             |                  | for the         | valueRange:              |
|                    |             |                  | virtual         |  specified               |
|                    |             |                  | link.           | values                   |
|                    |             |                  |                 | include:                 |
|                    |             |                  |                 | cidr,                    |
|                    |             |                  |                 | allocationP              |
|                    |             |                  |                 | ools                     |
|                    |             |                  |                 | (represente              |
|                    |             |                  |                 | d                        |
|                    |             |                  |                 | by                       |
|                    |             |                  |                 | [starting                |
|                    |             |                  |                 | ip address,              |
|                    |             |                  |                 | ending ip                |
|                    |             |                  |                 | address]),               |
|                    |             |                  |                 | gatewayIp,               |
|                    |             |                  |                 | networkName              |
|                    |             |                  |                 | ,                        |
|                    |             |                  |                 | segmentatio              |
|                    |             |                  |                 | nId,                     |
|                    |             |                  |                 | physicalNet              |
|                    |             |                  |                 | work.                    |
+--------------------+-------------+------------------+-----------------+--------------------------+
| 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.      |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+
| vlanTranspa        | Boolean     | 0..1             | Indicating      | support:                 |
| rent               |             |                  | whether         | MANDATORY                |
|                    |             |                  | "VLAN           |                          |
|                    |             |                  | Transparent     |                          |
|                    |             |                  | Mode" is        |                          |
|                    |             |                  | supported.      |                          |
|                    |             |                  | Default is      |                          |
|                    |             |                  | "FALSE" if      |                          |
|                    |             |                  | not             |                          |
|                    |             |                  | specified       |                          |
|                    |             |                  | otherwise.      |                          |
+--------------------+-------------+------------------+-----------------+--------------------------+