diff options
| author | Rafael F. Zalamena <rzalamena@opensourcerouting.org> | 2022-03-15 15:32:34 -0300 |
|---|---|---|
| committer | Rafael F. Zalamena <rzalamena@opensourcerouting.org> | 2022-03-15 15:32:34 -0300 |
| commit | 1c9bd416f4fb91abfed12a654fef802712e2db2e (patch) | |
| tree | cb61d75bcd802335944a631212397d45c483de26 | |
| parent | 54aeec5ef01a734756267924a7a6e4d36fa6d101 (diff) | |
doc: document yang show operational data
Add missing documentation for the command and describe the available
options.
Signed-off-by: Rafael F. Zalamena <rzalamena@opensourcerouting.org>
| -rw-r--r-- | doc/user/basic.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 4c196cfcfe..ea4b3f41f3 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -678,6 +678,20 @@ Terminal Mode Commands This command displays FRR's timer data for timers that will pop in the future. +.. clicmd:: show yang operational-data XPATH [{format <json|xml>|translate TRANSLATOR|with-config}] DAEMON + + Display the YANG operational data starting from XPATH. The default + format is JSON, but can be displayed in XML as well. + + Normally YANG operational data are located inside containers marked + as `read-only`. + + Optionally it is also possible to display configuration leaves in + addition to operational data with the option `with-config`. This + option enables the display of configuration leaves with their + currently configured value (if the leaf is optional it will only show + if it was created or has a default value). + .. _common-invocation-options: Common Invocation Options |