dsccommunity / dsccommunity/ComputerManagementDsc

SmbShare - Add support for SMB Compression (CompressData)

Open
#430 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.