Skip to content

Commit 9fb5217

Browse files
committed
Add Capabilities, Get, Subscribe usage examples to README
1 parent d582257 commit 9fb5217

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ If a new `gnmi.proto` definition is released, use `update_protos.sh` to recompil
185185
./update_protos.sh
186186
```
187187

188-
### gnmicli Usage
188+
### gnmcli Usage
189189
The below details the current `gnmcli` usage options.
190190

191191
```
@@ -212,6 +212,11 @@ optional arguments:
212212
```
213213

214214
#### Capabilities
215+
This command will output the `CapabilitiesResponse` to `stdout`.
216+
```
217+
gnmcli capabilities 127.0.0.1:57500 -auto_ssl_target_override
218+
```
219+
215220
```
216221
gnmcli capabilities --help
217222
usage: gnmcli [-h] [-os {None,IOS XR,NX-OS,IOS XE}]
@@ -245,6 +250,11 @@ optional arguments:
245250
```
246251

247252
#### Get
253+
This command will output the `GetResponse` to `stdout`. `-xpath` may be specified multiple times to specify multiple `Path`s for the `GetRequest`.
254+
```
255+
gnmcli get 127.0.0.1:57500 -os "IOS XR" -xpath /interfaces/interface/state/counters -auto_ssl_target_override
256+
```
257+
248258
```
249259
gnmcli get --help
250260
usage: gnmcli [-h] [-xpath XPATH]
@@ -287,7 +297,11 @@ optional arguments:
287297
```
288298

289299
#### Subscribe
290-
Subscribe currently only supports a sampled stream. `ON_CHANGE` is possible but not implemented in the CLI, yet. :)
300+
This command will output the `SubscribeResponse` to `stdout` or `-dump_file`. `-xpath` may be specified multiple times to specify multiple `Path`s for the `GetRequest`. Subscribe currently only supports a sampled stream. `ON_CHANGE` is possible but not implemented in the CLI, yet. :)
301+
```
302+
gnmcli subscribe 127.0.0.1:57500 -os "IOS XR" -xpath /interfaces/interface/state/counters -auto_ssl_target_override
303+
```
304+
291305
```
292306
gnmcli subscribe --help
293307
usage: gnmcli [-h] [-xpath XPATH] [-interval INTERVAL] [-dump_file DUMP_FILE]
@@ -331,6 +345,7 @@ optional arguments:
331345
```
332346

333347
#### Set
348+
This command has not been validated.
334349
```
335350
gnmcli set --help
336351
usage: gnmcli [-h] [-update_json_config UPDATE_JSON_CONFIG]

0 commit comments

Comments
 (0)