dsccommunity / dsccommunity/ComputerManagementDsc
SmbShare - Add support for SMB Compression (CompressData)
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 338
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
Problem description
Windows Server 2022 supports enabling compression on SMB shares (https://learn.microsoft.com/en-us/windows-server/storage/file-server/smb-compression?tabs=powershell%2Crobocopy%2Cgroup-policy)
This needs to be enabled on SMB shares and would be helpful to control via the SmbShare module.
Verbose logs
N/A
DSC configuration
Configuration SmbShare_CreateShare_Config
{
Import-DscResource -ModuleName ComputerManagementDsc
Node localhost
{
SmbShare 'TempShare'
{
Name = 'Temp'
Path = 'C:\Temp'
CompressData = $true
}
}
}
Suggested solution
This is set via a new parameter in Set-SmbShare. It would be helpful if this could be enabled in DSC
https://learn.microsoft.com/en-us/powershell/module/smbshare/set-smbshare?view=windowsserver2022-ps
Operating system the target node is running
N/A
PowerShell version and build the target node is running
N/A
ComputerManagementDsc version
N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the SmbShare resource and read the Set-SmbShare documentation for the CompressData parameter. Confirm how the resource currently manages share settings, then verify that CompressData can be controlled through DSC and that the resulting share configuration matches the requested value.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- infrastructure
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100