You are viewing docs from the master branch, some of these features are not yet released.

salt.modules.win_file¶

Manage information about files on the minion, set/read user, group data, modify the ACL of files/directories

depends:

win32api
win32file
win32con
salt.utils.win_dacl

salt.modules.win_file.check_perms(path, ret=None, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)¶

Check owner and permissions for the passed directory. This function checks the permissions and sets them, returning the changes made. Used by the file state to populate the return dict

Parameters:

path (str) -- The full path to the directory.
ret (dict) -- A dictionary to append changes to and return. If not passed, will create a new dictionary to return.
owner (str) -- The owner to set for the directory.
grant_perms (dict) -- A dictionary containing the user/group and the basic permissions to check/grant, ie: {'user': {'perms': 'basic_permission'}}. Default is None.
deny_perms (dict) -- A dictionary containing the user/group and permissions to check/deny. Default is None.
inheritance (bool) -- True will check if inheritance is enabled and enable it. ``False will check if inheritance is disabled and disable it. Default is True.
reset (bool) -- True will show what permissions will be removed by resetting the DACL. False will do nothing. Default is False.

Returns:

A dictionary of changes that have been made

Return type:

dict

CLI Example:

# To see changes to ``C:\Temp`` if the 'Users' group is given 'read & execute' permissions.
salt '*' file.check_perms C:\Temp\ {} Administrators "{'Users': {'perms': 'read_execute'}}"

# Locally using salt call
salt-call file.check_perms C:\Temp\ {} Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}"

# Specify advanced attributes with a list
salt '*' file.check_perms C:\Temp\ {} Administrators "{'jsnuffy': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'files_only'}}"

salt.modules.win_file.chgrp(path, group)¶

Change the group of a file

Under Windows, this will do nothing.

While a file in Windows does have a 'primary group', this rarely used attribute generally has no bearing on permissions unless intentionally configured and is only used to support Unix compatibility features (e.g. Services For Unix, NFS services).

Salt, therefore, remaps this function to do nothing while still being compatible with Unix behavior. When managing Windows systems, this function is superfluous and will generate an info level log entry if used directly.

If you do actually want to set the 'primary group' of a file, use file .chpgrp.

To set group permissions use file.set_perms

Parameters:

path (str) -- The path to the file or directory
group (str) -- The group (unused)

Returns:

None

CLI Example:

salt '*' file.chgrp c:\temp\test.txt administrators

salt.modules.win_file.chown(path, user, group=None, pgroup=None, follow_symlinks=True)¶

Chown a file, pass the file the desired user and group

Under Windows, the group parameter will be ignored.

This is because while files in Windows do have a 'primary group' property, this is rarely used. It generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services).

If you do want to change the 'primary group' property and understand the implications, pass the Windows only parameter, pgroup, instead.

Parameters:

path (str) -- The path to the file or directory
user (str) -- The name of the user to own the file
group (str) -- The group (not used)
pgroup (str) -- The primary group to assign
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

True if successful, otherwise error

Return type:

bool

CLI Example:

salt '*' file.chown c:\temp\test.txt myusername
salt '*' file.chown c:\temp\test.txt myusername pgroup=Administrators
salt '*' file.chown c:\temp\test.txt myusername "pgroup='None'"

salt.modules.win_file.chpgrp(path, group)¶

Change the group of a file

Under Windows, this will set the rarely used primary group of a file. This generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services).

Ensure you know what you are doing before using this function.

Parameters:

path (str) -- The path to the file or directory
pgroup (str) -- The primary group to assign

Returns:

True if successful, otherwise error

Return type:

bool

CLI Example:

salt '*' file.chpgrp c:\temp\test.txt Administrators
salt '*' file.chpgrp c:\temp\test.txt "'None'"

salt.modules.win_file.get_attributes(path)¶

Return a dictionary object with the Windows file attributes for a file.

Parameters:: path (str) -- The path to the file or directory
Returns:: A dictionary of file attributes
Return type:: dict

CLI Example:

salt '*' file.get_attributes c:\temp\a.txt

salt.modules.win_file.get_gid(path, follow_symlinks=True)¶

Return the id of the group that owns a given file

Under Windows, this will return the uid of the file.

Salt, therefore, remaps this function to provide functionality that somewhat resembles Unix behavior for API compatibility reasons. When managing Windows systems, this function is superfluous and will generate an info level log entry if used directly.

