VLM is really just a Party
'Simplified' attributes for this Vendor are VendorName, and Description, which can be gotten from the Party model (PartyRole)
Only EntitlementPool attributes currently being used are Name and MRN.
Only attributes presently used are name, metric type and metric value.
Only name and type are required.
MRN should also be provided, but is not required.
Entitlement and key instances and their association to pools are in a license management system that is outside of ONAP
A&AI stores the entitlement asset tag as an attribute of the Vnf Instance
An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family.
Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules.
Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules.
Term of the license:
-fixed term
-perpetual
-unlimited
-subscription
A licenseKeyPool can contain some number of LicenseKeys.
LicenseKeyPool can contain some number of LicenseKeyInstances.
LicenseKey can have some number of service provider based limits applied to it.
lLicenseKeyPool can have some number of service provider specified PoolLimits
LicenseKey can have some number of vendor based limits applied to it.
An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits.
EntitlementPool can have some number of service provider specified limits.
An EntitlementPool and the associated Entitlements can have some number of Vendor based limits.
The EntitlementPool can have some number of Vendor specified limits.
A FeatureGroup can have one or more EntitlementPools associated with it.
The EntitlementPool can be related to one FeatureGroup
FeatureGroup can be related to some number of EntitlementPools.
FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it.
LicenseKeyPool is related to one FeatureGroup
A feature group can be related to some number of LicenseKeyPools
A Vendor can have some number of LicenseAgreements.
A LicenseAgreement is related to some vendor.
EntitlementPool can contain some number of EntitlementInstances
EntitlementPool can contain some number of EntitlementInstances.
A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs.
A License Key Pool is created for each type of License Key that is required for the VNF.
Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined.
The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor.
A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs.
Pool limits applied by the service provider
Pool limits applied by the vendor.
The license key may be ‘universal’ or ‘unique’ or ‘one-time’.
- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF.
- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse.
- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused.
Units can be either absolute or a percentage (%).
Specified threshold value for the license key pool.
Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000.
Identifier that stays the same irrespective of version.
The version of this entity.
Identifier for the entitlement as described by the vendor in their price list / catalog /contract.
Represents an instance of a license key.
NOTE: This is an experimental class and is NOT currently used by the ONAP Platform
Vendor provided license key value that is entered into the vendor VNF to activiate / unlock it.
The assignment status of the license (assigned, available, ...).
The date the license key was assigned.
Vendor provided license key file that is entered into the vendor VNF to activiate / unlock it.
A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list.
Limits can be applied by the vendor or the service provider.
Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc.
The value of some limit being applied.
Type of aggregation being performed (Peak or Average)
The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...)
Units time is specified in (day, month, hour, minute, second, millisecond.
LimitMetricType if Other enumeration is selected.
Represents an instance of a Entitlement
Specifies the use rights for the VNFs as described by the license.
NOTE: This is an experimental class and is NOT currently used by the ONAP Platform
The assignment status of the entitlement (assigned, available, ...).
The date the entitlement was assigned.
NOTE; This is experimental and not currently used by ONAP
An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined.
An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs.
Purchased entitlements are inventoried in the Entitlement Pools.
Multiple pools for the same type of entitlement may be created based on the constraints.
Note: description is required according to the inherited attribute, but it presently is optional.
Pool limits applied by the service provider
Pool limits applied by the vendor.
Reference number for the entitlement as described by the vendor in their price list / catalog /contract.
This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000.
A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example:
when 90% of the pool is in-use, trigger an additional purchase of inventory.
A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example:
when 90% of the pool is in-use, trigger an additional purchase of inventory.
Specifies the Units for the ThresholdValue.
Identifier that stays the same irrespective of version.
Identifier that stays the same irrespective of version.
The version of this entity.
The license key may be ‘universal’ or ‘unique’ or ‘one-time’.
- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF.
- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse.
- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused.
Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it.
If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a “constraint” for the pool/group.
Name of the feature group
Description of the feature group.
The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to.
The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to.
An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family.
Free form text. Includes information such as operating system or hypervisor required for the VNF instance. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules.
Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules.
Term of the license:
-fixed term
-perpetual
-unlimited
-subscription
Valid values:
year, quarter, month, day.
Not applicable when license type is Perpetual.
Units of the entitlement/license term. Valid values: year, quarter, month, day.
LicenseInventory and Purchasing outside the scope of ONAP