cp.cache_file: add note re: return for nonexistant salt:// path

This commit is contained in:
Erik Johnson 2017-01-23 16:14:14 -06:00
parent ac8008d843
commit 2e443d79a3

View file

@ -419,6 +419,9 @@ def cache_file(path, saltenv='base', env=None):
salt '*' cp.cache_file salt://foo/bar.conf saltenv=config
salt '*' cp.cache_file salt://foo/bar.conf?saltenv=config
If the path being cached is a ``salt://`` URI, and the path does not exist,
then ``False`` will be returned.
.. note::
It may be necessary to quote the URL when using the querystring method,
depending on the shell being used to run the command.