diff options
| author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-11-20 10:54:27 -0600 |
|---|---|---|
| committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-11-20 10:54:27 -0600 |
| commit | 0fb6a466f8fd7a292bb840245da1c13ea1cbe836 (patch) | |
| tree | 0f90d58c56c776fdd16fcea6ca40dd35e27f09cd /doc | |
| parent | b3003c63562cc5e45c59ff4278da11815474910f (diff) | |
| download | netconfapk-0fb6a466f8fd7a292bb840245da1c13ea1cbe836.tar.gz netconfapk-0fb6a466f8fd7a292bb840245da1c13ea1cbe836.tar.bz2 netconfapk-0fb6a466f8fd7a292bb840245da1c13ea1cbe836.tar.xz netconfapk-0fb6a466f8fd7a292bb840245da1c13ea1cbe836.zip | |
NMSA: Add ability to read 'live' values
This allows us to have a true picture of the system for the
operational datastore, separate from the config datastore.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/network.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/network.rst b/doc/network.rst index 37c67b7..7291249 100644 --- a/doc/network.rst +++ b/doc/network.rst @@ -179,7 +179,7 @@ Parameters ---------- For manipulating parameters in the section `Data model definition`_, -three methods exist. +four methods exist. ``get_param(iface, parameter)`` @@ -189,6 +189,16 @@ Retrieve the parameter for the specified interface. If the parameter is not set for the specified interface, ``None`` will be returned. +``curr_param(iface, parameter)`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Retrieve the current, live value for the parameter for the specified +interface. If the parameter is not set for the specified interface, +``None`` will be returned. The value returned from ``curr_param`` may +differ from ``get_param`` if a network administrator has changed the +value externally, or if the system configuration store is malfunctioning. + + ``set_param(iface, parameter, value)`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |