Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

juniper modules/states docstring, parameter name fixes #57281

Merged
merged 20 commits into from
May 18, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
correct replace documententation
  • Loading branch information
vnitinv committed May 14, 2020
commit 270faef6e672104fd3f7809c66bf5a560e6e7138
27 changes: 14 additions & 13 deletions salt/modules/junos.py
Original file line number Diff line number Diff line change
Expand Up @@ -797,12 +797,13 @@ def install_config(path=None, **kwargs):

overwrite : False
Set to ``True`` if you want this file is to completely replace the
configuration file.
configuration file. Sets action to override

replace : False
Specify whether the configuration file uses ``replace:`` statements. If
``True``, only those statements under the ``replace`` tag will be
changed.
.. note:: This option cannot be used if **format** is "set".

merge : False
If set to ``True`` will set the load-config action to merge.
the default load-config action is 'replace' for xml/json/text config

format
Determines the format of the contents
Expand Down Expand Up @@ -909,6 +910,8 @@ def install_config(path=None, **kwargs):
template_format = "set"
elif path.endswith("xml"):
template_format = "xml"
elif path.endswith("json"):
template_format = "json"
else:
template_format = "text"

Expand Down Expand Up @@ -1302,18 +1305,13 @@ def load(path=None, **kwargs):

overwrite : False
Set to ``True`` if you want this file is to completely replace the
configuration file.
configuration file. Sets action to override

replace : False
Specify whether the configuration file uses ``replace:`` statements. If
``True``, only those statements under the ``replace`` tag will be
changed.
.. note:: This option cannot be used if **format** is "set".

merge : False
If set to ``True`` will set the load-config action to merge.

format
Determines the format of the contents
the default load-config action is 'replace' for xml/json/text config

update : False
Compare a complete loaded configuration against the candidate
Expand All @@ -1324,6 +1322,9 @@ def load(path=None, **kwargs):
affected by the changed configuration elements parse the new
configuration. This action is supported from PyEZ 2.1.

format
Determines the format of the contents

template_vars
Variables to be passed into the template processing engine in addition to
those present in pillar, the minion configuration, grains, etc. You may
Expand Down
26 changes: 15 additions & 11 deletions salt/states/junos.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,14 @@ def install_config(name, path, **kwargs):
execute.

overwrite : False
Set to ``True`` if you want this file is to completely replace the
configuration file.
Set to ``True`` if you want this file is to completely replace the
configuration file. Sets action to override

.. note:: This option cannot be used if **format** is "set".

replace : False
Specify whether the configuration file uses "replace:" statements. Only
those statements under the 'replace' tag will be changed.
merge : False
If set to ``True`` will set the load-config action to merge.
the default load-config action is 'replace' for xml/json/text config

comment
Provide a comment to the commit. (default = None)
Expand Down Expand Up @@ -502,14 +504,13 @@ def load(name, path, **kwargs):

overwrite : False
Set to ``True`` if you want this file is to completely replace the
configuration file.
configuration file. Sets action to override

replace : False
Specify whether the configuration file uses "replace:" statements.
Only those statements under the 'replace' tag will be changed.
.. note:: This option cannot be used if **format** is "set".

format:
Determines the format of the contents.
merge : False
If set to ``True`` will set the load-config action to merge.
the default load-config action is 'replace' for xml/json/text config

update : False
Compare a complete loaded configuration against the candidate
Expand All @@ -520,6 +521,9 @@ def load(name, path, **kwargs):
affected by the changed configuration elements parse the new
configuration. This action is supported from PyEZ 2.1 (default = False)

format
Determines the format of the contents.

template_vars
Variables to be passed into the template processing engine in addition
to those present in __pillar__, __opts__, __grains__, etc.
Expand Down