Set-SmbPathAcl

Set-SmbPathAcl

Sets the ACL for the file system folder to match the ACL used by an SMB share.

Syntax

Parameter Set: Default
Set-SmbPathAcl [-ShareName] <String> [[-ScopeName] <String> ] [ <CommonParameters>]

Detailed Description

The Set-SmbPathAcl cmdlet sets the access control list (ACL) for the file system folder to match the ACL for the server message block (SMB) share. The cmdlet sets the ACL to match the SMB share itself. This action simplifies the configuration of NTFS or ReFS file system permissions by copying the SMB share permissions.

Parameters

-ScopeName<String>

Specifies the scope name of the SMB share. The cmdlet sets the ACL for the scope that you specify.

-ShareName<String>

Specifies the name of the SMB share. The cmdlet sets the ACL on the file system folder to the ACL used by the SMB share that you specify.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

• The previous syntax for the same task, ((Get-SmbShare –Name <ShareName> ).PresetPathACL | Set-Acl), continues to work with newer versions of the Windows Server operating system, but the new syntax is much simpler and therefore recommended.

Examples

Example 1: Set the SMB path ACL by share name

This command sets the ACL on the file system folder used by the Share01 share to match the ACL of the share.

PS C:\> Set-SmbPathAcl -ShareName "Share01"

Example 2: Set the SMB path ACL by share name and scope name

This command sets the ACL on the file system folder used by the Share01 share on the SOFS01 scope to match the ACL of the share.

PS C:\> Set-SmbPathAcl -ShareName "Share01" -ScopeName "SOFS01"