Manage the Windows System PATH
Note that not all Windows applications will rehash the PATH environment variable, Only the ones that listen to the WM_SETTINGCHANGE message http://support.microsoft.com/kb/104011
salt.modules.win_path.
__virtual__
()¶Load only on Windows
salt.modules.win_path.
add
(path, index=None, **kwargs)¶Add the directory to the SYSTEM path in the index location. Returns
True
if successful, otherwise False
.
True
, sends a
WM_SETTINGCHANGE broadcast to refresh the environment variables. Set
this to False
to skip this broadcast.CLI Examples:
# Will add to the beginning of the path
salt '*' win_path.add 'c:\python27' 0
# Will add to the end of the path
salt '*' win_path.add 'c:\python27' index='-1'
salt.modules.win_path.
exists
(path)¶Check if the directory is configured in the SYSTEM path Case-insensitive and ignores trailing backslash
Returns: | boolean True if path exists, False if not |
---|
CLI Example:
salt '*' win_path.exists 'c:\python27'
salt '*' win_path.exists 'c:\python27\'
salt '*' win_path.exists 'C:\pyThon27'
salt.modules.win_path.
get_path
()¶Returns a list of items in the SYSTEM path
CLI Example:
salt '*' win_path.get_path
salt.modules.win_path.
rehash
()¶Send a WM_SETTINGCHANGE Broadcast to Windows to refresh the Environment variables
CLI Example:
salt '*' win_path.rehash
salt.modules.win_path.
remove
(path, **kwargs)¶Remove the directory from the SYSTEM path
Returns: | boolean True if successful, False if unsuccessful |
---|
True
, sends a
WM_SETTINGCHANGE broadcast to refresh the environment variables. Set
this to False
to skip this broadcast.CLI Example:
# Will remove C:\Python27 from the path
salt '*' win_path.remove 'c:\\python27'
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2018.3.0