You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/mgmt/Management Framework.md
+20-8
Original file line number
Diff line number
Diff line change
@@ -274,7 +274,7 @@ GNMI service defines a gRPC-based protocol for the modification and retrieval of
274
274
3. A new transl data client is added to process the incoming YANG-based request (either standard or proprietary)
275
275
4. The new transl data client relies on Translib infra provided to translate, get, set of the YANG objects.
276
276
277
-
More details onthe GNMI server, Client and workflow provided later in the document.
277
+
More details on the GNMI server, Client and workflow provided later in the document.
278
278
279
279
### 3.2 SONiC Management Framework Components
280
280
@@ -566,12 +566,12 @@ Client applications can use swagger generated client SDK or any other REST clien
566
566
567
567
##### 3.2.2.3 gNMI Client
568
568
569
-
SONiC Teleletry service provides the gNMI server, while the client must be provided by the user.
569
+
SONiC Telemetry service provides the gNMI server, while the client must be provided by the user. gNMI is typically used as a programmatic interface and therefore it is typically called directly from programming language environments using their respective gRPC libraries (https://github.com/grpc/grpc). For testing and scripting purposes, several CLI programs are provided as well.
570
570
571
-
GNMI client developed by JipanYANG.(github.com/jipanYANG/gnxi/gnmi_get, github.com/jipanYANG/gnxi/gnmi_set)
572
-
is used for testing. gnmi_get and gnmi_set code has been changed to handle module name.
571
+
GNMI clients developed by google and modified by JipanYANG.(github.com/jipanYANG/gnxi/gnmi_get, github.com/jipanYANG/gnxi/gnmi_set)
572
+
was taken and further modified to support new features. gnmi_cli from openconfig (https://github.com/openconfig/gnmi/tree/master/cmd/gnmi_cli) is also taken for testing subscribe and capabilities operations. Finally, a new client was developed gnoi_client, for test gNOI RPC operations.
573
573
574
-
Note: Although the GRPC protocol allows for many encodings and models to be used, our usage is restricted to JSON encoding.
574
+
Note: Although the gRPC protocol allows for many encodings to be used, our usage is restricted to JSON_IETF encoding.
575
575
576
576
Supported RPC Operations:
577
577
-------------------------
@@ -580,12 +580,13 @@ Supported RPC Operations:
580
580
+ Update: List of one or more objects to update
581
581
+ Replace: List of one or objects to replace existing objects, any unspecified fields wil be defaulted.
582
582
+ Delete: List of one or more object paths to delete
583
-
- Capabilities: Return gNMI version and list of supported models
583
+
- Capabilities: Return gNMI version and list of supported models and model versions.
584
+
+ A gNMI Extension field has been added as well to return the SONiC model "bundle version".
584
585
- Subscribe:
585
586
+ Subscribe to paths using either streaming or poll, or once based subscription, with either full current state or updated values only.
586
587
* Once: Get single subscription message.
587
588
* Poll: Get one subscription message for each poll request from the client.
588
-
* Stream: Get one subscription message for each object update, or at each sample interval if using sample mode. target_defined uses the values pre-configured for that particular object.
589
+
* Stream: Get one subscription message for each object update (called ON_CHANGE mode), or at each sample interval if using sample mode. target_defined uses the values pre-configured for that particular object. Not all paths support ON_CHANGE mode due to performance considerations, while all paths will support sample mode and therefore target defined as well since it will default to sample if ON_CHANGE is not supported.
0 commit comments