summaryrefslogtreecommitdiff
path: root/python/vyos/configdict.py
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-08-20 17:06:05 +0200
committerChristian Poessinger <christian@poessinger.com>2021-08-22 09:53:50 +0200
commitf8ff929eb3b9b79fbb88f72dfe5471fe34252c2c (patch)
tree15727dddc079cbc555c8f5cc553d87f982bb8aba /python/vyos/configdict.py
parent667d83017590ef74590587d002c8775a0acfdd4f (diff)
downloadvyos-1x-f8ff929eb3b9b79fbb88f72dfe5471fe34252c2c.tar.gz
vyos-1x-f8ff929eb3b9b79fbb88f72dfe5471fe34252c2c.zip
vyos.configdict: add note when using leaf_node_changed()
(cherry picked from commit 9c97bd1b0214e102ac36eae8b2c3c9ff672a0bf3)
Diffstat (limited to 'python/vyos/configdict.py')
-rw-r--r--python/vyos/configdict.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/python/vyos/configdict.py b/python/vyos/configdict.py
index dba992d56..a1a6c5933 100644
--- a/python/vyos/configdict.py
+++ b/python/vyos/configdict.py
@@ -108,7 +108,9 @@ def leaf_node_changed(conf, path):
"""
Check if a leaf node was altered. If it has been altered - values has been
changed, or it was added/removed, we will return a list containing the old
- value(s). If nothing has been changed, None is returned
+ value(s). If nothing has been changed, None is returned.
+
+ NOTE: path must use the real CLI node name (e.g. with a hyphen!)
"""
from vyos.configdiff import get_config_diff
D = get_config_diff(conf, key_mangling=('-', '_'))