From 432b8193084f06f381afad5bf2dac269de747d84 Mon Sep 17 00:00:00 2001
From: carcel <jose.carcel@atos.net>
Date: Tue, 3 Oct 2023 17:26:37 +0200
Subject: [PATCH] Update SmartNIC, NOS and NS Data Models
---
proto/any.proto | 162 +++++
proto/context.proto | 3 +-
...nics.proto => context_ext_smartnics.proto} | 37 +-
proto/nfv_client.proto | 11 +-
proto/nos_client.proto | 33 +
.../automation/src/ztp-agent/ztp_device.yang | 3 +
.../smartnic_probes/ietf-yang-types.yang | 480 +++++++++++++++
.../openconfig-extensions.yang | 206 +++++++
.../openconfig-inet-types.yang | 478 +++++++++++++++
.../openconfig-probes-types.yang | 86 +++
.../smartnic_probes/openconfig-probes.yang | 575 ++++++++++++++++++
.../smartnic_probes/openconfig-types.yang | 471 ++++++++++++++
.../drivers/smartnic_probes/probes-agent.yang | 150 +++--
.../references_probes_libraries.txt | 6 +
14 files changed, 2611 insertions(+), 90 deletions(-)
create mode 100644 proto/any.proto
rename proto/{context-ext-smartnics.proto => context_ext_smartnics.proto} (79%)
create mode 100644 proto/nos_client.proto
rename ztp_device.yang => src/automation/src/ztp-agent/ztp_device.yang (91%)
create mode 100644 src/device/service/drivers/smartnic_probes/ietf-yang-types.yang
create mode 100644 src/device/service/drivers/smartnic_probes/openconfig-extensions.yang
create mode 100644 src/device/service/drivers/smartnic_probes/openconfig-inet-types.yang
create mode 100644 src/device/service/drivers/smartnic_probes/openconfig-probes-types.yang
create mode 100644 src/device/service/drivers/smartnic_probes/openconfig-probes.yang
create mode 100644 src/device/service/drivers/smartnic_probes/openconfig-types.yang
create mode 100644 src/device/service/drivers/smartnic_probes/references_probes_libraries.txt
diff --git a/proto/any.proto b/proto/any.proto
new file mode 100644
index 000000000..eff44e509
--- /dev/null
+++ b/proto/any.proto
@@ -0,0 +1,162 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc. All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto3";
+
+package google.protobuf;
+
+option go_package = "google.golang.org/protobuf/types/known/anypb";
+option java_package = "com.google.protobuf";
+option java_outer_classname = "AnyProto";
+option java_multiple_files = true;
+option objc_class_prefix = "GPB";
+option csharp_namespace = "Google.Protobuf.WellKnownTypes";
+
+// `Any` contains an arbitrary serialized protocol buffer message along with a
+// URL that describes the type of the serialized message.
+//
+// Protobuf library provides support to pack/unpack Any values in the form
+// of utility functions or additional generated methods of the Any type.
+//
+// Example 1: Pack and unpack a message in C++.
+//
+// Foo foo = ...;
+// Any any;
+// any.PackFrom(foo);
+// ...
+// if (any.UnpackTo(&foo)) {
+// ...
+// }
+//
+// Example 2: Pack and unpack a message in Java.
+//
+// Foo foo = ...;
+// Any any = Any.pack(foo);
+// ...
+// if (any.is(Foo.class)) {
+// foo = any.unpack(Foo.class);
+// }
+// // or ...
+// if (any.isSameTypeAs(Foo.getDefaultInstance())) {
+// foo = any.unpack(Foo.getDefaultInstance());
+// }
+//
+// Example 3: Pack and unpack a message in Python.
+//
+// foo = Foo(...)
+// any = Any()
+// any.Pack(foo)
+// ...
+// if any.Is(Foo.DESCRIPTOR):
+// any.Unpack(foo)
+// ...
+//
+// Example 4: Pack and unpack a message in Go
+//
+// foo := &pb.Foo{...}
+// any, err := anypb.New(foo)
+// if err != nil {
+// ...
+// }
+// ...
+// foo := &pb.Foo{}
+// if err := any.UnmarshalTo(foo); err != nil {
+// ...
+// }
+//
+// The pack methods provided by protobuf library will by default use
+// 'type.googleapis.com/full.type.name' as the type URL and the unpack
+// methods only use the fully qualified type name after the last '/'
+// in the type URL, for example "foo.bar.com/x/y.z" will yield type
+// name "y.z".
+//
+// JSON
+// ====
+// The JSON representation of an `Any` value uses the regular
+// representation of the deserialized, embedded message, with an
+// additional field `@type` which contains the type URL. Example:
+//
+// package google.profile;
+// message Person {
+// string first_name = 1;
+// string last_name = 2;
+// }
+//
+// {
+// "@type": "type.googleapis.com/google.profile.Person",
+// "firstName": <string>,
+// "lastName": <string>
+// }
+//
+// If the embedded message type is well-known and has a custom JSON
+// representation, that representation will be embedded adding a field
+// `value` which holds the custom JSON in addition to the `@type`
+// field. Example (for message [google.protobuf.Duration][]):
+//
+// {
+// "@type": "type.googleapis.com/google.protobuf.Duration",
+// "value": "1.212s"
+// }
+//
+message Any {
+ // A URL/resource name that uniquely identifies the type of the serialized
+ // protocol buffer message. This string must contain at least
+ // one "/" character. The last segment of the URL's path must represent
+ // the fully qualified name of the type (as in
+ // `path/google.protobuf.Duration`). The name should be in a canonical form
+ // (e.g., leading "." is not accepted).
+ //
+ // In practice, teams usually precompile into the binary all types that they
+ // expect it to use in the context of Any. However, for URLs which use the
+ // scheme `http`, `https`, or no scheme, one can optionally set up a type
+ // server that maps type URLs to message definitions as follows:
+ //
+ // * If no scheme is provided, `https` is assumed.
+ // * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+ // value in binary format, or produce an error.
+ // * Applications are allowed to cache lookup results based on the
+ // URL, or have them precompiled into a binary to avoid any
+ // lookup. Therefore, binary compatibility needs to be preserved
+ // on changes to types. (Use versioned type names to manage
+ // breaking changes.)
+ //
+ // Note: this functionality is not currently available in the official
+ // protobuf release, and it is not used for type URLs beginning with
+ // type.googleapis.com. As of May 2023, there are no widely used type server
+ // implementations and no plans to implement one.
+ //
+ // Schemes other than `http`, `https` (or the empty scheme) might be
+ // used with implementation specific semantics.
+ //
+ string type_url = 1;
+
+ // Must be a valid serialized protocol buffer of the above specified type.
+ bytes value = 2;
+}
diff --git a/proto/context.proto b/proto/context.proto
index 87680a5b9..856d6f71d 100644
--- a/proto/context.proto
+++ b/proto/context.proto
@@ -15,6 +15,7 @@
syntax = "proto3";
package context;
+import "any.proto";
import "acl.proto";
import "kpi_sample_types.proto";
@@ -451,7 +452,7 @@ message EndPoint {
string endpoint_type = 3; // == 'smartnics'
repeated kpi_sample_types.KpiSampleType kpi_sample_types = 4;
Location endpoint_location = 5;
- map<string, google.Any> capabilities = 6;
+ map<string, google.protobuf.Any> capabilities = 6;
}
message EndPointName {
diff --git a/proto/context-ext-smartnics.proto b/proto/context_ext_smartnics.proto
similarity index 79%
rename from proto/context-ext-smartnics.proto
rename to proto/context_ext_smartnics.proto
index 953b27e86..fe834b493 100644
--- a/proto/context-ext-smartnics.proto
+++ b/proto/context_ext_smartnics.proto
@@ -19,9 +19,8 @@
// conv_accel = bluefield-2 + GPU (A30)
syntax = "proto3";
-package context-ext-smartnics;
+package context_ext_smartnics;
-import "context";
import "kpi_sample_types.proto";
message SmartnicsCapabilities {
@@ -82,40 +81,14 @@ message DPU_Core {
message DPU_Memory {
string RamMemoryType = 1;
string eMMCMemoryType = 2;
- DpuRamMemorySizeGB RamMemorySizeGB = 3;
- DpueMMCMemorySizeGB eMMCMemorySizeGB = 4;
+ uint64 RamMemorySizeGB = 3;
+ uint64 eMMCMemorySizeGB = 4;
}
-enum DpuRamMemorySizeGB {
- DPU_MEMORY_DDR4_RAM_UNDEFINED = 0;
- DPU_MEMORY_DDR4_RAM_16GB = 1;
- DPU_MEMORY_DDR4_RAM_32GB = 2;
-}
-
-enum DpueMMCMemorySizeGB {
- DPU_MEMORY_eMMC_UNDEFINED = 0;
- DPU_MEMORY_eMMC_32GB = 1;
- DPU_MEMORY_eMMC_64GB = 2;
- DPU_MEMORY_eMMC_128GB = 3;
-}
-
-enum GPUArchitecture {
- ARCH_UNDEFINED = 0;
- ARCH_AMPERE = 1;
-}
-
-enum GPUComputeCapabilities {
- MIG_UNDEFINED = 0;
- MIG_4_AT_6GB = 1;
- MIG_2_AT_12GB = 2;
- MIG_1_AT_24GB = 3;
-}
-
-
message GPU {
string model = 1;
- GPUArchitecture architecture = 2;
- GPUComputeCapabilities compute_capabilities = 3;
+ string architecture = 2;
+ string compute_capabilities = 3;
uint64 memory_size_gb = 4;
uint32 num_CUDA_cores = 5;
uint32 num_Tensor_cores = 6;
diff --git a/proto/nfv_client.proto b/proto/nfv_client.proto
index d880a394c..d903e7907 100644
--- a/proto/nfv_client.proto
+++ b/proto/nfv_client.proto
@@ -19,6 +19,7 @@ import "context.proto";
message Nsd {
string nsd_name = 1;
+ string config_params=2;
}
message Ns {
@@ -26,6 +27,9 @@ message Ns {
string ns_name=2;
string nsd_name=3;
string vim_account=4;
+ string config_params=5;
+ string status = 6;
+ string status_message = 7;
}
message NsList {
@@ -37,8 +41,11 @@ message NsdList {
}
service nfv_client {
- rpc CreateNs (ns) returns (ns_id) {} // Stable not final
- rpc DeleteNs (ns) returns (context.Empty) {}
+ rpc GetNsList (context.Empty) returns (NsList) {}
+ rpc GetNsdList (context.Empty) returns (NsdList) {}
+ rpc CreateNs (Ns) returns (Ns) {}
+ rpc UpdateNs (Ns) returns (Ns) {}
+ rpc DeleteNs (Ns) returns (context.Empty) {}
}
diff --git a/proto/nos_client.proto b/proto/nos_client.proto
new file mode 100644
index 000000000..e0e35a648
--- /dev/null
+++ b/proto/nos_client.proto
@@ -0,0 +1,33 @@
+// Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (https://tfs.etsi.org/)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.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.
+
+syntax = "proto3";
+package nos_client;
+
+message NOS_SW {
+ string ztp_device_sw_url = 1;
+ bytes ztp_device_sw_file = 2;
+}
+
+message Config_Script {
+ string config_script_url = 1;
+ bytes config_script_file = 2;
+}
+
+service nos_client {
+ rpc GetNOSFile (NOS_SW) returns (NOS_SW) {}
+ rpc GetConfigScriptFile (Config_Script) returns (Config_Script) {}
+}
+
+
diff --git a/ztp_device.yang b/src/automation/src/ztp-agent/ztp_device.yang
similarity index 91%
rename from ztp_device.yang
rename to src/automation/src/ztp-agent/ztp_device.yang
index 748bc54c3..f506d6413 100644
--- a/ztp_device.yang
+++ b/src/automation/src/ztp-agent/ztp_device.yang
@@ -20,6 +20,9 @@ module ztp_device {
leaf config_script_url{
type string;
}
+ leaf ip_range {
+ type string; // check IP regular expression
+ }
}
typedef state {
diff --git a/src/device/service/drivers/smartnic_probes/ietf-yang-types.yang b/src/device/service/drivers/smartnic_probes/ietf-yang-types.yang
new file mode 100644
index 000000000..371a091d1
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/ietf-yang-types.yang
@@ -0,0 +1,480 @@
+module ietf-yang-types {
+
+ namespace "urn:ietf:params:xml:ns:yang:ietf-yang-types";
+ prefix "yang";
+
+ organization
+ "IETF NETMOD (NETCONF Data Modeling Language) Working Group";
+
+ contact
+ "WG Web: <http://tools.ietf.org/wg/netmod/>
+ WG List: <mailto:netmod@ietf.org>
+
+ WG Chair: David Kessens
+ <mailto:david.kessens@nsn.com>
+
+ WG Chair: Juergen Schoenwaelder
+ <mailto:j.schoenwaelder@jacobs-university.de>
+
+ Editor: Juergen Schoenwaelder
+ <mailto:j.schoenwaelder@jacobs-university.de>";
+
+ description
+ "This module contains a collection of generally useful derived
+ YANG data types.
+
+ Copyright (c) 2013 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
+ (http://trustee.ietf.org/license-info).
+
+ This version of this YANG module is part of RFC 6991; see
+ the RFC itself for full legal notices.";
+
+ revision 2013-07-15 {
+ description
+ "This revision adds the following new data types:
+ - yang-identifier
+ - hex-string
+ - uuid
+ - dotted-quad";
+ reference
+ "RFC 6991: Common YANG Data Types";
+ }
+
+ revision 2010-09-24 {
+ description
+ "Initial revision.";
+ reference
+ "RFC 6021: Common YANG Data Types";
+ }
+
+ /*** collection of counter and gauge types ***/
+
+ typedef counter32 {
+ type uint32;
+ description
+ "The counter32 type represents a non-negative integer
+ that monotonically increases until it reaches a
+ maximum value of 2^32-1 (4294967295 decimal), when it
+ wraps around and starts increasing again from zero.
+
+ Counters have no defined 'initial' value, and thus, a
+ single value of a counter has (in general) no information
+ content. Discontinuities in the monotonically increasing
+ value normally occur at re-initialization of the
+ management system, and at other times as specified in the
+ description of a schema node using this type. If such
+ other times can occur, for example, the creation of
+ a schema node of type counter32 at times other than
+ re-initialization, then a corresponding schema node
+ should be defined, with an appropriate type, to indicate
+ the last discontinuity.
+
+ The counter32 type should not be used for configuration
+ schema nodes. A default statement SHOULD NOT be used in
+ combination with the type counter32.
+
+ In the value set and its semantics, this type is equivalent
+ to the Counter32 type of the SMIv2.";
+ reference
+ "RFC 2578: Structure of Management Information Version 2
+ (SMIv2)";
+ }
+
+ typedef zero-based-counter32 {
+ type yang:counter32;
+ default "0";
+ description
+ "The zero-based-counter32 type represents a counter32
+ that has the defined 'initial' value zero.
+
+ A schema node of this type will be set to zero (0) on creation
+ and will thereafter increase monotonically until it reaches
+ a maximum value of 2^32-1 (4294967295 decimal), when it
+ wraps around and starts increasing again from zero.
+
+ Provided that an application discovers a new schema node
+ of this type within the minimum time to wrap, it can use the
+ 'initial' value as a delta. It is important for a management
+ station to be aware of this minimum time and the actual time
+ between polls, and to discard data if the actual time is too
+ long or there is no defined minimum time.
+
+ In the value set and its semantics, this type is equivalent
+ to the ZeroBasedCounter32 textual convention of the SMIv2.";
+ reference
+ "RFC 4502: Remote Network Monitoring Management Information
+ Base Version 2";
+ }
+
+ typedef counter64 {
+ type uint64;
+ description
+ "The counter64 type represents a non-negative integer
+ that monotonically increases until it reaches a
+ maximum value of 2^64-1 (18446744073709551615 decimal),
+ when it wraps around and starts increasing again from zero.
+
+ Counters have no defined 'initial' value, and thus, a
+ single value of a counter has (in general) no information
+ content. Discontinuities in the monotonically increasing
+ value normally occur at re-initialization of the
+ management system, and at other times as specified in the
+ description of a schema node using this type. If such
+ other times can occur, for example, the creation of
+ a schema node of type counter64 at times other than
+ re-initialization, then a corresponding schema node
+ should be defined, with an appropriate type, to indicate
+ the last discontinuity.
+
+ The counter64 type should not be used for configuration
+ schema nodes. A default statement SHOULD NOT be used in
+ combination with the type counter64.
+
+ In the value set and its semantics, this type is equivalent
+ to the Counter64 type of the SMIv2.";
+ reference
+ "RFC 2578: Structure of Management Information Version 2
+ (SMIv2)";
+ }
+
+ typedef zero-based-counter64 {
+ type yang:counter64;
+ default "0";
+ description
+ "The zero-based-counter64 type represents a counter64 that
+ has the defined 'initial' value zero.
+
+
+
+
+ A schema node of this type will be set to zero (0) on creation
+ and will thereafter increase monotonically until it reaches
+ a maximum value of 2^64-1 (18446744073709551615 decimal),
+ when it wraps around and starts increasing again from zero.
+
+ Provided that an application discovers a new schema node
+ of this type within the minimum time to wrap, it can use the
+ 'initial' value as a delta. It is important for a management
+ station to be aware of this minimum time and the actual time
+ between polls, and to discard data if the actual time is too
+ long or there is no defined minimum time.
+
+ In the value set and its semantics, this type is equivalent
+ to the ZeroBasedCounter64 textual convention of the SMIv2.";
+ reference
+ "RFC 2856: Textual Conventions for Additional High Capacity
+ Data Types";
+ }
+
+ typedef gauge32 {
+ type uint32;
+ description
+ "The gauge32 type represents a non-negative integer, which
+ may increase or decrease, but shall never exceed a maximum
+ value, nor fall below a minimum value. The maximum value
+ cannot be greater than 2^32-1 (4294967295 decimal), and
+ the minimum value cannot be smaller than 0. The value of
+ a gauge32 has its maximum value whenever the information
+ being modeled is greater than or equal to its maximum
+ value, and has its minimum value whenever the information
+ being modeled is smaller than or equal to its minimum value.
+ If the information being modeled subsequently decreases
+ below (increases above) the maximum (minimum) value, the
+ gauge32 also decreases (increases).
+
+ In the value set and its semantics, this type is equivalent
+ to the Gauge32 type of the SMIv2.";
+ reference
+ "RFC 2578: Structure of Management Information Version 2
+ (SMIv2)";
+ }
+
+ typedef gauge64 {
+ type uint64;
+ description
+ "The gauge64 type represents a non-negative integer, which
+ may increase or decrease, but shall never exceed a maximum
+ value, nor fall below a minimum value. The maximum value
+ cannot be greater than 2^64-1 (18446744073709551615), and
+ the minimum value cannot be smaller than 0. The value of
+ a gauge64 has its maximum value whenever the information
+ being modeled is greater than or equal to its maximum
+ value, and has its minimum value whenever the information
+ being modeled is smaller than or equal to its minimum value.
+ If the information being modeled subsequently decreases
+ below (increases above) the maximum (minimum) value, the
+ gauge64 also decreases (increases).
+
+ In the value set and its semantics, this type is equivalent
+ to the CounterBasedGauge64 SMIv2 textual convention defined
+ in RFC 2856";
+ reference
+ "RFC 2856: Textual Conventions for Additional High Capacity
+ Data Types";
+ }
+
+ /*** collection of identifier-related types ***/
+
+ typedef object-identifier {
+ type string {
+ pattern '(([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))'
+ + '(\.(0|([1-9]\d*)))*';
+ }
+ description
+ "The object-identifier type represents administratively
+ assigned names in a registration-hierarchical-name tree.
+
+ Values of this type are denoted as a sequence of numerical
+ non-negative sub-identifier values. Each sub-identifier
+ value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers
+ are separated by single dots and without any intermediate
+ whitespace.
+
+ The ASN.1 standard restricts the value space of the first
+ sub-identifier to 0, 1, or 2. Furthermore, the value space
+ of the second sub-identifier is restricted to the range
+ 0 to 39 if the first sub-identifier is 0 or 1. Finally,
+ the ASN.1 standard requires that an object identifier
+ has always at least two sub-identifiers. The pattern
+ captures these restrictions.
+
+ Although the number of sub-identifiers is not limited,
+ module designers should realize that there may be
+ implementations that stick with the SMIv2 limit of 128
+ sub-identifiers.
+
+ This type is a superset of the SMIv2 OBJECT IDENTIFIER type
+ since it is not restricted to 128 sub-identifiers. Hence,
+ this type SHOULD NOT be used to represent the SMIv2 OBJECT
+ IDENTIFIER type; the object-identifier-128 type SHOULD be
+ used instead.";
+ reference
+ "ISO9834-1: Information technology -- Open Systems
+ Interconnection -- Procedures for the operation of OSI
+ Registration Authorities: General procedures and top
+ arcs of the ASN.1 Object Identifier tree";
+ }
+
+ typedef object-identifier-128 {
+ type object-identifier {
+ pattern '\d*(\.\d*){1,127}';
+ }
+ description
+ "This type represents object-identifiers restricted to 128
+ sub-identifiers.
+
+ In the value set and its semantics, this type is equivalent
+ to the OBJECT IDENTIFIER type of the SMIv2.";
+ reference
+ "RFC 2578: Structure of Management Information Version 2
+ (SMIv2)";
+ }
+
+ typedef yang-identifier {
+ type string {
+ length "1..max";
+ pattern '[a-zA-Z_][a-zA-Z0-9\-_.]*';
+ pattern '.|..|[^xX].*|.[^mM].*|..[^lL].*';
+ }
+ description
+ "A YANG identifier string as defined by the 'identifier'
+ rule in Section 12 of RFC 6020. An identifier must
+ start with an alphabetic character or an underscore
+ followed by an arbitrary sequence of alphabetic or
+ numeric characters, underscores, hyphens, or dots.
+
+ A YANG identifier MUST NOT start with any possible
+ combination of the lowercase or uppercase character
+ sequence 'xml'.";
+ reference
+ "RFC 6020: YANG - A Data Modeling Language for the Network
+ Configuration Protocol (NETCONF)";
+ }
+
+ /*** collection of types related to date and time***/
+
+ typedef date-and-time {
+ type string {
+ pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?'
+ + '(Z|[\+\-]\d{2}:\d{2})';
+ }
+ description
+ "The date-and-time type is a profile of the ISO 8601
+ standard for representation of dates and times using the
+ Gregorian calendar. The profile is defined by the
+ date-time production in Section 5.6 of RFC 3339.
+
+ The date-and-time type is compatible with the dateTime XML
+ schema type with the following notable exceptions:
+
+ (a) The date-and-time type does not allow negative years.
+
+ (b) The date-and-time time-offset -00:00 indicates an unknown
+ time zone (see RFC 3339) while -00:00 and +00:00 and Z
+ all represent the same time zone in dateTime.
+
+ (c) The canonical format (see below) of data-and-time values
+ differs from the canonical format used by the dateTime XML
+ schema type, which requires all times to be in UTC using
+ the time-offset 'Z'.
+
+ This type is not equivalent to the DateAndTime textual
+ convention of the SMIv2 since RFC 3339 uses a different
+ separator between full-date and full-time and provides
+ higher resolution of time-secfrac.
+
+ The canonical format for date-and-time values with a known time
+ zone uses a numeric time zone offset that is calculated using
+ the device's configured known offset to UTC time. A change of
+ the device's offset to UTC time will cause date-and-time values
+ to change accordingly. Such changes might happen periodically
+ in case a server follows automatically daylight saving time
+ (DST) time zone offset changes. The canonical format for
+ date-and-time values with an unknown time zone (usually
+ referring to the notion of local time) uses the time-offset
+ -00:00.";
+ reference
+ "RFC 3339: Date and Time on the Internet: Timestamps
+ RFC 2579: Textual Conventions for SMIv2
+ XSD-TYPES: XML Schema Part 2: Datatypes Second Edition";
+ }
+
+ typedef timeticks {
+ type uint32;
+ description
+ "The timeticks type represents a non-negative integer that
+ represents the time, modulo 2^32 (4294967296 decimal), in
+ hundredths of a second between two epochs. When a schema
+ node is defined that uses this type, the description of
+ the schema node identifies both of the reference epochs.
+
+ In the value set and its semantics, this type is equivalent
+ to the TimeTicks type of the SMIv2.";
+ reference
+ "RFC 2578: Structure of Management Information Version 2
+ (SMIv2)";
+ }
+
+ typedef timestamp {
+ type yang:timeticks;
+ description
+ "The timestamp type represents the value of an associated
+ timeticks schema node at which a specific occurrence
+ happened. The specific occurrence must be defined in the
+ description of any schema node defined using this type. When
+ the specific occurrence occurred prior to the last time the
+ associated timeticks attribute was zero, then the timestamp
+ value is zero. Note that this requires all timestamp values
+ to be reset to zero when the value of the associated timeticks
+ attribute reaches 497+ days and wraps around to zero.
+
+ The associated timeticks schema node must be specified
+ in the description of any schema node using this type.
+
+ In the value set and its semantics, this type is equivalent
+ to the TimeStamp textual convention of the SMIv2.";
+ reference
+ "RFC 2579: Textual Conventions for SMIv2";
+ }
+
+ /*** collection of generic address types ***/
+
+ typedef phys-address {
+ type string {
+ pattern '([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?';
+ }
+
+
+
+
+ description
+ "Represents media- or physical-level addresses represented
+ as a sequence octets, each octet represented by two hexadecimal
+ numbers. Octets are separated by colons. The canonical
+ representation uses lowercase characters.
+
+ In the value set and its semantics, this type is equivalent
+ to the PhysAddress textual convention of the SMIv2.";
+ reference
+ "RFC 2579: Textual Conventions for SMIv2";
+ }
+
+ typedef mac-address {
+ type string {
+ pattern '[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}';
+ }
+ description
+ "The mac-address type represents an IEEE 802 MAC address.
+ The canonical representation uses lowercase characters.
+
+ In the value set and its semantics, this type is equivalent
+ to the MacAddress textual convention of the SMIv2.";
+ reference
+ "IEEE 802: IEEE Standard for Local and Metropolitan Area
+ Networks: Overview and Architecture
+ RFC 2579: Textual Conventions for SMIv2";
+ }
+
+ /*** collection of XML-specific types ***/
+
+ typedef xpath1.0 {
+ type string;
+ description
+ "This type represents an XPATH 1.0 expression.
+
+ When a schema node is defined that uses this type, the
+ description of the schema node MUST specify the XPath
+ context in which the XPath expression is evaluated.";
+ reference
+ "XPATH: XML Path Language (XPath) Version 1.0";
+ }
+
+ /*** collection of string types ***/
+
+ typedef hex-string {
+ type string {
+ pattern '([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?';
+ }
+ description
+ "A hexadecimal string with octets represented as hex digits
+ separated by colons. The canonical representation uses
+ lowercase characters.";
+ }
+
+ typedef uuid {
+ type string {
+ pattern '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'
+ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}';
+ }
+ description
+ "A Universally Unique IDentifier in the string representation
+ defined in RFC 4122. The canonical representation uses
+ lowercase characters.
+
+ The following is an example of a UUID in string representation:
+ f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+ ";
+ reference
+ "RFC 4122: A Universally Unique IDentifier (UUID) URN
+ Namespace";
+ }
+
+ typedef dotted-quad {
+ type string {
+ pattern
+ '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}'
+ + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])';
+ }
+ description
+ "An unsigned 32-bit number expressed in the dotted-quad
+ notation, i.e., four octets written as decimal numbers
+ and separated with the '.' (full stop) character.";
+ }
+}
diff --git a/src/device/service/drivers/smartnic_probes/openconfig-extensions.yang b/src/device/service/drivers/smartnic_probes/openconfig-extensions.yang
new file mode 100644
index 000000000..2e0fd9f07
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/openconfig-extensions.yang
@@ -0,0 +1,206 @@
+module openconfig-extensions {
+
+ yang-version "1";
+
+ // namespace
+ namespace "http://openconfig.net/yang/openconfig-ext";
+
+ prefix "oc-ext";
+
+ // meta
+ organization "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ www.openconfig.net";
+
+ description
+ "This module provides extensions to the YANG language to allow
+ OpenConfig specific functionality and meta-data to be defined.";
+
+ oc-ext:openconfig-version "0.5.1";
+
+ revision "2022-10-05" {
+ description
+ "Add missing version statement.";
+ reference "0.5.1";
+ }
+
+ revision "2020-06-16" {
+ description
+ "Add extension for POSIX pattern statements.";
+ reference "0.5.0";
+ }
+
+ revision "2018-10-17" {
+ description
+ "Add extension for regular expression type.";
+ reference "0.4.0";
+ }
+
+ revision "2017-04-11" {
+ description
+ "rename password type to 'hashed' and clarify description";
+ reference "0.3.0";
+ }
+
+ revision "2017-01-29" {
+ description
+ "Added extension for annotating encrypted values.";
+ reference "0.2.0";
+ }
+
+ revision "2015-10-09" {
+ description
+ "Initial OpenConfig public release";
+ reference "0.1.0";
+ }
+
+
+ // extension statements
+ extension openconfig-version {
+ argument "semver" {
+ yin-element false;
+ }
+ description
+ "The OpenConfig version number for the module. This is
+ expressed as a semantic version number of the form:
+ x.y.z
+ where:
+ * x corresponds to the major version,
+ * y corresponds to a minor version,
+ * z corresponds to a patch version.
+ This version corresponds to the model file within which it is
+ defined, and does not cover the whole set of OpenConfig models.
+
+ Individual YANG modules are versioned independently -- the
+ semantic version is generally incremented only when there is a
+ change in the corresponding file. Submodules should always
+ have the same semantic version as their parent modules.
+
+ A major version number of 0 indicates that this model is still
+ in development (whether within OpenConfig or with industry
+ partners), and is potentially subject to change.
+
+ Following a release of major version 1, all modules will
+ increment major revision number where backwards incompatible
+ changes to the model are made.
+
+ The minor version is changed when features are added to the
+ model that do not impact current clients use of the model.
+
+ The patch-level version is incremented when non-feature changes
+ (such as bugfixes or clarifications to human-readable
+ descriptions that do not impact model functionality) are made
+ that maintain backwards compatibility.
+
+ The version number is stored in the module meta-data.";
+ }
+
+ extension openconfig-hashed-value {
+ description
+ "This extension provides an annotation on schema nodes to
+ indicate that the corresponding value should be stored and
+ reported in hashed form.
+
+ Hash algorithms are by definition not reversible. Clients
+ reading the configuration or applied configuration for the node
+ should expect to receive only the hashed value. Values written
+ in cleartext will be hashed. This annotation may be used on
+ nodes such as secure passwords in which the device never reports
+ a cleartext value, even if the input is provided as cleartext.";
+ }
+
+ extension regexp-posix {
+ description
+ "This extension indicates that the regular expressions included
+ within the YANG module specified are conformant with the POSIX
+ regular expression format rather than the W3C standard that is
+ specified by RFC6020 and RFC7950.";
+ }
+
+ extension posix-pattern {
+ argument "pattern" {
+ yin-element false;
+ }
+ description
+ "Provides a POSIX ERE regular expression pattern statement as an
+ alternative to YANG regular expresssions based on XML Schema Datatypes.
+ It is used the same way as the standard YANG pattern statement defined in
+ RFC6020 and RFC7950, but takes an argument that is a POSIX ERE regular
+ expression string.";
+ reference
+ "POSIX Extended Regular Expressions (ERE) Specification:
+ https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04";
+ }
+
+ extension telemetry-on-change {
+ description
+ "The telemetry-on-change annotation is specified in the context
+ of a particular subtree (container, or list) or leaf within the
+ YANG schema. Where specified, it indicates that the value stored
+ by the nodes within the context change their value only in response
+ to an event occurring. The event may be local to the target, for
+ example - a configuration change, or external - such as the failure
+ of a link.
+
+ When a telemetry subscription allows the target to determine whether
+ to export the value of a leaf in a periodic or event-based fashion
+ (e.g., TARGET_DEFINED mode in gNMI), leaves marked as
+ telemetry-on-change should only be exported when they change,
+ i.e., event-based.";
+ }
+
+ extension telemetry-atomic {
+ description
+ "The telemetry-atomic annotation is specified in the context of
+ a subtree (containre, or list), and indicates that all nodes
+ within the subtree are always updated together within the data
+ model. For example, all elements under the subtree may be updated
+ as a result of a new alarm being raised, or the arrival of a new
+ protocol message.
+
+ Transport protocols may use the atomic specification to determine
+ optimisations for sending or storing the corresponding data.";
+ }
+
+ extension operational {
+ description
+ "The operational annotation is specified in the context of a
+ grouping, leaf, or leaf-list within a YANG module. It indicates
+ that the nodes within the context are derived state on the device.
+
+ OpenConfig data models divide nodes into the following three categories:
+
+ - intended configuration - these are leaves within a container named
+ 'config', and are the writable configuration of a target.
+ - applied configuration - these are leaves within a container named
+ 'state' and are the currently running value of the intended configuration.
+ - derived state - these are the values within the 'state' container which
+ are not part of the applied configuration of the device. Typically, they
+ represent state values reflecting underlying operational counters, or
+ protocol statuses.";
+ }
+
+ extension catalog-organization {
+ argument "org" {
+ yin-element false;
+ }
+ description
+ "This extension specifies the organization name that should be used within
+ the module catalogue on the device for the specified YANG module. It stores
+ a pithy string where the YANG organization statement may contain more
+ details.";
+ }
+
+ extension origin {
+ argument "origin" {
+ yin-element false;
+ }
+ description
+ "This extension specifies the name of the origin that the YANG module
+ falls within. This allows multiple overlapping schema trees to be used
+ on a single network element without requiring module based prefixing
+ of paths.";
+ }
+}
diff --git a/src/device/service/drivers/smartnic_probes/openconfig-inet-types.yang b/src/device/service/drivers/smartnic_probes/openconfig-inet-types.yang
new file mode 100644
index 000000000..3d3ed425e
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/openconfig-inet-types.yang
@@ -0,0 +1,478 @@
+module openconfig-inet-types {
+
+ yang-version "1";
+ namespace "http://openconfig.net/yang/types/inet";
+ prefix "oc-inet";
+
+ import openconfig-extensions { prefix "oc-ext"; }
+
+ organization
+ "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ www.openconfig.net";
+
+ description
+ "This module contains a set of Internet address related
+ types for use in OpenConfig modules.
+
+ Portions of this code were derived from IETF RFC 6021.
+ Please reproduce this note if possible.
+
+ IETF code is subject to the following copyright and license:
+ Copyright (c) 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 (http://trustee.ietf.org/license-info).";
+
+ oc-ext:openconfig-version "0.6.0";
+
+ revision "2023-02-06" {
+ description
+ "Add ipv6-link-local and ipv6-address-type";
+ reference "0.6.0";
+ }
+
+ revision "2021-08-17" {
+ description
+ "Add ip-address-zoned typedef as a union between ipv4-address-zoned
+ and ipv6-address-zoned types.";
+ reference "0.5.0";
+ }
+
+ revision "2021-07-14" {
+ description
+ "Use auto-generated regex for ipv4 pattern statements:
+ - ipv4-address
+ - ipv4-address-zoned
+ - ipv4-prefix";
+ reference "0.4.1";
+ }
+
+ revision "2021-01-07" {
+ description
+ "Remove module extension oc-ext:regexp-posix by making pattern regexes
+ conform to RFC7950.
+
+ Types impacted:
+ - ipv4-address
+ - ipv4-address-zoned
+ - ipv6-address
+ - domain-name";
+ reference "0.4.0";
+ }
+
+ revision "2020-10-12" {
+ description
+ "Fix anchors for domain-name pattern.";
+ reference "0.3.5";
+ }
+
+ revision "2020-06-30" {
+ description
+ "Add OpenConfig POSIX pattern extensions and add anchors for domain-name
+ pattern.";
+ reference "0.3.4";
+ }
+
+ revision "2019-04-25" {
+ description
+ "Fix regex bug for ipv6-prefix type";
+ reference "0.3.3";
+ }
+
+ revision "2018-11-21" {
+ description
+ "Add OpenConfig module metadata extensions.";
+ reference "0.3.2";
+ }
+
+ revision 2017-08-24 {
+ description
+ "Minor formatting fixes.";
+ reference "0.3.1";
+ }
+
+ revision 2017-07-06 {
+ description
+ "Add domain-name and host typedefs";
+ reference "0.3.0";
+ }
+
+ revision 2017-04-03 {
+ description
+ "Add ip-version typedef.";
+ reference "0.2.0";
+ }
+
+ revision 2017-04-03 {
+ description
+ "Update copyright notice.";
+ reference "0.1.1";
+ }
+
+ revision 2017-01-26 {
+ description
+ "Initial module for inet types";
+ reference "0.1.0";
+ }
+
+ // OpenConfig specific extensions for module metadata.
+ oc-ext:catalog-organization "openconfig";
+ oc-ext:origin "openconfig";
+
+ // IPv4 and IPv6 types.
+
+ typedef ipv4-address {
+ type string {
+ pattern
+ '([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}';
+ oc-ext:posix-pattern
+ '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3})$';
+ }
+ description
+ "An IPv4 address in dotted quad notation using the default
+ zone.";
+ }
+
+ typedef ipv4-address-zoned {
+ type string {
+ pattern
+ '([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(%[a-zA-Z0-9_]+)';
+ oc-ext:posix-pattern
+ '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(%[a-zA-Z0-9_]+))$';
+ }
+ description
+ "An IPv4 address in dotted quad notation. This type allows
+ specification of a zone index to disambiguate identical
+ address values. For link-local addresses, the index is
+ typically the interface index or interface name.";
+ }
+
+ typedef ipv6-address {
+ type string {
+ pattern
+ // Must support compression through different lengths
+ // therefore this regexp is complex.
+ '(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')';
+ oc-ext:posix-pattern
+ // Must support compression through different lengths
+ // therefore this regexp is complex.
+ '^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')$';
+ }
+ description
+ "An IPv6 address represented as either a full address; shortened
+ or mixed-shortened formats, using the default zone.";
+ }
+
+ typedef ipv6-address-zoned {
+ type string {
+ pattern
+ // Must support compression through different lengths
+ // therefore this regexp is complex.
+ '^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')(%[a-zA-Z0-9_]+)$';
+ oc-ext:posix-pattern
+ // Must support compression through different lengths
+ // therefore this regexp is complex.
+ '^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')(%[a-zA-Z0-9_]+)$';
+ }
+ description
+ "An IPv6 address represented as either a full address; shortened
+ or mixed-shortened formats. This type allows specification of
+ a zone index to disambiguate identical address values. For
+ link-local addresses, the index is typically the interface
+ index or interface name.";
+ }
+
+ typedef ipv4-prefix {
+ type string {
+ pattern
+ '([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}/([0-9]|[12][0-9]|'
+ + '3[0-2])';
+ oc-ext:posix-pattern
+ '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|'
+ + '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}/([0-9]|[12][0-9]|'
+ + '3[0-2]))$';
+ }
+ description
+ "An IPv4 prefix represented in dotted quad notation followed by
+ a slash and a CIDR mask (0 <= mask <= 32).";
+ }
+
+ typedef ipv6-prefix {
+ type string {
+ pattern
+ '(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9])';
+ oc-ext:posix-pattern
+ '^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,7}:|' +
+ '([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|' +
+ '([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|' +
+ '([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|' +
+ '([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|' +
+ '[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|' +
+ ':((:[0-9a-fA-F]{1,4}){1,7}|:)' +
+ ')/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9])$';
+ }
+ description
+ "An IPv6 prefix represented in full, shortened, or mixed
+ shortened format followed by a slash and CIDR mask
+ (0 <= mask <= 128).";
+ }
+
+ typedef ip-address {
+ type union {
+ type ipv4-address;
+ type ipv6-address;
+ }
+ description
+ "An IPv4 or IPv6 address with no prefix specified.";
+ }
+
+ typedef ip-address-zoned {
+ type union {
+ type ipv4-address-zoned;
+ type ipv6-address-zoned;
+ }
+ description
+ "An IPv4 or IPv6 address with no prefix specified and an optional
+ zone index.";
+ }
+
+ typedef ip-prefix {
+ type union {
+ type ipv4-prefix;
+ type ipv6-prefix;
+ }
+ description
+ "An IPv4 or IPv6 prefix.";
+ }
+
+ typedef ip-version {
+ type enumeration {
+ enum UNKNOWN {
+ value 0;
+ description
+ "An unknown or unspecified version of the Internet
+ protocol.";
+ }
+ enum IPV4 {
+ value 4;
+ description
+ "The IPv4 protocol as defined in RFC 791.";
+ }
+ enum IPV6 {
+ value 6;
+ description
+ "The IPv6 protocol as defined in RFC 2460.";
+ }
+ }
+ description
+ "This value represents the version of the IP protocol.
+ Note that integer representation of the enumerated values
+ are not specified, and are not required to follow the
+ InetVersion textual convention in SMIv2.";
+ reference
+ "RFC 791: Internet Protocol
+ RFC 2460: Internet Protocol, Version 6 (IPv6) Specification
+ RFC 4001: Textual Conventions for Internet Network Addresses";
+ }
+
+ typedef ipv6-address-type {
+ type enumeration {
+ enum GLOBAL_UNICAST {
+ description
+ "The IPv6 address is a global unicast address type and must be in
+ the format defined in RFC 4291 section 2.4.";
+ }
+ enum LINK_LOCAL_UNICAST {
+ description
+ "The IPv6 address is a Link-Local unicast address type and must be
+ in the format defined in RFC 4291 section 2.4.";
+ }
+ }
+ description
+ "The value represents the type of IPv6 address";
+ reference
+ "RFC 4291: IP Version 6 Addressing Architecture
+ section 2.5";
+ }
+
+ typedef domain-name {
+ type string {
+ length "1..253";
+ pattern
+ '(((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*' +
+ '([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)' +
+ '|\.)';
+ oc-ext:posix-pattern
+ '^(((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*' +
+ '([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)' +
+ '|\.)$';
+ }
+ description
+ "The domain-name type represents a DNS domain name.
+ Fully quallified left to the models which utilize this type.
+
+ Internet domain names are only loosely specified. Section
+ 3.5 of RFC 1034 recommends a syntax (modified in Section
+ 2.1 of RFC 1123). The pattern above is intended to allow
+ for current practice in domain name use, and some possible
+ future expansion. It is designed to hold various types of
+ domain names, including names used for A or AAAA records
+ (host names) and other records, such as SRV records. Note
+ that Internet host names have a stricter syntax (described
+ in RFC 952) than the DNS recommendations in RFCs 1034 and
+ 1123, and that systems that want to store host names in
+ schema nodes using the domain-name type are recommended to
+ adhere to this stricter standard to ensure interoperability.
+
+ The encoding of DNS names in the DNS protocol is limited
+ to 255 characters. Since the encoding consists of labels
+ prefixed by a length bytes and there is a trailing NULL
+ byte, only 253 characters can appear in the textual dotted
+ notation.
+
+ Domain-name values use the US-ASCII encoding. Their canonical
+ format uses lowercase US-ASCII characters. Internationalized
+ domain names MUST be encoded in punycode as described in RFC
+ 3492";
+ }
+
+ typedef host {
+ type union {
+ type ip-address;
+ type domain-name;
+ }
+ description
+ "The host type represents either an unzoned IP address or a DNS
+ domain name.";
+ }
+
+ typedef as-number {
+ type uint32;
+ description
+ "A numeric identifier for an autonomous system (AS). An AS is a
+ single domain, under common administrative control, which forms
+ a unit of routing policy. Autonomous systems can be assigned a
+ 2-byte identifier, or a 4-byte identifier which may have public
+ or private scope. Private ASNs are assigned from dedicated
+ ranges. Public ASNs are assigned from ranges allocated by IANA
+ to the regional internet registries (RIRs).";
+ reference
+ "RFC 1930 Guidelines for creation, selection, and registration
+ of an Autonomous System (AS)
+ RFC 4271 A Border Gateway Protocol 4 (BGP-4)";
+ }
+
+ typedef dscp {
+ type uint8 {
+ range "0..63";
+ }
+ description
+ "A differentiated services code point (DSCP) marking within the
+ IP header.";
+ reference
+ "RFC 2474 Definition of the Differentiated Services Field
+ (DS Field) in the IPv4 and IPv6 Headers";
+ }
+
+ typedef ipv6-flow-label {
+ type uint32 {
+ range "0..1048575";
+ }
+ description
+ "The IPv6 flow-label is a 20-bit value within the IPv6 header
+ which is optionally used by the source of the IPv6 packet to
+ label sets of packets for which special handling may be
+ required.";
+ reference
+ "RFC 2460 Internet Protocol, Version 6 (IPv6) Specification";
+ }
+
+ typedef port-number {
+ type uint16;
+ description
+ "A 16-bit port number used by a transport protocol such as TCP
+ or UDP.";
+ reference
+ "RFC 768 User Datagram Protocol
+ RFC 793 Transmission Control Protocol";
+ }
+
+ typedef uri {
+ type string;
+ description
+ "An ASCII-encoded Uniform Resource Identifier (URI) as defined
+ in RFC 3986.";
+ reference
+ "RFC 3986 Uniform Resource Identifier (URI): Generic Syntax";
+ }
+
+ typedef url {
+ type string;
+ description
+ "An ASCII-encoded Uniform Resource Locator (URL) as defined
+ in RFC 3986, section 1.1.3";
+ reference
+ "RFC 3986, paragraph 1.1.3";
+ }
+
+}
diff --git a/src/device/service/drivers/smartnic_probes/openconfig-probes-types.yang b/src/device/service/drivers/smartnic_probes/openconfig-probes-types.yang
new file mode 100644
index 000000000..c5e13f370
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/openconfig-probes-types.yang
@@ -0,0 +1,86 @@
+module openconfig-probes-types {
+
+ yang-version "1";
+
+ // namespace
+ namespace "http://openconfig.net/yang/probes/types";
+
+ prefix "oc-probes-types";
+
+ // import some basic types
+ import openconfig-extensions { prefix oc-ext; }
+
+ // meta
+ organization "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ www.openconfig.net";
+
+ description
+ "This module defines types related to the probes.";
+
+ oc-ext:openconfig-version "0.1.1";
+
+ revision "2018-11-21" {
+ description
+ "Add OpenConfig module metadata extensions.";
+ reference "0.1.1";
+ }
+
+ revision "2017-09-05" {
+ description
+ "Initial public revision";
+ reference "0.1.0";
+ }
+
+ // OpenConfig specific extensions for module metadata.
+ oc-ext:regexp-posix;
+ oc-ext:catalog-organization "openconfig";
+ oc-ext:origin "openconfig";
+
+ typedef test-type {
+ type enumeration {
+ enum ICMP {
+ description
+ "Send ICMP echo requests.";
+ }
+ enum ICMP6 {
+ description
+ "Send ICMP6 echo requests.";
+ }
+ enum ICMP_TIMESTAMP {
+ description
+ "Send ICMP timestamp requests.";
+ }
+ enum ICMP6_TIMESTAMP {
+ description
+ "Sedn ICMP6 timestamp requests.";
+ }
+ enum TCP {
+ description
+ "Send TPC packets.";
+ }
+ enum UDP {
+ description
+ "Send UDP packets.";
+ }
+ enum UDP_TIMESTAMP {
+ description
+ "Send UDP packets with timestamp.";
+ }
+ enum HTTP_GET {
+ description
+ "Execute HTTP GET requests.";
+ }
+ enum HTTP_GET_META {
+ description
+ "Execute HTTP GET requests of metadata.";
+ }
+ }
+ description
+ "Type definition with enumerations describing the basis of
+ the probe test type identifier";
+ }
+
+}
\ No newline at end of file
diff --git a/src/device/service/drivers/smartnic_probes/openconfig-probes.yang b/src/device/service/drivers/smartnic_probes/openconfig-probes.yang
new file mode 100644
index 000000000..27b7e4c0d
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/openconfig-probes.yang
@@ -0,0 +1,575 @@
+module openconfig-probes {
+
+ // namespace
+ namespace "http://openconfig.net/yang/probes";
+
+ prefix "oc-probes";
+
+ import ietf-yang-types { prefix yang; }
+ import openconfig-types { prefix oc-types; }
+ import openconfig-extensions { prefix oc-ext; }
+ import openconfig-inet-types { prefix oc-inet; }
+ import openconfig-probes-types { prefix oc-probes-types; }
+
+ organization "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ www.openconfig.net";
+
+ description
+ "This module defines configuration and operational state data
+ for the probes.
+ A probe consists on a group of tests, each test being a
+ source-destination pair to poll. The destination can be either
+ IP Address (and eventually port) or URL, depending on the
+ nature of the test. The test can send ICMP, UDP, TCP, or HTTP
+ requests.
+ Each test groups a list of test items, the test results
+ being an overall view or average of the items list.
+ However, the test preserves only a limited set of history
+ items, whose length can be controlled using the history-size.";
+
+ oc-ext:openconfig-version "0.0.2";
+
+ revision "2018-11-21" {
+ description
+ "Add OpenConfig module metadata extensions.";
+ reference "0.0.2";
+ }
+
+ revision "2017-09-05" {
+ description
+ "Initial public revision";
+ reference "0.0.1";
+ }
+
+ // OpenConfig specific extensions for module metadata.
+ oc-ext:regexp-posix;
+ oc-ext:catalog-organization "openconfig";
+ oc-ext:origin "openconfig";
+
+ grouping test-target {
+ description
+ "Groups the config and state containers
+ for an individual test.";
+
+ container target {
+ description
+ "The target configuration of the test.
+ The nature of the target depends on the probe type:
+ for HTTP probes we need to provide an URL to poll,
+ while ICMP probes require an IP address to monitor.";
+
+ container config {
+ description
+ "Configuration data for the test target.";
+
+ uses test-target-base;
+ }
+
+ container state {
+ config false;
+
+ description
+ "Operational data for the test target.";
+
+ uses test-target-base;
+ }
+ }
+ }
+
+ grouping test-target-base {
+ description
+ "Targe types for the probe test.";
+
+ leaf address {
+ type oc-inet:ip-address;
+ description
+ "IP address of the target, either IPv4 or IPv6.";
+ }
+
+ leaf port {
+ type oc-inet:port-number;
+ description
+ "Destination port.";
+ }
+
+ leaf url {
+ type oc-inet:url;
+ description
+ "Target URL to probe.";
+ }
+ }
+
+ grouping probe-test-config-base {
+ description
+ "Definition of test details.";
+
+ leaf test-type {
+ type oc-probes-types:test-type;
+ description
+ "The type of the probe test.";
+ mandatory true;
+ }
+
+ leaf count {
+ type yang:counter64;
+ description
+ "The number of probes per test.";
+ }
+
+ leaf interval {
+ type yang:counter64;
+ description
+ "Time between two consecutive probes.";
+ }
+
+ leaf source {
+ type oc-inet:ip-address;
+ description
+ "Source address used when probing, either IPv4 or IPv6.";
+ }
+
+ leaf history-size {
+ type yang:counter64;
+ description
+ "The number of history entries stored.";
+ }
+
+ leaf source-port {
+ type oc-inet:port-number;
+ description
+ "Source number used.";
+ }
+
+ leaf dscp {
+ type oc-inet:dscp;
+ description
+ "DSCP code points";
+ }
+
+ }
+
+ grouping probe-test-state-history-item-base {
+ description
+ "The test item results counters and statistics.
+ An item presents the results of a single execution
+ of the test.
+ The results of the test depend on the values
+ of the total items, or an average over a certain
+ period of time.";
+
+ leaf id {
+ type yang:counter64;
+ description
+ "The test item ID.";
+ }
+
+ leaf timestamp {
+ type oc-types:timeticks64;
+ description
+ "The test timestamp.
+ This is not the timestamp when the test
+ was actually executed nither when it finished.
+ Should be the timestamp when the test has been scheduled.
+ It may not be the same with start-timestamp.";
+ }
+
+ leaf start-timestamp {
+ type oc-types:timeticks64;
+ description
+ "The timestamp when the test started.";
+ }
+
+ leaf end-timestamp {
+ type oc-types:timeticks64;
+ description
+ "The timestamp when the test finished.";
+ }
+
+ leaf test-duration {
+ type yang:counter64;
+ description
+ "The duration of the test, in microseconds.";
+ }
+
+ leaf failed {
+ type boolean;
+ description
+ "Whether the test failed or succeeded.";
+ }
+
+ leaf probes-sent {
+ type yang:counter64;
+ description
+ "Number of test probes sent.";
+ }
+
+ leaf probes-received {
+ type yang:counter64;
+ description
+ "Number of test probes received.";
+ }
+
+ leaf loss-percentage {
+ type oc-types:percentage;
+ description
+ "The loss percentage.";
+ }
+
+ leaf jitter {
+ type yang:counter64;
+ description
+ "The round trip jitter, in microseconds.";
+ }
+
+ leaf min-delay {
+ type yang:counter64;
+ description
+ "The minimum delay recorded during the test, in microseconds.";
+ }
+
+ leaf max-delay {
+ type yang:counter64;
+ description
+ "The maximum delay recorded during the test, in microseconds.";
+ }
+
+ leaf avg-delay {
+ type yang:counter64;
+ description
+ "The average delay recorded during the test, in microseconds.";
+ }
+
+ leaf stddev-delay {
+ type yang:counter64;
+ description
+ "The standard deviation of the delay of the test.";
+ }
+
+ }
+
+ grouping probe-test-state-history-item {
+ description
+ "A history item of the probe results.";
+
+ container state {
+
+ config false;
+
+ description
+ "A history item of the probe results: operational data only.";
+
+ uses probe-test-state-history-item-base;
+ }
+
+ }
+
+ grouping probe-test-state-history {
+
+ description
+ "The history of the test results.";
+
+ container items {
+
+ description
+ "The list of items in the probe history.
+ The length depends on the history size.";
+
+ list item {
+ key "id";
+ description
+ "List of history items.";
+
+ leaf id {
+ type leafref {
+ path "../state/id";
+ }
+ description
+ "Reference to the history entry ID.";
+ }
+
+ uses probe-test-state-history-item;
+ }
+
+ }
+
+ }
+
+ grouping probe-test-state-results {
+ description
+ "The test results counters and statistics.";
+
+ leaf timestamp {
+ type oc-types:timeticks64;
+ description
+ "The test timestamp.
+ This is not the timestamp when the test
+ was actually executed nither when it finished.
+ Should be the timestamp when the test has been scheduled.
+ It may not be the same with start-timestamp.";
+ }
+
+ leaf start-timestamp {
+ type oc-types:timeticks64;
+ description
+ "The timestamp when the test started.";
+ }
+
+ leaf last-test-timestamp {
+ type oc-types:timeticks64;
+ description
+ "The timestamp when the test finished.";
+ }
+
+ leaf test-duration {
+ type yang:counter64;
+ description
+ "The duration of the test, in microseconds.";
+ }
+
+ leaf failed {
+ type boolean;
+ description
+ "Whether the test failed or succeeded.";
+ }
+
+ leaf probes-sent {
+ type yang:counter64;
+ description
+ "Number of test probes sent.";
+ }
+
+ leaf probes-received {
+ type yang:counter64;
+ description
+ "Number of test probes received.";
+ }
+
+ leaf loss-percentage {
+ type oc-types:percentage;
+ description
+ "The loss percentage.";
+ }
+
+ leaf jitter {
+ type yang:counter64;
+ description
+ "The round trip jitter, in microseconds.";
+ }
+
+ leaf min-delay {
+ type yang:counter64;
+ description
+ "The minimum delay recorded during the test, in microseconds.";
+ }
+
+ leaf max-delay {
+ type yang:counter64;
+ description
+ "The maximum delay recorded during the test, in microseconds.";
+ }
+
+ leaf avg-delay {
+ type yang:counter64;
+ description
+ "The average delay recorded during the test, in microseconds.";
+ }
+
+ leaf stddev-delay {
+ type yang:counter64;
+ description
+ "The standard deviation of the delay of the test.";
+ }
+
+
+ }
+
+ grouping probe-test-state {
+
+ description
+ "Operational data and results for the probes.";
+
+ }
+
+ grouping probe-test-config {
+ description
+ "Definition of test details.";
+
+ leaf name {
+ type string;
+ description
+ "The name of the test probe";
+ mandatory true;
+ }
+
+ leaf enabled {
+ type boolean;
+ default true;
+ description
+ "Whether the test is enabled.";
+ }
+
+ uses probe-test-config-base;
+
+ }
+
+ grouping probe-tests-top {
+ description
+ "Top-level grouping for the tests withing a probe.";
+
+ list test {
+ key "name";
+ description
+ "List of tests associated with this probe.";
+
+ leaf name {
+ type leafref {
+ path "../config/name";
+ }
+ description
+ "Reference to the list key";
+ }
+
+ container config {
+ description
+ "Configuration data for the test of this probe.";
+
+ uses probe-test-config;
+ }
+
+ container state {
+
+ config false;
+
+ description
+ "Operational state data";
+
+ uses probe-test-config;
+ uses probe-test-state;
+ }
+
+ uses test-target;
+
+ container results {
+ description
+ "Contains the results of the tests.";
+
+ container state {
+
+ config false;
+
+ description
+ "Results of this test: operational data only";
+
+ uses probe-test-state-results;
+ }
+
+ container history {
+
+ config false;
+
+ description
+ "Historical data of the tests.";
+
+ uses probe-test-state-history;
+ }
+
+ }
+
+ }
+ // end list of probes
+
+ }
+
+ grouping probe-config {
+ description
+ "Definition of probe details.";
+
+ leaf name {
+ type string;
+ description
+ "The name of the probe.";
+ mandatory true;
+ }
+
+ leaf enabled {
+ type boolean;
+ default true;
+ description
+ "Whether the probe is enabled.";
+ }
+
+ }
+
+ grouping probe-state {
+ description
+ "Definition of probes operation data.";
+ }
+
+ grouping probes-top {
+ description
+ "Top-level grouping for probes model";
+
+ list probe {
+ key "name";
+ description
+ "List of probes configured.";
+
+ leaf name {
+ type leafref {
+ path "../config/name";
+ }
+ description
+ "Reference to the list key";
+ }
+
+ container config {
+ description
+ "Configuration data for the probes.";
+
+ uses probe-config;
+ }
+
+ container state {
+
+ config false;
+
+ description
+ "Operational state data";
+
+ uses probe-config;
+ uses probe-state;
+ }
+
+ container tests {
+
+ description
+ "The tests associated to be executed for the probe.";
+
+ uses probe-tests-top;
+ }
+
+ }
+ // end list of probes
+
+ }
+
+ grouping openconfig-probes-top {
+
+ description
+ "The top level grouping of the probes model.";
+
+ container probes {
+ description
+ "The container containing the list of probes.";
+
+ uses probes-top;
+ }
+
+ }
+
+ uses openconfig-probes-top;
+
+}
\ No newline at end of file
diff --git a/src/device/service/drivers/smartnic_probes/openconfig-types.yang b/src/device/service/drivers/smartnic_probes/openconfig-types.yang
new file mode 100644
index 000000000..89e32d515
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/openconfig-types.yang
@@ -0,0 +1,471 @@
+module openconfig-types {
+ yang-version "1";
+
+ namespace "http://openconfig.net/yang/openconfig-types";
+
+ prefix "oc-types";
+
+ // import statements
+ import openconfig-extensions { prefix oc-ext; }
+
+ // meta
+ organization
+ "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ netopenconfig@googlegroups.com";
+
+ description
+ "This module contains a set of general type definitions that
+ are used across OpenConfig models. It can be imported by modules
+ that make use of these types.";
+
+ oc-ext:openconfig-version "0.6.0";
+
+ revision "2019-04-16" {
+ description
+ "Clarify definition of timeticks64.";
+ reference "0.6.0";
+ }
+
+ revision "2018-11-21" {
+ description
+ "Add OpenConfig module metadata extensions.";
+ reference "0.5.1";
+ }
+
+ revision "2018-05-05" {
+ description
+ "Add grouping of min-max-time and
+ included them to all stats with min/max/avg";
+ reference "0.5.0";
+ }
+
+ revision "2018-01-16" {
+ description
+ "Add interval to min/max/avg stats; add percentage stat";
+ reference "0.4.0";
+ }
+
+ revision "2017-08-16" {
+ description
+ "Apply fix for ieetfloat32 length parameter";
+ reference "0.3.3";
+ }
+
+ revision "2017-01-13" {
+ description
+ "Add ADDRESS_FAMILY identity";
+ reference "0.3.2";
+ }
+
+ revision "2016-11-14" {
+ description
+ "Correct length of ieeefloat32";
+ reference "0.3.1";
+ }
+
+ revision "2016-11-11" {
+ description
+ "Additional types - ieeefloat32 and routing-password";
+ reference "0.3.0";
+ }
+
+ revision "2016-05-31" {
+ description
+ "OpenConfig public release";
+ reference "0.2.0";
+ }
+
+ // OpenConfig specific extensions for module metadata.
+ oc-ext:regexp-posix;
+ oc-ext:catalog-organization "openconfig";
+ oc-ext:origin "openconfig";
+
+ typedef percentage {
+ type uint8 {
+ range "0..100";
+ }
+ description
+ "Integer indicating a percentage value";
+ }
+
+ typedef std-regexp {
+ type string;
+ description
+ "This type definition is a placeholder for a standard
+ definition of a regular expression that can be utilised in
+ OpenConfig models. Further discussion is required to
+ consider the type of regular expressions that are to be
+ supported. An initial proposal is POSIX compatible.";
+ }
+
+ typedef timeticks64 {
+ type uint64;
+ units "nanoseconds";
+ description
+ "The timeticks64 represents the time, modulo 2^64 in
+ nanoseconds between two epochs. The leaf using this
+ type must define the epochs that tests are relative to.";
+ }
+
+ typedef ieeefloat32 {
+ type binary {
+ length "4";
+ }
+ description
+ "An IEEE 32-bit floating point number. The format of this number
+ is of the form:
+ 1-bit sign
+ 8-bit exponent
+ 23-bit fraction
+ The floating point value is calculated using:
+ (-1)**S * 2**(Exponent-127) * (1+Fraction)";
+ }
+
+ typedef routing-password {
+ type string;
+ description
+ "This type is indicative of a password that is used within
+ a routing protocol which can be returned in plain text to the
+ NMS by the local system. Such passwords are typically stored
+ as encrypted strings. Since the encryption used is generally
+ well known, it is possible to extract the original value from
+ the string - and hence this format is not considered secure.
+ Leaves specified with this type should not be modified by
+ the system, and should be returned to the end-user in plain
+ text. This type exists to differentiate passwords, which
+ may be sensitive, from other string leaves. It could, for
+ example, be used by the NMS to censor this data when
+ viewed by particular users.";
+ }
+
+ typedef stat-interval {
+ type uint64;
+ units nanoseconds;
+ description
+ "A time interval over which a set of statistics is computed.
+ A common usage is to report the interval over which
+ avg/min/max stats are computed and reported.";
+ }
+
+ grouping stat-interval-state {
+ description
+ "Reusable leaf definition for stats computation interval";
+
+ leaf interval {
+ type oc-types:stat-interval;
+ description
+ "If supported by the system, this reports the time interval
+ over which the min/max/average statistics are computed by
+ the system.";
+ }
+ }
+
+ grouping min-max-time {
+ description
+ "Common grouping for recording the absolute time at which
+ the minimum and maximum values occurred in the statistics";
+
+ leaf min-time {
+ type oc-types:timeticks64;
+ description
+ "The absolute time at which the minimum value occurred.
+ The value is the timestamp in nanoseconds relative to
+ the Unix Epoch (Jan 1, 1970 00:00:00 UTC).";
+ }
+
+ leaf max-time {
+ type oc-types:timeticks64;
+ description
+ "The absolute time at which the maximum value occurred.
+ The value is the timestamp in nanoseconds relative to
+ the Unix Epoch (Jan 1, 1970 00:00:00 UTC).";
+ }
+ }
+
+ grouping avg-min-max-stats-precision1 {
+ description
+ "Common nodes for recording average, minimum, and
+ maximum values for a statistic. These values all have
+ fraction-digits set to 1. Statistics are computed
+ and reported based on a moving time interval (e.g., the last
+ 30s). If supported by the device, the time interval over which
+ the statistics are computed is also reported.";
+
+ leaf avg {
+ type decimal64 {
+ fraction-digits 1;
+ }
+ description
+ "The arithmetic mean value of the statistic over the
+ time interval.";
+ }
+
+ leaf min {
+ type decimal64 {
+ fraction-digits 1;
+ }
+ description
+ "The minimum value of the statistic over the time
+ interval.";
+ }
+
+ leaf max {
+ type decimal64 {
+ fraction-digits 1;
+ }
+ description
+ "The maximum value of the statitic over the time
+ interval.";
+ }
+
+ uses stat-interval-state;
+ uses min-max-time;
+ }
+
+ grouping avg-min-max-instant-stats-precision1 {
+ description
+ "Common grouping for recording an instantaneous statistic value
+ in addition to avg-min-max stats";
+
+ leaf instant {
+ type decimal64 {
+ fraction-digits 1;
+ }
+ description
+ "The instantaneous value of the statistic.";
+ }
+
+ uses avg-min-max-stats-precision1;
+ }
+
+ grouping avg-min-max-instant-stats-precision2-dB {
+ description
+ "Common grouping for recording dB values with 2 decimal
+ precision. Values include the instantaneous, average,
+ minimum, and maximum statistics. Statistics are computed
+ and reported based on a moving time interval (e.g., the last
+ 30s). If supported by the device, the time interval over which
+ the statistics are computed, and the times at which the minimum
+ and maximum values occurred, are also reported.";
+
+ leaf instant {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dB;
+ description
+ "The instantaneous value of the statistic.";
+ }
+
+ leaf avg {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dB;
+ description
+ "The arithmetic mean value of the statistic over the
+ time interval.";
+ }
+
+ leaf min {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dB;
+ description
+ "The minimum value of the statistic over the time interval.";
+ }
+
+ leaf max {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dB;
+ description
+ "The maximum value of the statistic over the time
+ interval.";
+ }
+
+ uses stat-interval-state;
+ uses min-max-time;
+ }
+
+ grouping avg-min-max-instant-stats-precision2-dBm {
+ description
+ "Common grouping for recording dBm values with 2 decimal
+ precision. Values include the instantaneous, average,
+ minimum, and maximum statistics. Statistics are computed
+ and reported based on a moving time interval (e.g., the last
+ 30s). If supported by the device, the time interval over which
+ the statistics are computed, and the times at which the minimum
+ and maximum values occurred, are also reported.";
+
+ leaf instant {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dBm;
+ description
+ "The instantaneous value of the statistic.";
+ }
+
+ leaf avg {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dBm;
+ description
+ "The arithmetic mean value of the statistic over the
+ time interval.";
+ }
+
+ leaf min {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dBm;
+ description
+ "The minimum value of the statistic over the time
+ interval.";
+ }
+
+ leaf max {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units dBm;
+ description
+ "The maximum value of the statistic over the time interval.";
+ }
+
+ uses stat-interval-state;
+ uses min-max-time;
+ }
+
+ grouping avg-min-max-instant-stats-precision2-mA {
+ description
+ "Common grouping for recording mA values with 2 decimal
+ precision. Values include the instantaneous, average,
+ minimum, and maximum statistics. Statistics are computed
+ and reported based on a moving time interval (e.g., the last
+ 30s). If supported by the device, the time interval over which
+ the statistics are computed, and the times at which the minimum
+ and maximum values occurred, are also reported.";
+
+ leaf instant {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units mA;
+ description
+ "The instantaneous value of the statistic.";
+ }
+
+ leaf avg {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units mA;
+ description
+ "The arithmetic mean value of the statistic over the
+ time interval.";
+ }
+
+ leaf min {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units mA;
+ description
+ "The minimum value of the statistic over the time
+ interval.";
+ }
+
+ leaf max {
+ type decimal64 {
+ fraction-digits 2;
+ }
+ units mA;
+ description
+ "The maximum value of the statistic over the time
+ interval.";
+ }
+
+ uses stat-interval-state;
+ uses min-max-time;
+ }
+
+ grouping avg-min-max-instant-stats-pct {
+ description
+ "Common grouping for percentage statistics.
+ Values include the instantaneous, average,
+ minimum, and maximum statistics. Statistics are computed
+ and reported based on a moving time interval (e.g., the last
+ 30s). If supported by the device, the time interval over which
+ the statistics are computed, and the times at which the minimum
+ and maximum values occurred, are also reported.";
+
+ leaf instant {
+ type oc-types:percentage;
+ description
+ "The instantaneous percentage value.";
+ }
+
+ leaf avg {
+ type oc-types:percentage;
+ description
+ "The arithmetic mean value of the percentage measure of the
+ statistic over the time interval.";
+ }
+
+ leaf min {
+ type oc-types:percentage;
+ description
+ "The minimum value of the percentage measure of the
+ statistic over the time interval.";
+ }
+
+ leaf max {
+ type oc-types:percentage;
+ description
+ "The maximum value of the percentage measure of the
+ statistic over the time interval.";
+ }
+
+ uses stat-interval-state;
+ uses min-max-time;
+ }
+
+ identity ADDRESS_FAMILY {
+ description
+ "A base identity for all address families";
+ }
+
+ identity IPV4 {
+ base ADDRESS_FAMILY;
+ description
+ "The IPv4 address family";
+ }
+
+ identity IPV6 {
+ base ADDRESS_FAMILY;
+ description
+ "The IPv6 address family";
+ }
+
+ identity MPLS {
+ base ADDRESS_FAMILY;
+ description
+ "The MPLS address family";
+ }
+
+ identity L2_ETHERNET {
+ base ADDRESS_FAMILY;
+ description
+ "The 802.3 Ethernet address family";
+ }
+
+}
diff --git a/src/device/service/drivers/smartnic_probes/probes-agent.yang b/src/device/service/drivers/smartnic_probes/probes-agent.yang
index 6029cd204..897d2f129 100644
--- a/src/device/service/drivers/smartnic_probes/probes-agent.yang
+++ b/src/device/service/drivers/smartnic_probes/probes-agent.yang
@@ -25,32 +25,7 @@ augment '/oc-probes:probes/oc-probes:probe/oc-probes:tests/oc-probes:test/oc-pro
uses morpheus_pipelines;
}
-grouping morpheus_pipelines {
- list morpheus_pipelines {
- key name;
- uses morpheus_pipeline;
- }
-}
-
-grouping morpheus_pipeline {
- leaf name { type string; }
- leaf num_threads { type uint16; }
- leaf pipeline_batch_size {type uint64; }
- leaf model_max_batch_size {type uint64; }
- leaf input_file {type string; }
- leaf output_file {type string; }
- leaf model_fea_length {type uint16; }
- leaf model_name {type string; }
- leaf iterative {type boolean; }
- leaf server_url {type string; }
- leaf file_type {type files; }
- list stages {
- key name;
- uses morpheus_pipeline_stage;
- }
-}
-
-typedef files {
+typedef files{
type enumeration {
enum "auto";
enum "csv";
@@ -58,27 +33,14 @@ typedef files {
}
}
-typedef stage {
- type enumeration {
- enum "FileSourceStage";
- enum "DeserializeStage";
- enum "AbpPcapPreprocessingStage";
- enum "MonitorStage";
- enum "TritonInferenceStage";
- enum "AddClassificationsStage";
- enum "SerializeStage";
- enum "WriteToFileStage";
- }
-}
-
-grouping prob {
+grouping prob{
leaf value {
- type string;
+ type string; // e.g. "probs"
description "probs";
}
}
-grouping conf {
+grouping conf{
leaf mode {type string; }
leaf num_threads { type uint16; }
leaf pipeline_batch_size { type uint64; }
@@ -90,20 +52,98 @@ grouping conf {
}
grouping morpheus_pipeline_stage {
- leaf name { type string; }
- leaf stage_type {type stage; }
- list configuration {key "mode"; uses conf;}
- leaf filename {type string;}
- leaf iterative {type boolean;}
- leaf file_type {type files;}
- leaf filter_null {type boolean;}
- leaf descriptions {type string;}
+ leaf stage_name { type string; }
+ choice stage_type {
+ case FileSourceStage {
+ container FileSourceStage {
+ list fs_configuration {key "mode"; uses conf;}
+ leaf filename {type string;}
+ leaf iterative {type boolean;}
+ leaf file_type {type files;}
+ leaf filter_null {type boolean;}
+ }
+ }
+ case DeserializeStage {
+ container DeserializeStage {
+ list ds_configuration {key "mode"; uses conf;}
+ }
+ }
+ case AbpPcapPreprocessingStage {
+ container AbpPcapPreprocessingStage {
+ list apps_configuration {key "mode"; uses conf;}
+ }
+ }
+ case MonitorStage {
+ container MonitorStage {
+ list ms_configuration {key "mode"; uses conf;}
+ leaf descriptions {type string;}
+ leaf unit {type string;}
+ }
+ }
+ case TritonInferenceStage {
+ container TritonInferenceStage {
+ list tis_configuration {key "mode"; uses conf;}
+ leaf model_name {type string;}
+ leaf server_url {type string;}
+ leaf force_convert_inputs {type boolean;}
+ }
+ }
+ case AddClassificationsStage{
+ container AddClassificationsStage {
+ list acs_configuration {key "mode"; uses conf;}
+ list labels {key "value"; uses prob;}
+ }
+ }
+ case SerializeStage {
+ container SerializeStage {
+ list ss_configuration {key "mode"; uses conf;}
+ leaf kwargs {type empty;}
+ }
+ }
+ case WriteToFileStage{
+ container WriteToFileStage {
+ list wfs_configuration {key "mode"; uses conf;}
+ leaf wfs_filename {type string;}
+ leaf overwrite {type boolean;}
+ }
+ }
+ case CustomStage {
+ list custom {
+ key "field_name";
+ leaf field_name {type string;}
+ leaf field_value {type string;}
+ }
+ }
+ }
+}
+
+grouping morpheus_pipeline {
+ leaf pipeline_name {type string;}
+ leaf num_threads {type uint16;}
+ leaf pipeline_batch_size {type uint64; }
+ leaf model_max_batch_size {type uint64; }
+ leaf input_file {type string;}
+ leaf output_file {type string;}
+ leaf model_fea_length {type uint16;}
leaf model_name {type string;}
+ leaf iterative {type boolean;}
leaf server_url {type string;}
- leaf force_convert_inputs {type boolean;}
- leaf unit {type string;}
- list labels {key "value"; uses prob;}
- leaf kwargs {type empty;}
- leaf overwrite {type boolean;}
+ leaf file_type {type files;}
+ list stages {
+ key "stage_name";
+ uses morpheus_pipeline_stage;
+ }
+}
+
+grouping morpheus_pipelines {
+ list morpheus_pipeline {
+ key "pipeline_name";
+ uses morpheus_pipeline;
+ }
+}
+
+container morpheus_pipelines {
+ uses morpheus_pipelines;
}
+
}
\ No newline at end of file
diff --git a/src/device/service/drivers/smartnic_probes/references_probes_libraries.txt b/src/device/service/drivers/smartnic_probes/references_probes_libraries.txt
new file mode 100644
index 000000000..7628b7c2f
--- /dev/null
+++ b/src/device/service/drivers/smartnic_probes/references_probes_libraries.txt
@@ -0,0 +1,6 @@
+ietf-yang-types.yang -> https://github.com/YangModels/yang/blob/main/vendor/cisco/xe/1661/ietf-yang-types.yang
+openconfig-extensions.yang -> https://github.com/openconfig/public/blob/master/release/models/openconfig-extensions.yang
+openconfig-inet-types.yang -> https://github.com/openconfig/public/blob/master/release/models/types/openconfig-inet-types.yang
+openconfig-probes-types.yang -> https://github.com/openconfig/public/blob/master/release/models/probes/openconfig-probes-types.yang
+openconfig-probes.yang -> https://github.com/openconfig/public/blob/master/release/models/probes/openconfig-probes.yang
+openconfig-types.yang -> https://github.com/openconfig/public/blob/master/release/models/types/openconfig-types.yang
--
GitLab