Set‑SmbShareSecurityDescriptor

SYNOPSIS

Sets the DACL security descriptor on local SMB shares.

SYNTAX

Set-SmbShareSecurityDescriptor [-Name] <Object[]> -Sddl <String> [-ThrottleLimit <Int32>] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Parses SDDL as data, rejects null DACLs, and persists only the access section to ordinary local SMB shares while preserving other sections.

EXAMPLES

EXAMPLE 1

Set-SmbShareSecurityDescriptor -Name 'Data$' -Sddl 'D:(A;;FA;;;BA)' -WhatIf

Previews replacing only the share DACL.

PARAMETERS

-Name

One or more unqualified local SMB share names.

Type: Object[]
Parameter Sets: (All)
Aliases: ShareName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-PassThru

Returns the stored share DACL descriptor after persistence.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Sddl

A structurally valid SDDL document containing a non-null DACL.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

Limits concurrently processed canonical share targets from 1 through 64.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [Math]::Max(1, [Math]::Min(8, [Environment]::ProcessorCount))
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

None

WindowsAccessControl.SmbShareSecurityDescriptor

NOTES

RELATED LINKS