If you do actually want to access the 'primary group' of a file, use file.get_pgid.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The gid of the owner

Return type:

str

CLI Example:

salt '*' file.get_gid c:\temp\test.txt

salt.modules.win_file.get_group(path, follow_symlinks=True)¶

Return the group that owns a given file

Under Windows, this will return the user (owner) of the file.

If you do actually want to access the 'primary group' of a file, use file.get_pgroup.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The name of the owner

Return type:

str

CLI Example:

salt '*' file.get_group c:\temp\test.txt

salt.modules.win_file.get_mode(path)¶

Return the mode of a file

Right now we're just returning None because Windows' doesn't have a mode like Linux

Parameters:: path (str) -- The path to the file or directory
Returns:: None

CLI Example:

salt '*' file.get_mode /etc/passwd

salt.modules.win_file.get_pgid(path, follow_symlinks=True)¶

Return the id of the primary group that owns a given file (Windows only)

This function will return the rarely used primary group of a file. This generally has no bearing on permissions unless intentionally configured and is most commonly used to provide Unix compatibility (e.g. Services For Unix, NFS services).

Ensure you know what you are doing before using this function.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The gid of the primary group

Return type:

str

CLI Example:

salt '*' file.get_pgid c:\temp\test.txt

salt.modules.win_file.get_pgroup(path, follow_symlinks=True)¶

Return the name of the primary group that owns a given file (Windows only)

Ensure you know what you are doing before using this function.

The return value may be 'None', e.g. if the user is not on a domain. This is a valid group - do not confuse this with the Salt/Python value of None which means no value was returned. To be certain, use the get_pgid function which will return the SID, including for the system 'None' group.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The name of the primary group

Return type:

str

CLI Example:

salt '*' file.get_pgroup c:\temp\test.txt

salt.modules.win_file.get_uid(path, follow_symlinks=True)¶

Return the id of the user that owns a given file

Symlinks are followed by default to mimic Unix behavior. Specify follow_symlinks=False to turn off this behavior.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The uid of the owner

Return type:

str

CLI Example:

salt '*' file.get_uid c:\temp\test.txt
salt '*' file.get_uid c:\temp\test.txt follow_symlinks=False

salt.modules.win_file.get_user(path, follow_symlinks=True)¶

Return the user that owns a given file

Symlinks are followed by default to mimic Unix behavior. Specify follow_symlinks=False to turn off this behavior.

Parameters:

path (str) -- The path to the file or directory
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

The name of the owner

Return type:

str

CLI Example:

salt '*' file.get_user c:\temp\test.txt
salt '*' file.get_user c:\temp\test.txt follow_symlinks=False

salt.modules.win_file.gid_to_group(gid)¶

Convert the group id to the group name on this system

Under Windows, because groups are just another ACL entity, this function behaves the same as uid_to_user.

For maintaining Windows systems, this function is superfluous and only exists for API compatibility with Unix. Use the uid_to_user function instead; an info level log entry will be generated if this function is used directly.

Parameters:: gid (str) -- The gid of the group
Returns:: The name of the group
Return type:: str

CLI Example:

salt '*' file.gid_to_group S-1-5-21-626487655-2533044672-482107328-1010

salt.modules.win_file.group_to_gid(group)¶

Convert the group to the gid on this system

Under Windows, because groups are just another ACL entity, this function behaves the same as user_to_uid, except if None is given, '' is returned.

For maintaining Windows systems, this function is superfluous and only exists for API compatibility with Unix. Use the user_to_uid function instead; an info level log entry will be generated if this function is used directly.

Parameters:: group (str) -- The name of the group
Returns:: The gid of the group
Return type:: str

CLI Example:

salt '*' file.group_to_gid administrators

salt.modules.win_file.is_link(path)¶

Check if the path is a symlink

This is only supported on Windows Vista or later.

Inline with Unix behavior, this function will raise an error if the path is not a symlink, however, the error raised will be a SaltInvocationError, not an OSError.

Parameters:: path (str) -- The path to a file or directory
Returns:: True if path is a symlink, otherwise False
Return type:: bool

CLI Example:

salt '*' file.is_link /path/to/link

salt.modules.win_file.lchown(path, user, group=None, pgroup=None)¶

Chown a file, pass the file the desired user and group without following any symlinks.

Under Windows, the group parameter will be ignored.

If you do want to change the 'primary group' property and understand the implications, pass the Windows only parameter, pgroup, instead.

To set the primary group to 'None', it must be specified in quotes. Otherwise Salt will interpret it as the Python value of None and no primary group changes will occur. See the example below.

Parameters:

path (str) -- The path to the file or directory
user (str) -- The name of the user to own the file
group (str) -- The group (not used)
pgroup (str) -- The primary group to assign

Returns:

True if successful, otherwise error

Return type:

bool

CLI Example:

salt '*' file.lchown c:\temp\test.txt myusername
salt '*' file.lchown c:\temp\test.txt myusername pgroup=Administrators
salt '*' file.lchown c:\temp\test.txt myusername "pgroup='None'"

salt.modules.win_file.makedirs_(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)¶

Ensure that the parent directory containing this path is available.

Parameters:

path (str) --
The full path to the directory.

Note

The path must end with a trailing slash otherwise the directory(s) will be created up to the parent directory. For example if path is C:\temp\test, then it would be treated as C:\temp\ but if the path ends with a trailing slash like C:\temp\test\, then it would be treated as C:\temp\test\.
owner (str) -- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM.
grant_perms (dict) --
A dictionary containing the user/group and the basic permissions to grant, ie: {'user': {'perms': 'basic_permission'}}. You can also set the applies_to setting here. The default is this_folder_subfolders_files. Specify another applies_to setting like this:
```
{'user': {'perms': 'full_control', 'applies_to': 'this_folder'}}
```
To set advanced permissions use a list for the perms parameter, ie:
```
{'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}}
```
deny_perms (dict) -- A dictionary containing the user/group and permissions to deny along with the applies_to setting. Use the same format used for the grant_perms parameter. Remember, deny permissions supersede grant permissions.
inheritance (bool) -- If True the object will inherit permissions from the parent, if False, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created.
reset (bool) --
If True the existing DACL will be cleared and replaced with the settings defined in this function. If False, new entries will be appended to the existing DACL. Default is False.

New in version 2018.3.0.

Returns:

True if successful

Return type:

bool

Raises:

CommandExecutionError -- If unsuccessful

CLI Example:

# To grant the 'Users' group 'read & execute' permissions.
salt '*' file.makedirs C:\Temp\ Administrators "{'Users': {'perms': 'read_execute'}}"

# Locally using salt call
salt-call file.makedirs C:\Temp\ Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}"

# Specify advanced attributes with a list
salt '*' file.makedirs C:\Temp\ Administrators "{'jsnuffy': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder_only'}}"

salt.modules.win_file.makedirs_perms(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=True)¶

Set owner and permissions for each directory created.

Parameters:

path (str) -- The full path to the directory.
owner (str) -- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM.
grant_perms (dict) --
A dictionary containing the user/group and the basic permissions to grant, ie: {'user': {'perms': 'basic_permission'}}. You can also set the applies_to setting here. The default is this_folder_subfolders_files. Specify another applies_to setting like this:
```
{'user': {'perms': 'full_control', 'applies_to': 'this_folder'}}
```
To set advanced permissions use a list for the perms parameter, ie:
```
{'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}}
```
deny_perms (dict) -- A dictionary containing the user/group and permissions to deny along with the applies_to setting. Use the same format used for the grant_perms parameter. Remember, deny permissions supersede grant permissions.
inheritance (bool) -- If True the object will inherit permissions from the parent, if False, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created
reset (bool) --
If True the existing DACL will be cleared and replaced with the settings defined in this function. If False, new entries will be appended to the existing DACL. Default is False.

New in version 2018.3.0.

Returns:

True if successful, otherwise raises an error

Return type:

bool

CLI Example:

# To grant the 'Users' group 'read & execute' permissions.
salt '*' file.makedirs_perms C:\Temp\ Administrators "{'Users': {'perms': 'read_execute'}}"

# Locally using salt call
salt-call file.makedirs_perms C:\Temp\ Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}"

# Specify advanced attributes with a list
salt '*' file.makedirs_perms C:\Temp\ Administrators "{'jsnuffy': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder_files'}}"

salt.modules.win_file.mkdir(path, owner=None, grant_perms=None, deny_perms=None, inheritance=True, reset=False)¶

