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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
(the "License"); you may not use this documentation except in compliance
with the License. You may obtain a copy of the License at
.. https://creativecommons.org/licenses/by/4.0/
.. Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
VNF License Information Guidelines
----------------------------------
This Appendix describes the metadata to be supplied for VNF licenses.
1. General Information
Table C1 defines the required and optional fields for licenses.
Table C1. Required Fields for General Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------+-----------------------------------+--------------+----------+
| **Field Name**| **Description** | **Data Type**| **Type** |
+===============+===================================+==============+==========+
| VNF Provider | The name of the VNF provider. | String | Mandatory|
| Name | | | |
+---------------+-----------------------------------+--------------+----------+
| VNF Provider | The name of the product to which | String | Mandatory|
| Product | this agreement applies. | | |
| | | | |
| | Note: a contract/agreement may | | |
| | apply to more than one VNF | | |
| | provider product. In that case, | | |
| | provide the metadata for each | | |
| | product separately. | | |
+---------------+-----------------------------------+--------------+----------+
| VNF Provider | A general description of VNF | String | Optional |
| Product | provider software product. | | |
| Description | | | |
+---------------+-----------------------------------+--------------+----------+
| Export Control| ECCNs are 5-character | String | Mandatory|
| Classification| alpha-numeric designations used on| | |
| Number (ECCN) | the Commerce Control List (CCL) to| | |
| | identify dual-use items for export| | |
| | control purposes. An ECCN | | |
| | categorizes items based on the | | |
| | nature of the product, i.e. type | | |
| | of commodity, software, or | | |
| | technology and its respective | | |
| | technical parameters. | | |
+---------------+-----------------------------------+--------------+----------+
| Reporting | A list of any reporting | List of | Optional |
| Requirements | requirements on the usage of the | strings | |
| | software product. | | |
+---------------+-----------------------------------+--------------+----------+
1. Entitlements
Entitlements describe software license use rights. The use rights may be
quantified by various metrics: # users, # software instances, # units.
The use rights may be limited by various criteria: location (physical or
logical), type of customer, type of device, time, etc.
One or more entitlements can be defined; each one consists of the
following fields:
Table C2. Required Fields for Entitlements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------+-----------------------------------+-------------+-----------+
| **Field Name**| **Description** |**Data Type**| **Type** |
+===============+===================================+=============+===========+
| VNF Provider | Identifier for the entitlement as | String | Mandatory |
| Part Number / | described by the VNF provider in | | |
| Manufacture | their price list / catalog / | | |
| Reference | contract. | | |
| Number | | | |
+---------------+-----------------------------------+-------------+-----------+
| Description | Verbiage that describes the | String | Optional |
| | entitlement | | |
+---------------+-----------------------------------+-------------+-----------+
| Entitlement | Each entitlement defined must be | String | Mandatory |
| Identifier | identified by a unique value (e.g.| | |
| | numbered 1, 2, 3….) | | |
+---------------+-----------------------------------+-------------+-----------+
| Minimum Order | The minimum number of entitlements| Number | Mandatory |
| Requirement | that need to be purchased. | | |
| | For example, the entitlements must| | |
| | be purchased in a block of 100. If| | |
| | no minimum is required, the value | | |
| | will be zero. | | |
+---------------+-----------------------------------+-------------+-----------+
| Unique | A list of any reporting | List of | Optional |
| Reporting | requirements on the usage of the | Strings | |
| Requirements | software product. (e.g.: quarterly| | |
| | usage reports are required) | | |
+---------------+-----------------------------------+-------------+-----------+
| License Type | Type of license applicable to the | String | Mandatory |
| | software product. (e.g.: | | |
| | fixed-term, perpetual, trial, | | |
| | subscription.) | | |
+---------------+-----------------------------------+-------------+-----------+
| License | Valid values: | String |Conditional|
| Duration | | | |
| | **year**, **quarter**, **month**, | | |
| | **day**. | | |
| | | | |
| | Not applicable when license type | | |
| | is Perpetual. | | |
+---------------+-----------------------------------+-------------+-----------+
| License | Number of years, quarters, months,| Number |Conditional|
| Duration | or days for which the license is | | |
| Quantification| valid. | | |
| | | | |
| | Not applicable when license type | | |
| | is Perpetual. | | |
+---------------+-----------------------------------+-------------+-----------+
| Limits | see section C.4 for possible | List | Optional |
| | values | | |
+---------------+-----------------------------------+-------------+-----------+
1. License Keys
This section defines information on any License Keys associated with the
Software Product. A license key is a data string (or a file) providing a
means to authorize the use of software. License key does not provide
entitlement information.
License Keys are not required. Optionally, one or more license keys can
be defined; each one consists of the following fields:
Table C3. Required Fields for License Keys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------+-----------------------------------+--------------+----------+
| **Field Name**| **Description** | **Data Type**| **Type** |
+===============+===================================+==============+==========+
| Description | Verbiage that describes the | String | Mandatory|
| | license key | | |
+---------------+-----------------------------------+--------------+----------+
| License Key | Each license key defined must be | String | Mandatory|
| Identifier | identified by a unique value | | |
| | (e.g., numbered 1, 2, 3….) | | |
+---------------+-----------------------------------+--------------+----------+
| Key Function | Lifecycle stage (e.g., | String | Optional |
| | Instantiation or Activation) at | | |
| | which the license key is applied | | |
| | to the software. | | |
+---------------+-----------------------------------+--------------+----------+
| License Key | Valid values: | String | Mandatory|
| Type | | | |
| | **Universal, Unique** | | |
| | | | |
| | **Universal** - a single license | | |
| | key value that may be used with | | |
| | any number of instances of the | | |
| | software. | | |
| | | | |
| | **Unique**- a unique license key | | |
| | value is required for each | | |
| | instance of the software. | | |
+---------------+-----------------------------------+--------------+----------+
| Limits | see section C.4 for possible | List | Optional |
| | values | | |
+---------------+-----------------------------------+--------------+----------+
1. Entitlement and License Key Limits
Limitations on the use of software entitlements and license keys may be
based on factors such as: features enabled in the product, the allowed
capacity of the product, number of installations, etc... The limits may
generally be categorized as:
- where (location)
- when (time)
- how (usages)
- who/what (entity)
- amount (how much)
Multiple limits may be applicable for an entitlement or license key.
Each limit may further be described by limit behavior, duration,
quantification, aggregation, aggregation interval, start date, end date,
and threshold.
When the limit is associated with a quantity, the quantity is relative
to an instance of the entitlement or license key. For example:
- Each entitlement grants the right to 50 concurrent users. If 10
entitlements are purchased, the total number of concurrent users
permitted would be 500. In this example, the limit category is
**amount**, the limit type is **users**, and the limit
**quantification** is **50.**
Each license key may be installed on 3 devices. If 5 license keys are
acquired, the total number of devices allowed would be 15. In this
example, the limit category is **usages**, the limit type is
**device**, and the limit **quantification** is **3.**
1. Location
Locations may be logical or physical location (e.g., site, country). For
example:
- use is allowed in Canada
Table C4. Required Fields for Location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------+--------------------------------+--------------+----------+
| **Field Name** | **Description** | **Data Type**| **Type** |
+==================+================================+==============+==========+
| Limit Identifier | Each limit defined for an | String | Mandatory|
| | entitlement or license key must| | |
| | be identified by a unique value| | |
| | (e.g., numbered 1,2,3…) | | |
+------------------+--------------------------------+--------------+----------+
| Limit Description| Verbiage describing the limit. | String | Mandatory|
+------------------+--------------------------------+--------------+----------+
| Limit Behavior | Description of the actions | String | Mandatory|
| | taken when the limit boundaries| | |
| | are reached. | | |
+------------------+--------------------------------+--------------+----------+
| Limit Category | Valid value: **location** | String | Mandatory|
+------------------+--------------------------------+--------------+----------+
| Limit Type | Valid values: **city, county, | String | Mandatory|
| | state, country, region, MSA, | | |
| | BTA, CLLI** | | |
+------------------+--------------------------------+--------------+----------+
| Limit List | List of locations where the VNF| List of | Mandatory|
| | provider Product can be used or| String | |
| | needs to be restricted from use| | |
+------------------+--------------------------------+--------------+----------+
| Limit Set Type | Indicates if the list is an | String | Mandatory|
| | inclusion or exclusion. | | |
| | | | |
| | Valid Values: | | |
| | | | |
| | **Allowed** | | |
| | | | |
| | **Not allowed** | | |
+------------------+--------------------------------+--------------+----------+
| Limit | The quantity (amount) the limit| Number | Optional |
| Quantification | expresses. | | |
+------------------+--------------------------------+--------------+----------+
1. Time
Limit on the length of time the software may be used. For example:
- license key valid for 1 year from activation
- entitlement valid from 15 May 2018 thru 30 June 2020
Table C5. Required Fields for Time
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------+-------------------------------+--------------+-----------+
| **Field Name** | **Description** | **Data Type**| **Type** |
+==================+===============================+==============+===========+
| Limit Identifier | Each limit defined for an | String | Mandatory |
| | entitlement or license key | | |
| | must be identified by a unique| | |
| | value (e.g., numbered) | | |
+------------------+-------------------------------+--------------+-----------+
| Limit Description| Verbiage describing the limit.| String | Mandatory |
+------------------+-------------------------------+--------------+-----------+
| Limit Behavior | Description of the actions | String | Mandatory |
| | taken when the limit | | |
| | boundaries are reached. | | |
| | | | |
| | The limit behavior may also | | |
| | describe when a time limit | | |
| | takes effect. (e.g., key is | | |
| | valid for 1 year from date of | | |
| | purchase). | | |
+------------------+-------------------------------+--------------+-----------+
| Limit Category | Valid value: **time** | String | Mandatory |
+------------------+-------------------------------+--------------+-----------+
| Limit Type | Valid values: | String | Mandatory |
| | **duration, date** | | |
+------------------+-------------------------------+--------------+-----------+
| Limit List | List of times for which the | List of | Mandatory |
| | VNF Provider Product can be | String | |
| | used or needs to be restricted| | |
| | from use | | |
+------------------+-------------------------------+--------------+-----------+
| Duration Units | Required when limit type is | String |Conditional|
| | duration. Valid values: | | |
| | **perpetual, year, quarter, | | |
| | month, day, minute, second, | | |
| | millisecond** | | |
+------------------+-------------------------------+--------------+-----------+
| Limit | The quantity (amount) the | Number | Optional |
| Quantification | limit expresses. | | |
+------------------+-------------------------------+--------------+-----------+
| Start Date | Required when limit type is | Date | Optional |
| | date. | | |
+------------------+-------------------------------+--------------+-----------+
| End Date | May be used when limit type is| Date | Optional |
| | date. | | |
+------------------+-------------------------------+--------------+-----------+
1. Usage
Limits based on how the software is used. For example:
- use is limited to a specific sub-set of the features/capabilities the
software supports
- use is limited to a certain environment (e.g., test, development,
production…)
- use is limited by processor (vm, cpu, core)
- use is limited by software release
Table C6. Required Fields for Usage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------+-------------------------------+---------------+----------+
| **Field Name** | **Description** | **Data Type** | **Type** |
+==================+===============================+===============+==========+
| Limit Identifier | Each limit defined for an | String | Mandatory|
| | entitlement or license key | | |
| | must be identified by a unique| | |
| | value (e.g., numbered) | | |
+------------------+-------------------------------+---------------+----------+
| Limit Description| Verbiage describing the limit.| String | Mandatory|
+------------------+-------------------------------+---------------+----------+
| Limit Behavior | Description of the actions | String | Mandatory|
| | taken when the limit | | |
| | boundaries are reached. | | |
+------------------+-------------------------------+---------------+----------+
| Limit Category | Valid value: **usages** | String | Mandatory|
+------------------+-------------------------------+---------------+----------+
| Limit Type | Valid values: **feature, | String | Mandatory|
| | environment, processor, | | |
| | version** | | |
+------------------+-------------------------------+---------------+----------+
| Limit List | List of usage limits (e.g., | List of String| Mandatory|
| | test, development, vm, core, | | |
| | R1.2.1, R1.3.5…) | | |
+------------------+-------------------------------+---------------+----------+
| Limit Set Type | Indicates if the list is an | String | Mandatory|
| | inclusion or exclusion. | | |
| | | | |
| | Valid Values: | | |
| | | | |
| | **Allowed** | | |
| | | | |
| | **Not allowed** | | |
+------------------+-------------------------------+---------------+----------+
| Limit | The quantity (amount) the | Number | Optional |
| Quantification | limit expresses. | | |
+------------------+-------------------------------+---------------+----------+
1. Entity
Limit on the entity (product line, organization, customer) allowed to
make use of the software. For example:
- allowed to be used in support of wireless products
- allowed to be used only for government entities
Table C7. Required Fields for Entity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------+--------------------------------+--------------+----------+
| **Field Name** | **Description** |**Data Type** | **Type** |
+==================+================================+==============+==========+
| Limit Identifier | Each limit defined for an | String | Mandatory|
| | entitlement or license key must| | |
| | be identified by a unique value| | |
| | (e.g., numbered) | | |
+------------------+--------------------------------+--------------+----------+
| Limit Description| Verbiage describing the limit. | String | Mandatory|
+------------------+--------------------------------+--------------+----------+
| Limit Behavior | Description of the actions | String | Mandatory|
| | taken when the limit boundaries| | |
| | are reached. | | |
+------------------+--------------------------------+--------------+----------+
| Limit Category | Valid value: **entity** | String | Mandatory|
+------------------+--------------------------------+--------------+----------+
| Limit Type | Valid values: **product line, | String | Mandatory|
| | organization, internal | | |
| | customer, external customer** | | |
+------------------+--------------------------------+--------------+----------+
| Limit List | List of entities for which the |List of String| Mandatory|
| | VNF Provider Product can be | | |
| | used or needs to be restricted | | |
| | from use | | |
+------------------+--------------------------------+--------------+----------+
| Limit Set Type | Indicates if the list is an | String | Mandatory|
| | inclusion or exclusion. | | |
| | | | |
| | Valid Values: | | |
| | | | |
| | **Allowed** | | |
| | | | |
| | **Not allowed** | | |
+------------------+--------------------------------+--------------+----------+
| Limit | The quantity (amount) the limit| Number | Optional |
| Quantification | expresses. | | |
+------------------+--------------------------------+--------------+----------+
1. Amount
These limits describe terms relative to utilization of the functions of
the software (for example, number of named users permitted, throughput,
or capacity). Limits of this type may also be relative to utilization of
other resources (for example, a limit for firewall software is not based
on use of the firewall software, but on the number of network
subscribers).
The metadata describing this type of limit includes the unit of measure
(e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units,
any aggregation function (e.g., peak or average users), and aggregation
interval (day, month, quarter, year, etc.).
Table C8. Required Fields for Amount
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------+---------------------------------+-------------+----------+
| **Field Name** | **Description** |**Data Type**| **Type** |
+==================+=================================+=============+==========+
| Limit Identifier | Each limit defined for an | String | Mandatory|
| | entitlement or license key must | | |
| | be identified by a unique value | | |
| | (e.g., numbered) | | |
+------------------+---------------------------------+-------------+----------+
| Limit Description| Verbiage describing the limit. | String | Mandatory|
+------------------+---------------------------------+-------------+----------+
| Limit Behavior | Description of the actions taken| String | Mandatory|
| | when the limit boundaries are | | |
| | reached. | | |
+------------------+---------------------------------+-------------+----------+
| Limit Category | Valid value: **amount** | String | Mandatory|
+------------------+---------------------------------+-------------+----------+
| Limit Type | Valid values: **trunk, user, | String | Mandatory|
| | subscriber, session, token, | | |
| | transactions, seats, KB, MB, TB,| | |
| | GB** | | |
+------------------+---------------------------------+-------------+----------+
| Type of | Is the limit relative to | String | Mandatory|
| Utilization | utilization of the functions of | | |
| | the software or relative to | | |
| | utilization of other resources? | | |
| | | | |
| | Valid values: | | |
| | | | |
| | - **software functions** | | |
| | | | |
| | - **other resources** | | |
+------------------+---------------------------------+-------------+----------+
| Limit | The quantity (amount) the limit | Number | Optional |
| Quantification | expresses. | | |
+------------------+---------------------------------+-------------+----------+
| Aggregation | Valid values: **peak, average** | String | Optional |
| Function | | | |
+------------------+---------------------------------+-------------+----------+
| Aggregation | Time period over which the | String | Optional |
| Interval | aggregation is done (e.g., | | |
| | average sessions per quarter). | | |
| | Required when an Aggregation | | |
| | Function is specified. | | |
| | | | |
| | Valid values: **day, month, | | |
| | quarter, year, minute, second, | | |
| | millisecond** | | |
+------------------+---------------------------------+-------------+----------+
| Aggregation | Is the limit quantity applicable| String | Optional |
| Scope | to a single entitlement or | | |
| | license key (each separately)? | | |
| | Or may the limit quantity be | | |
| | combined with others of the same| | |
| | type (resulting in limit amount | | |
| | that is the sum of all the | | |
| | purchased entitlements or | | |
| | license keys)? | | |
| | | | |
| | Valid values: | | |
| | | | |
| | - **single** | | |
| | | | |
| | - **combined** | | |
+------------------+---------------------------------+-------------+----------+
| Type of User | Describes the types of users of | String | Optional |
| | the functionality offered by the| | |
| | software (e.g., authorized, | | |
| | named). This field is included | | |
| | when Limit Type is user. | | |
+------------------+---------------------------------+-------------+----------+
|
