dsccommunity / dsccommunity/SqlServerDsc

SqlWindowsFirewall: Support user defined rule names

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

Nobody has claimed this yet.

enhancement help wanted
Dominant language
PowerShell
Stars
385
Forks
224
PR merge metrics
No merged PRs in 30d

Description

Details of the scenario you try and problem that is occurring:
To align with a companies naming convention, the rule names should not be static. User should be able to set the desired display names on the default rules.
This will also allow to localize the display names, see issue #322 .

This could work by adding optional Parameter that could be assigned a hash table of strings. If a strings key is found in the hash table that will be used. If not, the default rule Name will be used as Display Name. This will make it backward compatible. So I don't see this will become a breaking change.

The DSC configuration that is using the resource (as detailed as possible):
n/a

Version of the Operating System, SQL Server and PowerShell the DSC Target Node is running:
n/a

Version of the DSC module you're using, or 'dev' if you're using current dev branch:
Dev

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 by locating the SqlWindowsFirewall resource and its parameter definitions, then inspect how the default rule names become display names. Implement the optional string mapping with the existing names as fallback, and verify that both customized and unchanged configurations preserve the expected display names.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.