Ensure that the directory is available and permissions are set.

Parameters:

path (str) -- The full path to the directory.
owner (str) -- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM
grant_perms (dict) --
A dictionary containing the user/group and the basic permissions to grant, ie: {'user': {'perms': 'basic_permission'}}. You can also set the applies_to setting here. The default is this_folder_subfolders_files. Specify another applies_to setting like this:
```
{'user': {'perms': 'full_control', 'applies_to': 'this_folder'}}
```
To set advanced permissions use a list for the perms parameter, ie:
```
{'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}}
```
deny_perms (dict) -- A dictionary containing the user/group and permissions to deny along with the applies_to setting. Use the same format used for the grant_perms parameter. Remember, deny permissions supersede grant permissions.
inheritance (bool) -- If True the object will inherit permissions from the parent, if False, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created.
reset (bool) --
If True the existing DACL will be cleared and replaced with the settings defined in this function. If False, new entries will be appended to the existing DACL. Default is False.

New in version 2018.3.0.

Returns:

True if successful

Return type:

bool

Raises:

CommandExecutionError -- If unsuccessful

CLI Example:

# To grant the 'Users' group 'read & execute' permissions.
salt '*' file.mkdir C:\Temp\ Administrators "{'Users': {'perms': 'read_execute'}}"

# Locally using salt call
salt-call file.mkdir C:\Temp\ Administrators "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}"

# Specify advanced attributes with a list
salt '*' file.mkdir C:\Temp\ Administrators "{'jsnuffy': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder_only'}}"

salt.modules.win_file.remove(path, force=False)¶

Remove the named file or directory

Parameters:

path (str) -- The path to the file or directory to remove.
force (bool) -- Remove even if marked Read-Only. Default is False

Returns:

True if successful, False if unsuccessful

Return type:

bool

CLI Example:

salt '*' file.remove C:\Temp

salt.modules.win_file.set_attributes(path, archive=None, hidden=None, normal=None, notIndexed=None, readonly=None, system=None, temporary=None)¶

Set file attributes for a file. Note that the normal attribute means that all others are false. So setting it will clear all others.

Parameters:

path (str) -- The path to the file or directory
archive (bool) -- Sets the archive attribute. Default is None
hidden (bool) -- Sets the hidden attribute. Default is None
normal (bool) -- Resets the file attributes. Cannot be used in conjunction with any other attribute. Default is None
notIndexed (bool) -- Sets the indexed attribute. Default is None
readonly (bool) -- Sets the readonly attribute. Default is None
system (bool) -- Sets the system attribute. Default is None
temporary (bool) -- Sets the temporary attribute. Default is None

Returns:

True if successful, otherwise False

Return type:

bool

CLI Example:

salt '*' file.set_attributes c:\temp\a.txt normal=True
salt '*' file.set_attributes c:\temp\a.txt readonly=True hidden=True

salt.modules.win_file.set_mode(path, mode)¶

Set the mode of a file

This just calls get_mode, which returns None because we don't use mode on Windows

Parameters:

path -- The path to the file or directory
mode -- The mode (not used)

Returns:

None

CLI Example:

salt '*' file.set_mode /etc/passwd 0644

salt.modules.win_file.set_perms(path, grant_perms=None, deny_perms=None, inheritance=True, reset=False)¶

Set permissions for the given path

Parameters:

path (str) -- The full path to the directory.
grant_perms (dict) --
A dictionary containing the user/group and the basic permissions to grant, ie: {'user': {'perms': 'basic_permission'}}. You can also set the applies_to setting here for directories. The default for applies_to is this_folder_subfolders_files. Specify another applies_to setting like this:
```
{'user': {'perms': 'full_control', 'applies_to': 'this_folder'}}
```
To set advanced permissions use a list for the perms parameter, ie:
```
{'user': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder'}}
```
To see a list of available attributes and applies to settings see the documentation for salt.utils.win_dacl.

A value of None will make no changes to the grant portion of the DACL. Default is None.
deny_perms (dict) --
A dictionary containing the user/group and permissions to deny along with the applies_to setting. Use the same format used for the grant_perms parameter. Remember, deny permissions supersede grant permissions.

