OPSA Working Group M. Palmero
Internet-Draft F. Brockners
Intended status: Standards Track Cisco Systems
Expires: 29 April 2022 S. Kumar
NC State University
S. Bhandari
Thoughtspot
C. Cardona
NTT
26 October 2021
Data Model for Lifecycle Management and Operations
draft-palmero-opsawg-dmlmo-02
Abstract
This document motivates and specifies a data model for lifecycle
management and operations. It describes the motivation and
requirements to collect asset-centric metrics including but not
limited to asset adoption and usability, licensing, supported
features and capabilities, enabled features and capabilities, etc.;
with the primary objective to measure and improve the overall user
experience along the lifecycle journey, from technical requirements
and technology selection through advocacy and renewal, including the
end of life of an asset.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 29 April 2022.
Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the
document authors. All rights reserved.
Palmero, et al. Expires 29 April 2022 [Page 1]
Internet-Draft DMLMO October 2021
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements language . . . . . . . . . . . . . . . . . . 4
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Motivation . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.1. License Inventory and Activation . . . . . . . . . . . . 6
4.2. Features in Use . . . . . . . . . . . . . . . . . . . . . 7
4.3. Assets in Use . . . . . . . . . . . . . . . . . . . . . . 8
4.4. Risk Mitigation Check (RMC) . . . . . . . . . . . . . . . 8
4.5. Errata . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.6. Security Advisory . . . . . . . . . . . . . . . . . . . . 9
4.7. Optimal Software Version (OSV) . . . . . . . . . . . . . 9
4.7.1. Software Conformance . . . . . . . . . . . . . . . . 9
4.7.2. Risk Trend Analysis . . . . . . . . . . . . . . . . . 10
4.7.3. What-if Analysis . . . . . . . . . . . . . . . . . . 10
4.8. Asset Retirement - End of Life (EOL) . . . . . . . . . . 11
5. Information Model . . . . . . . . . . . . . . . . . . . . . . 11
6. Data Models . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.1. Tree Diagrams of the modules that form LMO . . . . . . . 12
6.1.1. Aggregated Asset Inventory . . . . . . . . . . . . . 12
6.1.2. Licenses . . . . . . . . . . . . . . . . . . . . . . 14
6.1.3. Usage . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1.4. Incident Management . . . . . . . . . . . . . . . . . 16
6.2. LMO Modules . . . . . . . . . . . . . . . . . . . . . . . 16
6.2.1. LMO Common Module . . . . . . . . . . . . . . . . . . 16
6.2.2. Aggregated Asset Inventory . . . . . . . . . . . . . 27
6.2.3. Licenses . . . . . . . . . . . . . . . . . . . . . . 32
6.2.4. Usage . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.5. Incident Management . . . . . . . . . . . . . . . . . 45
7. Deployment Considerations . . . . . . . . . . . . . . . . . . 48
8. Security Considerations . . . . . . . . . . . . . . . . . . . 49
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 49
9.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 49
9.2. The YANG Module Names Registry . . . . . . . . . . . . . 50
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 51
10.1. Normative References . . . . . . . . . . . . . . . . . . 51
10.2. Informative References . . . . . . . . . . . . . . . . . 51
Palmero, et al. Expires 29 April 2022 [Page 2]
Internet-Draft DMLMO October 2021
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 52
Change log . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53
1. Introduction
The virtualization of hardware assets and the development of
applications using microservice architecture for cloud-native
infrastructure created new consumption and licensing models. Any
service can be deployed by composing multiple assets together where
an asset refers to hardware, software, application, system or
service. For example, cloud-native infrastructure from one vendor
may be hosted on the physical server from another vendor or a
combination of multiple cloud-native functions from one or more
vendors can be combined to execute any service.
This introduces challenges for both lifecycle and adoption management
of the assets. For example, a user may need to identify the
capability availability of different assets or measure the usage of
each capability (or the combination) from any specific asset to
measure its optimal potential. Moreover, the user could pinpoint the
reason: the software application could not be optimally deployed, or
is not simple to use, or is not well documented, etc. The user may
use feed such measurements and analysis metrics back to the support
engineers and the developers, so they can focus their work effort
only on features that users are adopting, or even determine when the
lifecycle of the development could end.
This creates the need to collect and analyze asset-centric lifecycle
management and operations data. From now on this data will be
referred as Lifecycle Management and Operations (LMO); where LMO is
not limited to virtualized or cloud environments, it covers all types
of networking environments in which technology assets are deployed.
LMO data constitutes data needed to measure asset-centric lifecycle
metrics including but not limited to asset adoption and usability,
licensing, supported features and capabilities, enabled features and
capabilities, etc. The primary objective is to facilitate the asset
lifecycle management from the initial asset selection and
positioning, licensing, feature enablement and usage, and beyond
renewal to improve the overall user experience.
The main challenge in collecting LMO-related data, especially in a
multi-vendor environment, relies on the ability to produce and
consume such data in a vendor-agnostic, consistent and synchronized
manner. APIs or telemetry are meant to collect and relay this data
to receiving equipment for storing, analysis and/or visualization.
Palmero, et al. Expires 29 April 2022 [Page 3]
Internet-Draft DMLMO October 2021
This document describes the motivation behind LMO, lists use cases,
followed by the information model and data model of LMO. The list of
use cases describes the need for new functional blocks and their
interactions. The current version of this draft is focused on asset
inventory, licenses information, feature usage and incident
management. This draft specifies four YANG modules [RFC7950] focused
on LMO, including:
* Licenses,
* Assets,
* Usage level of Asset features, and
* Incident Management.
This document is organized as follows. Section 2 establishes the
terminology and abbreviations. In Section 3, the goals and
motivation of LMO are discussed. In Section 4, use cases are
introduced. Section 5 specifies the information model and the data
models for LMO.
1.1. Requirements language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
2. Terminology
Terminology and abbreviations used in this document:
* Asset: refers to hardware, software, applications, or services.
An asset can be physical or virtual.
* Consumer: refers to an entity that utilizes the outcomes of LMO.
A consumer can be a user, a developer or some other interested
third party.
* Developer: refers to the entity that creates or develops the
entire asset or the part of the asset.
* EOL: End of Life.
* Features: are options or functional capabilities available in an
asset.
Palmero, et al. Expires 29 April 2022 [Page 4]
Internet-Draft DMLMO October 2021
* License: is issued by an entity such as the developer or the Open
Source community and allows the user to operate the asset.
Licenses determine how the asset can be leveraged and what is
required in cases the asset is changed.
* LMO: Lifecycle Management and Operations.
* Optimal Software Version(OSV): refers to the elected software
version considered optimal in the user environment.
* PID: Product Identifier.
* Usage: refers to how features of the asset are used.
* User: refers to the organization that owns or consumes the asset.
Within the organization there are entities that: a) use the assets
in their operations, b) manage the assets.
* User Experience: how a user interacts with and experiences a
particular asset. It includes a user's perceptions of ease of
use, efficiency, and utility of an asset.
3. Motivation
The user experience with a specific asset can be organized into four
classes:
1. Asset characteristic class, covering anything related to asset,
license, features, etc.
2. Utilization class, to measure how the assets and features are
used, duration of usage, uptime, etc.
3. Notification class, covering any security advisory, retirement,
etc.
4. Incident class, to record and report any problem the user has
faced with the asset.
The ability to measure, produce and consume LMO could benefit the
user organization in addressing issues such as:
* Licenses may not have been obtained at the optimum level for a
given feature, where a user might have bought licenses that are
not activated.
* Features of an asset might not be used as needed in all
deployments within the organization.
Palmero, et al. Expires 29 April 2022 [Page 5]
Internet-Draft DMLMO October 2021
* Resolution of incidents involving the asset and the developer of
the technology used within the asset.
In addition to the resolution of incidents, LMO could allow developer
organizations to optimize the features they offer. For example, they
could consider deprecating features that are used infrequently or
focus on introducing more features for the assets that are widely
deployed in various infrastructures.
LMO also covers the need of communication between users and the
developer. LMO can provide the capability for users to provide
feedback about any asset (e.g., potential deficiency of a feature,
feature enhancement request). An administrator in the user
organization may include specific metrics that identify a potential
problem of that specific feature or a capability of the asset. An
engineer in the developer organization can determine the impact of
the potential deficiency from the number of users providing feedback.
Note that this channel is different from a "call to a Technical
Assistance Center" in which the user may request help in resolving
operational issues with the asset.
4. Use Cases
4.1. License Inventory and Activation
An operations engineer would like to understand which licenses are
activated and which are used and/or consumed. It is also important
for asset users to understand which features within their assets
might need a license and how to activate them.
It is relatively straightforward to have an inventory of existing
licenses when there is only one asset developer (providing the asset)
and one asset family.
But complexity grows when there are many different developers,
systems and processes involved. New service offerings have
introduced new attributes and datasets and require alignment with new
business models (pay-per-product, subscription model, pay-as-you-go
model, etc.). They might support different license types and models:
asset activation keys, trust-based model, systems that act as proxy
from the back end owned by the asset developer to support the control
of licenses, etc.
Palmero, et al. Expires 29 April 2022 [Page 6]
Internet-Draft DMLMO October 2021
Sometimes it is a challenge to report which licenses have been bought
by the asset user, or who in the user organization owns that license
because that information might rely on different asset developers;
even within the same asset developer, licenses may correspond to
different types or groups of assets. Asset users often need to
interact with different license systems and processes.
Information on how assets are licensed could be delivered from a
combination of attributes such as: sales order, purchase order, asset
activation key, serial number, etc.
If there is no consistency on how to deal with those data points,
complexity increases for the consumer, potentially requiring manual
steps. Automating those manual steps or exceptions becomes time-
consuming, eventually leading to higher costs for the asset consumer.
Having a common data model for LMO eases the integration between
different data sources, processes, and consolidation of the
information under a common reference.
4.2. Features in Use
Feature logic is required to identify the configured features from
the running configuration and determine how they might be used.
There is often a lack of an easy method to list any configured
features available in the current asset.
This information is extracted from the running configuration many
times, implemented by a rule system without having an easy method to
list any configured features available in the current asset.
Some of these use cases need to be built on top of others, and from
them, other more complex use cases could be created. For instance,
Software Compliance use cases can be automated, based on use cases
like security advisory, errata, End of Life(EOL), etc.
All this brings a complete set of use cases that fulfills Lifecycle
Management of assets, complementing and providing metrics on how
asset users are using assets and how their experience from using
those assets can be improved.
Palmero, et al. Expires 29 April 2022 [Page 7]
Internet-Draft DMLMO October 2021
4.3. Assets in Use
Current approach to quantify how an asset is used, requires volume or
aggregated usage/consumption metrics related to deployed assets,
functions, features, integrations, etc. Also the need to quantify
which metrics might be associated to a user, an organization, to
specific services and how often are used; while others may be based
on pre agreed profile (contractural or usage) of intented use.
Examples include:
* Number of search/queries sent by the user.
* Amount of data returned to the user.
* Amount of active time spent using the asset/feature.
* Number of concurrent users accessing the asset/feature.
* Number of features in use.
* Number of users or sites using those features, etc.
The information models and data models for LMO include data fields to
support metrics that might be required by consumption-based charging
and licensing of asset usage.
4.4. Risk Mitigation Check (RMC)
Network, software and cloud engineers would like to be aware of known
issues that are causing assets to crash so that they can act to
remediate the issue quickly, or even prevent the crash if alerts are
triggered on time. There are analytics tools that can process memory
core dumps and crash-related files, providing the ability to the
asset developers to determine the root cause.
Accordingly, asset users can remediate the problem, automate the
remedy to enable incident deflection, allowing the support staff to
focus on new problems. The goal of introducing normalization is not
to define attributes for each of the elements being part of the crash
information, but the results of RMC should be normalized and
registered.
Risk Mitigation Check could also include the possibility to be aware
of current and historical restarts allowing network and software
engineers to enhance the service quality to asset users.
Palmero, et al. Expires 29 April 2022 [Page 8]
Internet-Draft DMLMO October 2021
4.5. Errata
Both hardware and software critical issues or Errata need development
to automate asset user matching:
* Hardware Errata match on product identifiers (PIDs) + serial
numbers along with additional hardware attributes.
* Software Errata match on software type and software version along
with some additional device attributes.
Engineering might develop the logic to check whether any critical
issue applies to a single serial number or a specific software
release.
The information to be correlated includes customer identification,
license, and asset information that the asset user might own. All
this information needs to be correlated with hardware and software
Errata, and EOL information to show which part of the asset inventory
might be affected.
4.6. Security Advisory
The Security Advisory use case automates the matching of asset user
data to security bulletins published by asset developers. Security
Advisory logic implemented by developers could apply to a specific
software release.
4.7. Optimal Software Version (OSV)
The objective of the Optimal Software Version (OSV) use case is that
consumers can mark software images as OSV for their assets; based on
this, it is easier for them to control and align their hardware and
software assets to the set of OSVs.
Based on the logic of OSV, use cases like software compliance, risk
trend analysis, acknowledge bugs, security advisories, errata, what-
if analysis, etc., could be realized.
4.7.1. Software Conformance
All the assets should be at their latest recommended software version
in case a security update is required to address a security issue of
a specific feature.
The Software Conformance use case provides a view to the asset users
and informs the users whether the assets that belong to a specific
group conforms to the OSV or not. It can provide the users with a
Palmero, et al. Expires 29 April 2022 [Page 9]
Internet-Draft DMLMO October 2021
report, including a representation of software compliance for the
entire network and software applications. This report could include
the current software version running on the asset and the recommended
software version. The report could enable users to quickly highlight
which group of assets might need the most attention to inspire
appropriate actions.
The Software Conformance use case uses data that might not be
provided by the asset itself. Data needs to be provided and
maintained also by the asset developers, through e.g., asset catalog
information. Similar logic applies to a feature catalog, where the
asset developer maintains the data and updates it adequately based on
existing bugs, security advisories, etc.
The Software Conformance process needs to correlate the Software
catalog information with the software version running on the asset.
4.7.2. Risk Trend Analysis
The Risk Trend Analysis use case provides customers with a risk trend
analysis, summarizing what might change before applying changes,
including registered bugs, security advisories and errata.
4.7.3. What-if Analysis
The What-if Analysis use case allows asset users to plan for new
hardware or software, giving them the possibility to change the
config parameters or model how new hardware or software might change
the software suggestions generated by OSV.
OSV and the associated use cases involve dependencies on attributes
that might need to be collected from assets directly, including
related inventory information (serial numbers, asset identifiers,
software versions, etc.), but also dynamic information could be
required, like:
* Information on features that might be enabled on the particular
asset.
* Catalogs, that might include information related to release notes.
For example, consider a feature catalog. This catalog could
include software versions that support a specific feature; the
software releases that a feature is supported in; or the latest
version that a feature is supported in, in case the feature is
EOL.
* Data sources to correlate information coming from reports on
critical issues or errata, security advisory, End of Life, etc.
Palmero, et al. Expires 29 April 2022 [Page 10]
Internet-Draft DMLMO October 2021
Those catalogs and data sources with errata information, EOL, etc.
need to be maintained and updated by asset developers, making sure,
that the software running on the assets is safe to run and up to
date.
4.8. Asset Retirement - End of Life (EOL)
Hardware EOL reports need to map Hardware EOL PIDs, focusing on base
PIDs so that bundles, spares, non-base PIDs, etc., do not provide
false EOL reporting to asset users. Software EOL reports are used to
automate the matching of user software type and software version to
software EOL bulletins.
5. Information Model
The broad metric classes defined in section 3 that quantify user
experience can be modeled as shown in Figure 1. There is an
inventory of all assets that the user possesses. Each asset in the
inventory may be entitled to one or more licenses; a license may
contain one or more sub-licenses. The level of usage for each
feature and license associated with the asset is measured. For every
asset, a list of incidents could be created.
For example, a user needs to measure the utilization of a specific
license for a specific type of asset. The information about the
license may reside in a license server. The state (activated or not)
of the license may reside with the asset itself or a proxy. They can
be aggregated/correlated as per the information model shown in
Figure 1 to give information to the user regarding the utilization of
the licenses. The user experience is thus enhanced by having
accurate knowledge about the utility of the given license.
Palmero, et al. Expires 29 April 2022 [Page 11]
Internet-Draft DMLMO October 2021
may_be_part_of may_be_part_of
+------+ +-------+
| | | |
| v v |
+------------+ entitled_by tracked_by +------------+
| Licenses |<------------+ +-------------| Usage |
+------------+-----------+ | may_be_ | +---------->+------------+
| License | entitles | | part_of | | tracks | Asset |
| attributes | | | +------+ | | | Features |
+------------+ | | | | | | | and usage |
v | | v v | | attributes |
+----------------+ +------------+
| Asset |
future_ +----------------+ generated_by
association | Asset |<----------------+
+---------->| attributes |---------------+ |
| +----------------+ generates | |
v v |
+-----------+ +------------+
| Future | | Incident |
| Expansion | +------------+
+-----------+ | Incident |
| attributes |
+------------+
Figure 1: Information Model
The model allows for future expansion by new metrics that will
quantify user experience. Notice that future asociation relationship
and future expansion might be linked to asset or to one of the other
datasets: incident, feature usage or licenses.
6. Data Models
6.1. Tree Diagrams of the modules that form LMO
6.1.1. Aggregated Asset Inventory
This specification uses [I-D.draft-ietf-netmod-geo-location-11],
[I-D.draft-ietf-opsawg-sbom-access-03]
module: ietf-lmo-assets-inventory
+--ro capture-info
| +--ro collected-on? yang:date-and-time
| +--ro collected-from? string
+--ro assets
| +--ro asset* [id]
| +--ro id lmocom:asset-id
Palmero, et al. Expires 29 April 2022 [Page 12]
Internet-Draft DMLMO October 2021
| +--ro vendor? lmocom:vendor-id
| +--ro pid? string
| +--ro serial-number? string
| +--ro vid? string
| +--ro mac-address? yang:mac-address
| +--ro ip-address* inet:ip-address
| +--ro entity-name? string
| +--ro product-description? string
| +--ro udi? string
| +--ro transparency-info? inet:uri
| +--ro type? identityref
| +--ro subtype? identityref
| +--ro role? identityref
| +--ro aggregation? boolean
| +--ro number-of-instances? uint32
| +--ro platform-dependency-os? identityref
| +--ro install-location
| | +--ro geo-location
| | +--ro reference-frame
| | | +--ro alternate-system? string {alternate-systems}?
| | | +--ro astronomical-body? string
| | | +--ro geodetic-system
| | | +--ro geodetic-datum? string
| | | +--ro coord-accuracy? decimal64
| | | +--ro height-accuracy? decimal64
| | +--ro (location)?
| | | +--:(ellipsoid)
| | | | +--ro latitude? decimal64
| | | | +--ro longitude? decimal64
| | | | +--ro height? decimal64
| | | +--:(cartesian)
| | | +--ro x? decimal64
| | | +--ro y? decimal64
| | | +--ro z? decimal64
| | +--ro velocity
| | | +--ro v-north? decimal64
| | | +--ro v-east? decimal64
| | | +--ro v-up? decimal64
| | +--ro timestamp? yang:date-and-time
| | +--ro valid-until? yang:date-and-time
| +--ro deployment-mode? identityref
| +--ro activation-date? yang:date-and-time
| +--ro software-version? string
| +--ro hotfixes
| | +--ro hostfix* []
| | +--ro version? identityref
| | +--ro order? uint8
| +--ro software-type? string
Palmero, et al. Expires 29 April 2022 [Page 13]
Internet-Draft DMLMO October 2021
| +--ro sign-of-life-timestamp? yang:date-and-time
| +--ro tags? string
+--ro subassets
+--ro subasset* [id]
+--ro id -> /assets/asset/id
6.1.2. Licenses
module: ietf-lmo-licenses
+--ro capture-info
| +--ro collected-on? yang:date-and-time
| +--ro collected-from? string
+--ro licenses
+--ro license* [id]
+--ro id lmocom:license-id-t
+--ro virtual-account? string
+--ro model lmocom:license-model-t
+--ro buying-program? identityref
+--ro offer-type? identityref
+--ro external-store? boolean
+--ro pid string
+--ro purchase-order-id? lmocom:purchase-order-t
+--ro account-id? string
+--ro organization-id? string
+--ro asset? -> /lmoasset:assets/asset/id
+--ro feature? -> /lmousage:features/feature/id
+--ro state? lmocom:license-state-t
+--ro renewal-profile
| +--ro purchase-date? yang:date-and-time
| +--ro claim-date? yang:date-and-time
| +--ro activation-date? yang:date-and-time
| +--ro expiration-date? yang:date-and-time
+--ro sublicenses
+--ro sublicense* [id]
+--ro id -> /licenses/license/id
6.1.3. Usage
module: ietf-lmo-usage
+--ro features
| +--ro feature* [id]
| +--ro id string
| +--ro name? string
| +--ro summary? string
| +--ro category? string
| +--ro entitlement? string
| +--ro first-available-version? string
| +--ro backported-versions
Palmero, et al. Expires 29 April 2022 [Page 14]
Internet-Draft DMLMO October 2021
| | +--ro backported-version* []
| | +--ro version? identityref
| +--ro scope? identityref
| +--ro config-options* [id]
| | +--ro id string
| | +--ro name? string
| | +--ro summary? string
| | +--ro characteristic* [id]
| | +--ro id string
| | +--ro name? string
| | +--ro value? string
| +--ro asset? -> /lmoasset:assets/asset/id
| +--ro subfeatures
| +--ro subfeature* [id]
| +--ro id -> /features/feature/id
+--ro usages
+--ro usage* [id]
+--ro id string
+--ro feature? -> /features/feature/id
+--ro capture-info
| +--ro collected-on? yang:date-and-time
| +--ro collected-from? string
+--ro name? string
+--ro summary? string
+--ro uri? string
+--ro deployment-mode? identityref
+--ro scope? identityref
+--ro activation-status? string
+--ro instances? uint32
+--ro count-type? identityref
+--ro timestamp? yang:date-and-time
+--ro count? uint32
+--ro frequency* [name]
| +--ro name string
| +--ro type-freq? string
| +--ro value? yang:counter64
+--ro resource-consumption* [id]
+--ro id string
+--ro name? string
+--ro summary? string
+--ro characteristic* [id]
+--ro id string
+--ro name? string
+--ro unit? string
+--ro value? yang:counter64
+--ro value-max? yang:counter64
Palmero, et al. Expires 29 April 2022 [Page 15]
Internet-Draft DMLMO October 2021
6.1.4. Incident Management
module: ietf-lmo-incident-management
+--ro tracking-number
+--ro tracking-number* [id]
+--ro id string
+--ro title? string
+--ro summary? string
+--ro severity? string
+--ro status? string
+--ro created? yang:date-and-time
+--ro last_updated? yang:date-and-time
+--ro capability? string
+--ro technology? string
+--ro subtechnology? string
+--ro problem-type? string
+--ro resolution? string
+--ro owner? string
+--ro support-engineer? string
+--ro asset? -> /lmoasset:assets/asset/id
+--ro serial-number? -> /lmoasset:assets/asset/serial-number
+--ro software-version? -> /lmoasset:assets/asset/software-version
+--ro feature? -> /lmousage:features/feature/id
+--ro contract-number? string
6.2. LMO Modules
6.2.1. LMO Common Module
<CODE BEGINS> file "ietf-lmo-common@2021-08-23.yang"
module ietf-lmo-common {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmo-common";
prefix lmocom;
organization
"IETF OPSA (Operations and Management Area) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/opsawg/>
WG List: <mailto:opsawg@ietf.org>
Editor: Marisol Palmero
<mailto:mpalmero@cisco.com>
Editor: Josh Suhr
<mailto:josuhr@cisco.com>
Editor: Sudhendu Kumar
<mailto:skumar23@ncsu.edu>";
description
"This YANG module defines a collection of useful data types
and identity for Lifecycle Management and Operations (LMO).
Palmero, et al. Expires 29 April 2022 [Page 16]
Internet-Draft DMLMO October 2021
Copyright (c) 2021 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
revision 2021-08-23 {
description
"Initial revision for Common Module as part of the LMO
YANG Model";
reference
"RFC XXXX: LMO YANG Model";
}
typedef license-id-t {
type string;
description
"License ID Type";
}
typedef license-model-t {
type enumeration {
enum perpetual {
description
"Perpetual license";
}
enum subscription {
description
"Subscription license";
}
enum usage-based {
description
"Usage-based license";
}
enum other {
description
"Undefined license type";
}
}
description
Palmero, et al. Expires 29 April 2022 [Page 17]
Internet-Draft DMLMO October 2021
"License Model Type";
}
identity license-buying-program-t {
description
"License Buying Program that contains the plan to generate
revenue for specific asset";
}
identity enterprise-agreement {
base license-buying-program-t;
description
"Enterprise Agreement";
}
identity managed-service-license-agreement {
base license-buying-program-t;
description
"Managed Service License Agreement";
}
identity service-provider-network-agreement {
base license-buying-program-t;
description
"Service Provider Network Agreement";
}
identity collab-active-user {
base license-buying-program-t;
description
"Collaboration Active User";
}
identity service-full-coverage {
base license-buying-program-t;
description
"Service Full-Coverage";
}
identity offer-type-t {
description
"License Offer Type, part of the plan to generate revenue
for specific asset";
}
identity perpetual-software {
base offer-type-t;
description
"Perpetual softwar gives the user the right to use the
program indefinitely";
}
identity standalone-hardware {
base offer-type-t;
description
"Standalone hardware is able to function independently
of other hardware";
Palmero, et al. Expires 29 April 2022 [Page 18]
Internet-Draft DMLMO October 2021
}
identity on-premise-software-subscription {
base offer-type-t;
description
"On-Premise software subscription, relates to a temporary
on-prem licencing model, allowing users to pay a per user
fee";
}
identity cloud-software-saas-subscription {
base offer-type-t;
description
"Cloud Software (SaaS) subscription is a service busines
model where the user is entitled to use the cloud software
for a specific time period";
}
identity third-party-software {
base offer-type-t;
description
"It includes licenses, agreements, obligations or other
commitment under which the user can use the asset not
directly sold by the manufacturer";
}
identity flex-cloud-prem-subscription {
base offer-type-t;
description
"Flex Cloud-Prem subscription allows software vendros to
limit the number of licenses for the use of the specific
asset";
}
typedef license-key-t {
type string;
description
"License Key Type";
}
typedef purchase-order-t {
type string;
description
"License purchase order number";
}
typedef license-state-t {
type enumeration {
enum inactive {
description
"Inactive State";
}
enum active {
description
"Active State";
Palmero, et al. Expires 29 April 2022 [Page 19]
Internet-Draft DMLMO October 2021
}
enum unknown {
description
"Unknown State";
}
}
description
"License State Type";
}
typedef asset-id {
type string;
description
"Asset ID Type";
}
typedef vendor-id {
type enumeration {
enum cisco {
description
"Vendor-id is Cisco";
}
enum other {
description
"Vendor-id is not determined";
}
}
description
"Vendor identifier";
}
identity asset-type {
description
"type of the asset: hardware, software, software cloud, ...";
}
identity hw {
base asset-type;
description
"Hardware refers to any physical device";
}
identity sw {
base asset-type;
description
"Software refers to a collection of code installed on a
hardware asset";
}
identity sw-cloud {
base asset-type;
Palmero, et al. Expires 29 April 2022 [Page 20]
Internet-Draft DMLMO October 2021
description
"Cloud-based software, that allows users access to software
application that run on a shared computing resources via
Internet";
}
identity phone {
base asset-type;
description
"Mobile telephone or a handheld two-way communication device
over a cellular network.";
}
identity other {
base asset-type;
description
"Different or additional type not specified as part of another
defined asset-type.";
}
identity asset-subtype {
description
"subtype of the asset: router, switch, wireless,
controller, ...";
}
identity router {
base asset-subtype;
description
"Network connecting device. It operates at layer-3 of the OSI
model.";
}
identity switch {
base asset-subtype;
description
"Network connecting device. It operates at layer-2(Data Link
Layer) of the OSI model.";
}
identity wireless {
base asset-subtype;
description
"Network connecting device. It creates a wireless local area
network. It connects to a wired router, switch, or hub via an
Ethernet cable, and projects a Wi-Fi signal to a designated
area";
}
identity controller {
base asset-subtype;
description
"Centralized device in the network which is used in combination
with network connection devices, when there is a need to manage
them in large quantities.";
Palmero, et al. Expires 29 April 2022 [Page 21]
Internet-Draft DMLMO October 2021
}
identity board {
base asset-subtype;
description
"Electronic circuit board in an asset which interconnects
another hardware assets attached to it.";
}
identity p-supply {
base asset-subtype;
description
"Power supply, as it might have independent identity.";
}
identity transceiver {
base asset-subtype;
description
"Device that is both a transmitter and a receiver. Usually
it's in a single device.
This is commonly used as a modular network interface";
}
identity others {
base asset-subtype;
description
"Different or additional type not specified as part of another
defined asset-subtype.";
}
identity version {
description
"Base identity for all version types";
}
identity version-sw {
base version;
description
"Version release of the operating system that runs on the
asset";
}
identity platform-dependency-os {
description
"Operating system that creates an environment for the asset
to get deployed. Enum of options covering OS platform
dependency.";
}
identity linux {
base platform-dependency-os;
description
"UNIX like operating system";
}
identity windows {
base platform-dependency-os;
Palmero, et al. Expires 29 April 2022 [Page 22]
Internet-Draft DMLMO October 2021
description
"Windows operating system";
}
identity macOS {
base platform-dependency-os;
description
"Mac operating system develop by Apple, Inc.";
}
identity darwin {
base platform-dependency-os;
description
"Open-source Unix-like operating system first released by Apple
Inc.";
}
identity ubuntu {
base platform-dependency-os;
description
"Linux distribution, used in desktop distribution";
}
identity red-hat {
base platform-dependency-os;
description
"Red Hat Enterprise Linux, released in multiple server and
desktop versions";
}
// NEED to extend and include iOS, Android, etc.;
identity role {
description
"What the role of a given device/component is in the network.
This attribute normally will be configured on the specific
component during setup. This attribute normally will be
configured on the specific component during setup";
}
identity border-router {
base role;
description
"Router that provides connectivity between interior and
exterior network routers or to the cloud";
}
identity access {
base role;
description
"Router that provides access to a larger communication network
of some sort.";
}
identity control-plane {
base role;
Palmero, et al. Expires 29 April 2022 [Page 23]
Internet-Draft DMLMO October 2021
description
"Network component that controls how data packets are
forwarded";
}
identity edge {
base role;
description
"Router that provides an entry point into enterprise or service
provider core networks";
}
identity core {
base role;
description
"Component part of the high-speed backbone of the network. It
provides fast and efficient data transport";
}
identity datacenter {
base role;
description
"Component placed in the data center, mantaining and housing
back-end IT system and data stores";
}
identity branch {
base role;
description
"Router in a remote branch of an enterprise's network";
}
identity deployment-mode {
description
"This attribute will denote the configured deployment mode
for the asset and features, if applicable; e.g.,
High Availability(HA) or Faiover cluster, virtual appliance,
etc.";
}
identity primary {
base deployment-mode;
description
"Asset or featurs that support critical applications to
minimize system downtime, to achieve high availabiilty or
failover";
}
identity secondary {
base deployment-mode;
description
"Redundant asset or feature, that is triggered when the
primary encounters performance issues, to achieve high
availability or failover";
Palmero, et al. Expires 29 April 2022 [Page 24]
Internet-Draft DMLMO October 2021
}
identity cloud {
base deployment-mode;
description
"Especially it refers to remote, distributed and shared asset
resources (i.e. data storage, computing power, etc.), which
are hooked together and meant to operate as a single
ecosystem.";
}
identity virtual-appliance {
base deployment-mode;
description
"pre-configured virtual machine image, ready to run on a
hypervisor";
}
identity container {
base deployment-mode;
description
"Standard unit of software that packages up code and all its
dependencies so the application runs quickly and reliably from
one computing environment to another";
}
identity counter-type {
description
"Specify the different type of counters, i.e accumulated-count,
average-count, last-count, high-water mark count, low-water
mark count" ;
}
identity accumulated {
base counter-type;
description
"monotonically increasing counters. They're useful for
aggregating metric information such as the number of hits
on a web page, how many users log into a portal, etc.";
}
identity average {
base counter-type;
description
"typical value in a set of metrics, in particular the mean,
which is calculated by dividing the sum of the values in the
set by their number.";
}
identity last {
base counter-type;
description
"Last value measured and collected for specific metric.";
}
Palmero, et al. Expires 29 April 2022 [Page 25]
Internet-Draft DMLMO October 2021
identity high-water-mark {
base counter-type;
description
"Highest level of value in a set of metrics.";
}
identity low-water-mark {
base counter-type;
description
"Lowest level of value in a set of metrics.";
}
identity feature-scope {
description
"Optional tag that could apply to any usage feature, so that
if there are multiple dimensions of reporting that need to
be accommodated (i.e., report feature usage by 'site')";
}
identity site {
base feature-scope;
description
"Single location, part of the network";
}
identity network {
base feature-scope;
description
"scope limited to the networking assets";
}
typedef feature-usage-type {
type enumeration {
enum none {
description
"No Usage";
}
enum low {
description
"Usage meeting the Low Threshold";
}
enum medium {
description
"Usage meeting the Medium Threshold";
}
enum high {
description
"Usage meeting the High Threshold";
}
// NEED to elaborate more on this list, based on use case
// validation
}
description
Palmero, et al. Expires 29 April 2022 [Page 26]
Internet-Draft DMLMO October 2021
"feature usage % 0-25-50-75-100";
}
}
<CODE ENDS>
6.2.2. Aggregated Asset Inventory
<CODE BEGINS> file "ietf-lmo-assets-inventory@2021-10-25.yang"
module ietf-lmo-assets-inventory {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmo-assets-inventory";
prefix lmo-asset;
import ietf-yang-types {
prefix yang;
}
import ietf-lmo-common {
prefix lmocom;
}
import ietf-geo-location {
prefix geo ;
revision-date 2019-02-17 ;
}
import ietf-inet-types {
prefix inet;
}
organization
"IETF OPSA (Operations and Management Area) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/opsawg/>
WG List: <mailto:opsawg@ietf.org>
Editor: Marisol Palmero
<mailto:mpalmero@cisco.com>
Editor: Josh Suhr
<mailto:josuhr@cisco.com>
Editor: Sudhendu Kumar
<mailto:skumar23@ncsu.edu>";
description
"This YANG module includes the concept asset aggregation
and platform dependency of an asset.
Copyright (c) 2021 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Palmero, et al. Expires 29 April 2022 [Page 27]
Internet-Draft DMLMO October 2021
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
revision 2021-10-25 {
description
"Initial revision for Aggregated Assets Inventory as part of
the LMO YANG Model";
reference
"RFC XXXX: LMO YANG Model";
}
container capture-info {
config false;
description
"Capture information for this data";
leaf collected-on {
type yang:date-and-time;
description
"Time at which this data was collected";
}
leaf collected-from {
type string;
description
"Identifier for original source of this data";
}
}
container assets {
config false;
description
"Assets container includes attributes that add the aggregated
view";
list asset {
key "id";
description
"Asset ID";
leaf id {
type lmocom:asset-id;
description
"Unique identifier for the hardware or software instance.
It could be same as the Serial Number.";
}
leaf vendor {
type lmocom:vendor-id;
description
"Vendor or Manufacturer name or identifier; e.g. Cisco";
}
Palmero, et al. Expires 29 April 2022 [Page 28]
Internet-Draft DMLMO October 2021
leaf pid {
type string;
description
"Part or Product Identifier";
}
leaf serial-number {
type string;
description
"Serial number";
}
leaf vid {
type string;
description
"Hardware Version ID";
}
leaf mac-address {
type yang:mac-address;
description
"The mac-address type represents an IEEE 802 MAC address.
The canonical representation uses lowercase characters.";
}
leaf-list ip-address {
type inet:ip-address;
description
"IP address, representing the management IP of the asset.
It can refer to ipv4 and/or ipv6 address.";
}
leaf entity-name {
type string;
description
"Hardware type, e.g., chassis, slot, or power-supply";
}
leaf product-description {
type string;
description
"Standard description of the assset; e.g., '1-port Gigabit
Ethernet'";
}
leaf udi {
type string;
description
"Identify uniquely an asset = vendor-id + pid + id";
}
leaf transparency-info {
type inet:uri;
description
"Link to software bill of material and security advisory
information, see draft-ietf-opsawg-sbom-access";
Palmero, et al. Expires 29 April 2022 [Page 29]
Internet-Draft DMLMO October 2021
}
leaf type {
type identityref {
base lmocom:asset-type;
}
description
"Asset type; e.g. hardware, software, sw-cloud, ...
It can be extended";
}
leaf subtype {
type identityref {
base lmocom:asset-subtype;
}
description
"Subtype of hardware or software; e.g. router, switch,
wireless, controller, ...";
}
leaf role {
type identityref {
base lmocom:role;
}
description
"What the role of a given device/component is in the
network. This attribute normally will be configured on the
specific component during setup";
}
leaf aggregation {
type boolean;
must "../number-of-instances = 1 or . = 'true'";
default false;
description
"Asset aggregation; e.g., false (default) or true";
}
leaf number-of-instances {
type uint32;
description
"Number of instances or endpoints covered by the aggregated
asset. If different from 1, it should enforce that
aggregation attribute is set to true";
}
leaf platform-dependency-os {
type identityref {
base lmocom:platform-dependency-os;
}
description
"Operating system for the asset to be deployed.";
}
container install-location {
Palmero, et al. Expires 29 April 2022 [Page 30]
Internet-Draft DMLMO October 2021
uses geo:geo-location;
description
"Physical installed location of the product. Location is
provided based on what customer/user configures";
}
leaf deployment-mode {
type identityref {
base lmocom:deployment-mode;
}
description
"Deployment mode for the asset, if applicable; e.g.,
HA cluster, virtual appliance, etc.";
}
leaf activation-date {
type yang:date-and-time;
description
"Date of asset activation or initial contact";
}
leaf software-version {
type string;
description
"Software version running on the hardware device or
software component";
}
container hotfixes {
config false;
description "list of hotfixes";
list hostfix {
description
"List of hotfixes that have been installed";
leaf version {
type identityref {
base lmocom:version;
}
description
"It includes the first hotfix installed";
}
leaf order {
type uint8;
description
"It refers to the order of how the hotfixes have been
installed, range 0..100";
}
}
}
leaf software-type {
type string;
description
Palmero, et al. Expires 29 April 2022 [Page 31]
Internet-Draft DMLMO October 2021
"Software type or Operating System";
}
leaf sign-of-life-timestamp {
type yang:date-and-time;
description
"Date of last contact";
}
leaf tags {
type string;
description
"Comma-separated descriptive tags for this asset";
}
}
}
container subassets {
config false;
description
"Subassets container, includes assets under parent assets";
list subasset {
key "id";
description
"Subasset ID";
leaf id {
type leafref {
path "/assets/asset/id";
}
description
"Reference to Asset-ID";
}
}
}
}
<CODE ENDS>
6.2.3. Licenses
<CODE BEGINS> file "ietf-lmo-licenses@2021-10-25.yang"
module ietf-lmo-licenses {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmo-licenses";
prefix lmolicense;
import ietf-yang-types {
prefix yang;
}
import ietf-lmo-common {
prefix lmocom;
}
import ietf-lmo-assets-inventory {
Palmero, et al. Expires 29 April 2022 [Page 32]
Internet-Draft DMLMO October 2021
prefix lmoasset;
}
import ietf-lmo-usage {
prefix lmousage;
}
organization
"IETF OPSA (Operations and Management Area) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/opsawg/>
WG List: <mailto:opsawg@ietf.org>
Editor: Marisol Palmero
<mailto:mpalmero@cisco.com>
Editor: Josh Suhr
<mailto:josuhr@cisco.com>
Editor: Sudhendu Kumar
<mailto:skumar23@ncsu.edu>";
description
"This YANG module includes the licenses attributes of a
product.
Copyright (c) 2021 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
revision 2021-10-25 {
description
"Initial revision for Licenses Module as part of the LMO YANG
Model";
reference
"RFC XXXX: LMO YANG Model";
}
container capture-info {
config false;
description
"Capture information for this data";
leaf collected-on {
type yang:date-and-time;
description
Palmero, et al. Expires 29 April 2022 [Page 33]
Internet-Draft DMLMO October 2021
"Time at which this data was collected";
}
leaf collected-from {
type string;
description
"Identifier for original source of this data";
}
}
// Can we capture licensing ties to API access where we may be
// licensed on events queries per second, minute, hour, etc.
// This is a popular model in the cloud space for example the Google
// MAPs API??
container licenses {
config false;
description
"Licenses";
list license {
key "id";
description
"License ID";
leaf id {
type lmocom:license-id-t;
description
"Universal identifier for a license or bundle of licenses";
}
leaf virtual-account {
type string;
description
"Virtual Accounts help to organize assets in a way that is
logical for the business. The most common use of a Virtual
Account is to provide access and allocate specific
licenses to different departments or geographies while
maintaining an overall view of the organizational usage";
}
leaf model {
type lmocom:license-model-t;
mandatory true;
description
"License Model or Type";
}
leaf buying-program {
type identityref {
base lmocom:license-buying-program-t;
}
description
"License buying program, if applicable";
Palmero, et al. Expires 29 April 2022 [Page 34]
Internet-Draft DMLMO October 2021
}
leaf offer-type {
type identityref {
base lmocom:offer-type-t;
}
description
"License offer type, if applicable";
}
leaf external-store {
type boolean;
default false;
description
"Licensing goes through an external store";
}
leaf pid {
type string;
mandatory true;
description
"License Product Identifier";
}
leaf purchase-order-id {
type lmocom:purchase-order-t;
description
"License Order Number";
}
leaf account-id {
type string;
description
"Account identifier entitled to the license. Account-id
could e.g., be composed by account or customer name +
organization identifier";
}
leaf organization-id {
type string;
description
"Organization Domain Name";
}
leaf asset {
type leafref {
path "/lmoasset:assets/lmoasset:asset/lmoasset:id";
}
description
"Asset to which this license is attached";
}
leaf feature {
type leafref {
path "/lmousage:features/lmousage:feature/lmousage:id";
Palmero, et al. Expires 29 April 2022 [Page 35]
Internet-Draft DMLMO October 2021
}
description
"feature to which this license is attached";
}
leaf state {
type lmocom:license-state-t;
description
"License state; e.g., active, inactive, or unknown";
}
container renewal-profile {
description
"Profile of license renewal status and information";
leaf purchase-date {
type yang:date-and-time;
description
"Purchase Date";
}
leaf claim-date {
type yang:date-and-time;
description
"Claim Date - if different from Purchase Date";
}
leaf activation-date {
type yang:date-and-time;
description
"Activation Date";
}
leaf expiration-date {
type yang:date-and-time;
description
"Expiration Date";
}
}
container sublicenses {
description
"Sublicenses";
list sublicense {
key "id";
description
"Sublicenses";
leaf id {
type leafref {
path "/licenses/license/id";
}
description
"Universal license identifier";
}
}
Palmero, et al. Expires 29 April 2022 [Page 36]
Internet-Draft DMLMO October 2021
}
}
}
}
<CODE ENDS>
6.2.4. Usage
<CODE BEGINS> file "ietf-lmo-usage@2021-10-25.yang"
module ietf-lmo-usage {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmo-usage";
prefix lmousage;
import ietf-yang-types {
prefix yang;
}
import ietf-lmo-assets-inventory {
prefix lmoasset;
}
import ietf-lmo-common {
prefix lmocom;
}
organization
"IETF OPSA (Operations and Management Area) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/opsawg/>
WG List: <mailto:opsawg@ietf.org>
Editor: Marisol Palmero
<mailto:mpalmero@cisco.com>
Editor: Josh Suhr
<mailto:josuhr@cisco.com>
Editor: Sudhendu Kumar
<mailto:skumar23@ncsu.edu>";
description
"This YANG module includes the different attributes that define
description, usage and resource consumption for specific
features or capabilities of assets.
Copyright (c) 2021 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
Palmero, et al. Expires 29 April 2022 [Page 37]
Internet-Draft DMLMO October 2021
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
revision 2021-10-25 {
description
"Initial revision for Product Usage Module as part of the
LMO YANG Model";
reference
"RFC XXXX: LMO YANG Model";
}
container features {
config false;
description
"Features";
list feature {
key "id";
description
"Feature List";
leaf id {
type string;
description
"Identifies feature uniquely across all products of a
particular vendor: vendor-id/asset-id/id";
}
leaf name {
type string;
description
"Friendly name of the feature";
}
leaf summary {
type string;
description
"Brief description of the feature";
}
leaf category {
type string;
description
"Feature category or tag list (as applicable to the
product)";
}
leaf entitlement {
type string;
description
"Minimum entitlement level, subscription, or license level
required for the feature";
}
leaf first-available-version {
type string;
Palmero, et al. Expires 29 April 2022 [Page 38]
Internet-Draft DMLMO October 2021
description
"The first version in which this feature was enabled";
}
container backported-versions {
config false;
description
"software patch or update is taken from a recent software
version and applied to an older version of the same
software";
list backported-version {
config false;
description
"Backport releases to older release";
leaf version {
type identityref {
base lmocom:version;
}
description
"version of the backport release";
}
}
}
leaf scope {
type identityref {
base lmocom:feature-scope;
}
description
"Optional tag that could apply to any of the usage
features, so that if there are multiple dimensions of
reporting that need to be accommodated (i.e., report
feature usage by 'site')";
}
list config-options {
key "id";
description
"Feature configuration profile - optional, for features
that require configuration beyond enable/disable";
leaf id {
type string;
description
"Identify feature configuration option uniquely across
all products";
}
leaf name {
type string;
description
"Friendly name of the feature option";
}
Palmero, et al. Expires 29 April 2022 [Page 39]
Internet-Draft DMLMO October 2021
leaf summary {
type string;
description
"Brief description of the feature option";
}
list characteristic {
key "id";
description
"Characteristics of feature configuration options,
i.e. value=enabled/disabled";
leaf id {
type string;
description
"Identifier for feature option configuration
characteristic";
}
leaf name {
type string;
description
"Friendly name for feature option configuration
characteristic";
}
leaf value {
type string;
description
"Configuration characteristic value; describes how
this feature option characteristic is configured";
}
}
}
leaf asset {
type leafref {
path "/lmoasset:assets/lmoasset:asset/lmoasset:id";
}
description
"Asset to which this feature is attached";
}
container subfeatures {
description
"Sub-features to the top-level feature";
list subfeature {
key "id";
description
"Subfeature ID";
leaf id {
type leafref {
path "/features/feature/id";
}
Palmero, et al. Expires 29 April 2022 [Page 40]
Internet-Draft DMLMO October 2021
description
"Reference to Feature ID";
}
}
}
}
}
container usages {
config false;
description
"feature usage characteristic";
list usage {
key "id";
description
"Feature usage profile";
leaf id {
type string;
description
"Identify feature usage characteristic uniquely across
all products";
}
leaf feature {
type leafref {
path "/features/feature/id";
}
description
"usage link to a feature";
}
container capture-info {
config false;
description
"Capture information for this data";
leaf collected-on {
type yang:date-and-time;
description
"Time at which this data was collected";
}
leaf collected-from {
type string;
description
"Identifier for original source of this data";
}
}
leaf name {
type string;
description
"Name of feature usage characteristic";
}
Palmero, et al. Expires 29 April 2022 [Page 41]
Internet-Draft DMLMO October 2021
leaf summary {
type string;
description
"Brief description of feature usage characteristic";
}
leaf uri {
type string;
description
"Target URI of feature characteristic, if applicable - e.g.,
for clickstream or API";
}
leaf deployment-mode {
type identityref {
base lmocom:deployment-mode;
}
description
"Deployment mode for the feature. When applicable, feature
might be independent of the deployment mode in the asset;
e.g., cloud, HA cluster, virtual appliance, etc.";
}
leaf scope {
type identityref {
base lmocom:feature-scope;
}
description
"Optional tag that could apply to any of the usage
features, so that if there are multiple dimensions of
reporting that need to be accommodated, (i.e., report
feature usage by 'site')";
}
leaf activation-status {
type string;
description
"Feature activation status for this instance of the
product (on/off; active/inactive; enabled/disabled)";
}
leaf instances {
type uint32;
description
"Number of instances or end-points using this feature";
}
leaf count-type {
type identityref {
base lmocom:counter-type;
}
description
"Specify the counter type i.e accumulated-count,
Palmero, et al. Expires 29 April 2022 [Page 42]
Internet-Draft DMLMO October 2021
average-count, last-count, high-water mark count
(+time stamp), low-water mark count (+time stamp)";
}
leaf timestamp {
type yang:date-and-time;
description
"Some counters will benefit from timestamp based on the
time when the counter has been collected";
}
leaf count {
type uint32;
units "times";
description
"Count of times the feature has been used";
}
list frequency {
key "name";
description
"Frequency with which the feature is used";
leaf name {
type string {
length "1..64";
}
description
"reference in case that feature is for different
purpose of usage";
}
leaf type-freq {
type string;
description
"Frequency type, i.e daily, weekly, monthly";
}
leaf value {
type yang:counter64;
description
"Value collected for the usage";
}
}
list resource-consumption {
key "id";
description
"Resource consumption profile";
leaf id {
type string;
description
"Identify resource for consumption measurement";
}
leaf name {
Palmero, et al. Expires 29 April 2022 [Page 43]
Internet-Draft DMLMO October 2021
type string;
description
"Friendly name of the resource";
}
leaf summary {
type string;
description
"Brief description of the resource";
}
list characteristic {
key "id";
description
"Characteristic of resource consumption";
leaf id {
type string;
description
"Identifier for resource consumption characteristic";
}
leaf name {
type string;
description
"Friendly name for resource consumption
characteristic";
}
leaf unit {
type string;
description
"unit of measurement for the characteristic";
}
// NEED to define identity type for unit: min, hour, sec,
// days, ...
leaf value {
type yang:counter64;
description
"Resource consumption characteristic measurement";
}
leaf value-max {
type yang:counter64;
description
"Maximum resource consumption characteristic value";
}
}
}
}
}
Palmero, et al. Expires 29 April 2022 [Page 44]
Internet-Draft DMLMO October 2021
}
<CODE ENDS>
6.2.5. Incident Management
<CODE BEGINS> file "ietf-lmo-incident-management@2021-10-25.yang"
module ietf-lmo-incident-management {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-lmo-incident-management";
prefix lmoscm;
import ietf-yang-types {
prefix yang;
}
import ietf-lmo-assets-inventory {
prefix lmoasset;
}
import ietf-lmo-usage {
prefix lmousage;
}
organization
"IETF OPSA (Operations and Management Area) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/opsawg/>
WG List: <mailto:opsawg@ietf.org>
Editor: Marisol Palmero
<mailto:mpalmero@cisco.com>
Editor: Josh Suhr
<mailto:josuhr@cisco.com>
Editor: Sudhendu Kumar
<mailto:skumar23@ncsu.edu>";
description
"This YANG module includes the incident management attributes
to handle incidents.
Copyright (c) 2021 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
Palmero, et al. Expires 29 April 2022 [Page 45]
Internet-Draft DMLMO October 2021
for full legal notices.";
revision 2021-10-25 {
description
"Initial revision for Incident Management as part of
the LMO YANG Model";
reference
"RFC XXXX: LMO YANG Model";
}
container tracking-number {
config false;
description
"Incident Tracking Incident Management Case Number";
list tracking-number {
key "id";
description
"Incident Tracking Incident Management Case Number List,
internal to Developer, ie. INCxxxxx";
leaf id {
type string;
description
"Technical Support Center Case Number id";
}
leaf title {
type string;
description
"headline Incident Case";
}
leaf summary {
type string;
description
"Problem description summary";
}
leaf severity {
type string;
description
"severity, in some cases also defined as priority";
// NEED to define different levels of severity, from
// severity 1 to 6, i.e. Sev1: network down, Sev6: enhacement
}
leaf status {
type string;
description
"case status, i.e. Customer-Pending, Customer
Engineer-Pending, Developer-Pending, Closed, Open, etc.";
// NEED to define different status
}
leaf created {
Palmero, et al. Expires 29 April 2022 [Page 46]
Internet-Draft DMLMO October 2021
type yang:date-and-time;
description
"created date-and-time";
}
leaf last_updated {
type yang:date-and-time;
description
"last updated date-and-time";
}
leaf capability {
type string;
description
"i.e. to reveal associated RMA items";
}
leaf technology{
type string;
description
"Technology related";
}
leaf subtechnology{
type string;
description
"Subtechnology related";
}
leaf problem-type{
type string;
description
"Problem type definition, i.e. network, faulty hardware,
performance, security, etc. ";
}
leaf resolution{
type string;
description
"code (closed cases only)";
}
leaf owner{
type string;
description
"Customer in charge of the case";
// NEED to add contact information: email and phone number
}
leaf support-engineer{
type string;
description
"Customer Support Engineer in charge of the case";
// NEED to add contact information: email and phone number
}
leaf asset {
Palmero, et al. Expires 29 April 2022 [Page 47]
Internet-Draft DMLMO October 2021
type leafref {
path "/lmoasset:assets/lmoasset:asset/lmoasset:id";
}
description
"Asset to which this incident is attached";
}
leaf serial-number {
type leafref {
path "/lmoasset:assets/lmoasset:asset/lmoasset:serial-number";
}
description
"Serial-number to which this incident is attached";
}
leaf software-version {
type leafref {
path "/lmoasset:assets/lmoasset:asset/lmoasset:software-version";
}
description
"Software version running in the asset to which this incident
case is attached";
}
leaf feature {
type leafref {
path "/lmousage:features/lmousage:feature/lmousage:id";
}
description
"Asset to which this incident is attached";
}
leaf contract-number {
type string;
description
"Support contract number";
// NEED to evaluate if it should be independent container. It
// should be associated to asset and license
}
}
}
}
<CODE ENDS>
7. Deployment Considerations
LMO Data Models defines the data schemas for LMO data. LMO Data
Models are based on YANG. YANG data models can be used independent
of the transport and can be converted into any encoding format
supported by the network configuration protocol. YANG is a protocol
independent.
Palmero, et al. Expires 29 April 2022 [Page 48]
Internet-Draft DMLMO October 2021
To enable the exchange of LMO data among all interested parties,
deployment considerations that are out of the scope of this document,
will need to include:
* The data structure to describe all metrics and quantify relevant
data consistently, i.e. specific formats like XML or JSON encoded
message would be deemed valid or invalid based on LMO models.
* The process to share and collect LMO data across the consumers
consistently, including the transport mechanism. The LMO YANG
models can be used with network management protocols such as
NETCONF [RFC6241], RESTCONF [RFC8040], streaming telemetry, etc.
OpenAPI specification might also help to consume LMO metrics.
* How the configuration of assets should be done.
8. Security Considerations
The security considerations mentioned in section 17 of [RFC7950]
apply.
LMO brings several security and privacy implications because of the
various components and attributes of the information model. For
example, each functional component can be tampered with to give
manipulated data. LMO when used alone or with other relevant data,
can identify an individual, revealing Personal Identifiable
Information (PII). Misconfigurations can lead to data being accessed
by unauthorized entities.
Methods exist to secure the communication of management information.
The transport entity of the functional model MUST implement methods
for secure transport. This document also contains an Information
model and Data-Model in which none of the objects defined are
writable. If the objects are deemed sensitive in a particular
environment, access to them MUST be restricted using appropriately
configured security and access control rights. The information model
contains several optional elements which can be enabled or disabled
for the sake of privacy and security. Proper authentication and
audit trail MUST be included for all the users/processes that access
the LMO.
9. IANA Considerations
9.1. The IETF XML Registry
This document registers URIs in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the registrations defined below
are requested:
Palmero, et al. Expires 29 April 2022 [Page 49]
Internet-Draft DMLMO October 2021
URI: urn:ietf:params:xml:ns:yang:ietf-lmo-common
Registrant Contact: The OPSA WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmo-assets-inventory
Registrant Contact: The OPSA WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmo-licenses
Registrant Contact: The OPSA WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmo-product-usage
Registrant Contact: The OPSA WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-lmo-incident-management
Registrant Contact: The OPSA WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
9.2. The YANG Module Names Registry
This document registers YANG modules in the YANG Module Names
registry [RFC7950]. Following the format in [RFC7950], the
registrations defined below are requested:
name: ietf-lmo-common
namespace: urn:ietf:params:xml:ns:yang:ietf-lmo-common
maintained by IANA: N
prefix: lmocom
reference: RFC XXXX
name: ietf-lmo-asset-inventory
namespace: urn:ietf:params:xml:ns:yang:ietf-lmo-assets-inventory
maintained by IANA: N
prefix: lmoasset
reference: RFC XXXX
name: ietf-lmo-licenses
namespace: urn:ietf:params:xml:ns:yang:ietf-lmo-licenses
maintained by IANA: N
prefix: lmolicense
reference: RFC XXXX
Palmero, et al. Expires 29 April 2022 [Page 50]
Internet-Draft DMLMO October 2021
name: ietf-lmo-product-usage
namespace: urn:ietf:params:xml:ns:yang:ietf-lmo-usage
maintained by IANA: N
prefix: lmousage
reference: RFC XXXX
name: ietf-lmo-incident-management
namespace: urn:ietf:params:xml:ns:yang:ietf-lmo-incident-management
maintained by IANA: N
prefix: lmoscm
reference: RFC XXXX
10. References
10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
10.2. Informative References
[I-D.draft-ietf-netmod-geo-location-11]
Hopps, C., "A YANG Grouping for Geographic Locations",
Work in Progress, Internet-Draft, draft-ietf-netmod-geo-
location-11, 24 October 2021,
<https://www.ietf.org/archive/id/draft-ietf-netmod-geo-
location-11.txt>.
[I-D.draft-ietf-opsawg-sbom-access-03]
Lear, E. and S. Rose, "Discovering and Retrieving Software
Transparency and Vulnerability Information", Work in
Progress, Internet-Draft, draft-ietf-opsawg-sbom-access-
03, 24 October 2021, <https://www.ietf.org/archive/id/
draft-ietf-opsawg-sbom-access-03.txt>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
Palmero, et al. Expires 29 April 2022 [Page 51]
Internet-Draft DMLMO October 2021
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
Acknowledgments
The ideas in this document originate from early work by Tony Colon,
Carlos Pignataro, and Yenu Gobena originally referred to as
Experience Telemetry.
This document was created by meaningful contributions from Josh Suhr,
Eric Vyncke, Yannis Viniotis, Nagendra Kumar Nainar, Yenu Gobena, and
Dhiren Tailor.
The authors wish to thank Gonzalo Salgueiro, Martin Beverley, Jan
Lindblad and many others for their helpful comments and suggestions.
Change log
RFC Editor Note: This section is to be removed during the final
publication of the document.
version 02
* "Support case" renamed to "incident".
* Add MAC address and IP address attributes under asset-inventory
YANG module.
* Link among objects & YANG modules (notably with feature).
* New text about asset usage.
version 01
* Fixes for YANG validator and idnits warnings.
version 00
Palmero, et al. Expires 29 April 2022 [Page 52]
Internet-Draft DMLMO October 2021
* Initial version.
Authors' Addresses
Marisol Palmero
Cisco Systems
Email: mpalmero@cisco.com
Frank Brockners
Cisco Systems
Email: fbrockne@cisco.com
Sudhendu Kumar
NC State University
Email: skumar23@ncsu.edu
Shwetha Bhandari
Thoughtspot
Email: shwetha.bhandari@thoughtspot.com
Camilo Cardona
NTT
Email: camilo@ntt.net
Palmero, et al. Expires 29 April 2022 [Page 53]