Get-DbaRegServer - Name/ServerName Support Wildcards

[mattcargile]

Summarize Functionality

It would be convenient to write the below:

Get-DbaRegServer CMS -Name '*serv*', '*ws1'

instead of

Get-DbaRegServer CMS | Where-Object { $_.Name -like '*serv*' -or $_.Name -like '*ws1' }

Is there a command that is similiar or close to what you are looking for?

No

Technical Details

I've explored the web and found the [SupportsWildCards()] attribute which should alert the user to the new support in the help.

It didn't seem straightforward on how to implement. The current implementation uses -in and I guess to support an array of wildcards one would have to rewrite as a foreach or the like.

https://github.com/sqlcollaborative/dbatools/blob/73e3e8255778983718d9df05acb1d14d69f06af0/functions/Get-DbaRegServer.ps1#L202-L210

I also read through the Supporting Wildcard Expansion article which provided insight into System.Management.Automation.Wildcardpattern and System.Management.Automation.Wildcardoptions libraries. I assume these would provide native support for the descriptions in the Supporting Wildcard Characters in Cmdlet Parameters article. I'm not exactly sure how these would be implemented in the current build of the function.

[mattcargile]

So I think I was way over thinking the usage of the library. It could just be a

1. Check if more than One Count
2. If only one item, then do one -like operation
3. If more than one, then do a foreach across all the items with a -like
4. Add the Supports Wildcard deal.

[mattcargile]

So I've been looking at the Get- vs Find- commands and there seems to be a separation where you have to have the exact name of the object for get but find lets you use wildcards. Do we need a find-dbaregserver or can we use get-dbaregserver. I would really like to see all get commands accept wild cards.

[wsmelton]

You are either getting the one you want or all of them with Get verb. Find is where we allow wildcard filters.

[mattcargile]

You are either getting the one you want or all of them with Get verb. Find is where we allow wildcard filters.

Interesting, I do see the point logically and agree. From the core cmdlets in powershell perspective, most of them allow wild cards like get-service or get-process. And I would probably expect wildcards as a new user of dbatools from using powershell in general. So from that perspective, it could make more sense to have wildcards on all Get cmdlets. I know from an interactive perspective this would be much nicer. This is a greater question about all the get cmdlets though.

Would it make more sense in the context of dbatools to have a Find-DbaRegServer in this case since it appears we are following a stricter meaning to get versus find.

[wsmelton]

I would be fine with a Find command.

The other difference between Find and Get is object size returned. Find is generally a partial object with smaller list of properties included, which comes with more performance most of the time so it can in some cases return faster than the Get (just based on how it queries). If I'm only wanting to know the name and status of an object I'd look to use Find-ThatObject, versus if I need to all there is about it, Get-ThatObject.

[mattcargile]

I would be fine with a Find command.

The other difference between Find and Get is object size returned. Find is generally a partial object with smaller list of properties included, which comes with more performance most of the time so it can in some cases return faster than the Get (just based on how it queries). If I'm only wanting to know the name and status of an object I'd look to use Find-ThatObject, versus if I need to all there is about it, Get-ThatObject.

Yeah I like that more so from the definition of get-verb and what not even though core powershell doesn't always follow that. I feel like we should have a find for all the get commands?

[potatoqualitee]

@claude please add -Pattern support. this had a good ..pattern ;) #9897

[claude]

Claude finished @potatoqualitee's task —— View job • claude/issue-8043-20251106-2019 • Create PR ➔

---

Adding -Pattern Support to Get-DbaRegServer

I've successfully added -Pattern parameter support to Get-DbaRegServer based on the pattern from PR #9897 (Get-DbaDatabase).

Tasks Completed

• Read current Get-DbaRegServer.ps1 implementation
• Review pattern implementation from Get-DbaDatabase
• Add -Pattern parameter to the function
• Implement regex-based pattern matching logic
• Update parameter validation tests
• Add integration tests for pattern matching
• Commit and push changes
• Provide PR creation link

Implementation Summary

Changes to Get-DbaRegServer.ps1:

1. Added -Pattern parameter (string[]) that accepts regex patterns
2. Implemented helper scriptblock $matchesPattern that checks both Name and ServerName properties
3. Added filtering logic that applies regex matching when -Pattern is specified
4. Updated help documentation with parameter description and example

Changes to Get-DbaRegServer.Tests.ps1:

1. Updated parameter validation test to include "Pattern" parameter
2. Added integration test for pattern matching on Name property
3. Added integration test for pattern matching on ServerName property

Key Features:

• Supports regex patterns (not wildcards) as per dbatools style guide
• Matches against both Name and ServerName properties
• Supports multiple patterns via array (any match returns the server)
• Consistent with other dbatools commands like Get-DbaDatabase

Example Usage:

# Match servers starting with "prod"
Get-DbaRegServer -SqlInstance CMS -Pattern "^prod"

# Match servers ending with specific pattern
Get-DbaRegServer -SqlInstance CMS -Pattern "server1$"

# Multiple patterns
Get-DbaRegServer -SqlInstance CMS -Pattern "^prod", ".*-db$"

--- | Branch: claude/issue-8043-20251106-2019