A value of None will make no changes to the deny portion of the DACL. Default is None.
inheritance (bool) -- If True the object will inherit permissions from the parent, if False, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. Default is False.
reset (bool) --
If True the existing DCL will be cleared and replaced with the settings defined in this function. If False, new entries will be appended to the existing DACL. Default is False.

New in version 2018.3.0.

Returns:

True if successful

Return type:

bool

Raises:

CommandExecutionError -- If unsuccessful

CLI Example:

# To grant the 'Users' group 'read & execute' permissions.
salt '*' file.set_perms C:\Temp\ "{'Users': {'perms': 'read_execute'}}"

# Locally using salt call
salt-call file.set_perms C:\Temp\ "{'Users': {'perms': 'read_execute', 'applies_to': 'this_folder_only'}}"

# Specify advanced attributes with a list
salt '*' file.set_perms C:\Temp\ "{'jsnuffy': {'perms': ['read_attributes', 'read_ea'], 'applies_to': 'this_folder_only'}}"

salt.modules.win_file.stats(path, hash_type='sha256', follow_symlinks=True)¶

Return a dict containing the stats about a given file

Under Windows, gid will equal uid and group will equal user.

Salt, therefore, remaps these properties to keep some kind of compatibility with Unix behavior. If the 'primary group' is required, it can be accessed in the pgroup and pgid properties.

Parameters:

path (str) -- The path to the file or directory
hash_type (str) -- The type of hash to return
follow_symlinks (bool) -- If the object specified by path is a symlink, get attributes of the linked file instead of the symlink itself. Default is True

Returns:

A dictionary of file/directory stats

Return type:

dict

CLI Example:

salt '*' file.stats /etc/passwd

salt.modules.win_file.symlink(src, link, force=False, atomic=False, follow_symlinks=True)¶

Create a symbolic link to a file

This is only supported with Windows Vista or later and must be executed by a user with the SeCreateSymbolicLink privilege.

The behavior of this function matches the Unix equivalent, with one exception - invalid symlinks cannot be created. The source path must exist. If it doesn't, an error will be raised.

Parameters:

src (str) -- The path to a file or directory
link (str) -- The path to the link. Must be an absolute path
force (bool) -- Overwrite an existing symlink with the same name .. versionadded:: 3005
atomic (bool) -- Use atomic file operations to create the symlink .. versionadded:: 3006.0
follow_symlinks (bool) -- If set to False, use os.path.lexists() for existence checks instead of os.path.exists(). .. versionadded:: 3007.0

Returns:

True if successful, otherwise raises CommandExecutionError

Return type:

bool

CLI Example:

salt '*' file.symlink /path/to/file /path/to/link

salt.modules.win_file.uid_to_user(uid)¶

Convert a uid to a user name

Parameters:: uid (str) -- The user id to lookup
Returns:: The name of the user
Return type:: str

CLI Example:

salt '*' file.uid_to_user S-1-5-21-626487655-2533044672-482107328-1010

salt.modules.win_file.user_to_uid(user)¶

Convert user name to a uid

Parameters:: user (str) -- The user to lookup
Returns:: The user id of the user
Return type:: str

CLI Example:

salt '*' file.user_to_uid myusername

salt.modules.win_file.version(path)¶

New in version 3005.

Get the version of a file.

Note

Not all files have version information. The following are common file types that contain version information:

.exe

.dll

.sys

Parameters:

path (str) -- The path to the file.

Returns:

The version of the file if the file contains it. Otherwise, an: empty string will be returned.

Return type:

str

Raises:

CommandExecutionError -- If the file does not exist
CommandExecutionError -- If the path is not a file

CLI Example:

salt * file.version C:\Windows\notepad.exe

salt.modules.win_file.version_details(path)¶

New in version 3005.

Get file details for a file. Similar to what's in the details tab on the file properties.

Note

Not all files have version information. The following are common file types that contain version information:

.exe

.dll

.sys

Parameters:

path (str) -- The path to the file.

Returns:

A dictionary containing details about the file related to version.: An empty dictionary if the file contains no version information.

Return type:

dict

Raises:

CommandExecutionError -- If the file does not exist
CommandExecutionError -- If the path is not a file

CLI Example:

salt * file.version_details C:\Windows\notepad.exe

Generated on October 23, 2024 at 09:06:04 UTC.

You are viewing docs built from a recent snapshot of the master branch. Switch to docs for the latest stable release, 3007.1.

saltproject.io