summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2020-07-02 18:00:49 -0500
committerJohn Estabrook <jestabro@vyos.io>2020-07-03 07:04:46 -0500
commit05aa25573027953c3578bdc2d0c6be0e46ac1a34 (patch)
tree8717d0f0e5fe2d2d9542ec51d98be3a9e4da8f5d
parent59bb297a37ae1cc42581fa078ef274ace20665a3 (diff)
downloadvyos-1x-05aa25573027953c3578bdc2d0c6be0e46ac1a34.tar.gz
vyos-1x-05aa25573027953c3578bdc2d0c6be0e46ac1a34.zip
config_dict: update docstring
-rw-r--r--python/vyos/config.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/python/vyos/config.py b/python/vyos/config.py
index 1aa8082dc..780b48a7b 100644
--- a/python/vyos/config.py
+++ b/python/vyos/config.py
@@ -289,8 +289,13 @@ class Config(object):
def get_config_dict(self, path=[], effective=False, key_mangling=None, get_first_key=False):
"""
- Args: path (str list): Configuration tree path, can be empty
- Returns: a dict representation of the config
+ Args:
+ path (str list): Configuration tree path, can be empty
+ effective=False: effective or session config
+ key_mangling=None: mangle dict keys according to regex and replacement
+ get_first_key=False: if k = path[:-1], return sub-dict d[k] instead of {k: d[k]}
+
+ Returns: a dict representation of the config under path
"""
config_dict = {}