diff options
Diffstat (limited to 'doc/network.rst')
| -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)`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |