PowerShell Regex – Regular Expression

Introduction to PowerShell Regex – Regular Expression

Typical jobs for Regex are to match patterns in text, and to replace individual characters or even whole words.  It’s often when numbers mix with text that confusion occurs, and that’s when you need a PowerShell script to solve the problem.  For example, telephone numbers or bank sort codes can be tricky to process because they contain dashes, or a specific grouping of numbers.

Keep in mind that it’s rare that you would use regex in isolation; therefore, my examples are designed to master this one technique so that you can incorporate pattern recognition in a bigger script.

Topics for PowerShell Regex – Regular Expression

• Introducing PowerShell’s Regex
• PowerShell Regular Expression Examples Using Regex
• Basic Regex Punctuation
• Advanced Search Techniques
• PowerShell Regex Replace Text

 ♣

Introducing PowerShell’s Regex

It all started back in the days when DOS was king.  How we loved typing the wildcard * if we wanted to display all files.  What PowerShell’s regex does is refine ‘all’ so that you can filter a sub-set of data into the output.  It’s defining the subset that makes regex so potent, yet so difficult to control unless you are an expert in its logic and its syntax.

The problem for beginners is that regex has a bewildering array of whacky syntactic symbols.  As a newbie you may find that other people’s examples do not make sense, furthermore you realize that if you experiment, then one wrong character and the command will not produce the desired results.  My mission is to give you a grounding of the basic structure of regex, from there it will be over to you to employ regex to solve your particular problem.

Start with PowerShell Regex -Match
Before investigating Regex, it helps if you gain experience by testing comparison operators such as, -Match, -Like or -Contains.  Please note that my examples contain variables, while they aren’t strictly necessary, $Variables help me to identify different sections of the expression.

Expected PowerShell result:
True

Note 1:  In passing, The PowerShell $Matches variable is created automatically, I use it for troubleshooting unexpected results.

PowerShell Regular Expression Examples Using Regex

Regex::IsMatch() can be considered the same as -cmatch  (case sensitive match).  When developers work with regular expressions they prefer to work with Regex::IsMatch(), professionals say that this method is nearer the underlying PowerShell class System.Text.RegularExpressions.  However, Guy favours -Match or -cmatch as they are shorter and seem to produce exactly the same results.

The expected result is
True

In the above example [Regex] calls for the method IsMatch().  Then it’s up to us to supply two values, the input string ($Name) followed by a comma, and the pattern to match ("Alan").  While I have chosen to control the input via a $Variable, you could simplify the expression thus:

[Regex]::IsMatch("Alan Thomas 1949","Alan")

Guy Recommends:  A Free Trial of the Network Performance Monitor (NPM) v11.5

SolarWinds’ Network Performance Monitor will help you discover what’s happening on your network.  This utility will also guide you through troubleshooting; the dashboard will indicate whether the root cause is a broken link, faulty equipment or resource overload.

What I like best is the way NPM suggests solutions to network problems.  Its also has the ability to monitor the health of individual VMware virtual machines.  If you are interested in troubleshooting, and creating network maps, then I recommend that you try NPM now.

Download a free trial of Solarwinds’ Network Performance Monitor

Basic PowerShell Regex Punctuation

Quotes, or "speech marks" play a key role with Regex.  In PowerShell’s regular expression constructions it does not matter if you use single or double quotes.  The only difference between the example above and the example below is the type of quotes.  However, double quotes come into their own when the PowerShell expression contains a $variable that needs expanding; single quotes would treat the $variable as a literal.

The style of brackets is always significant in PowerShell.  IsMatch() requires the rounded parenthesis bracket.  Whereas a portion of the search string [a-z] needs a pair of square brackets.  If you see pattern matching code with {curly} brackets, they often refer to quantifiers, once again, follow the correct bracket syntax, or else you will get unexpected results.

Let us suppose we wanted to test the data for either the name Alan or Alun.  Here is a simple pattern matching example where the third letter can be either ‘a’ or ‘u’.  Another method would be to employ the period ‘.’, however that would require "Al.n", and not "Al[.]n".  Other uses of this technique are if you want to check for a number, for example [0-9].  In this case we use the dash to tell PowerShell to expect a contiguous range of all numbers from zero to nine.

Use of + At first, I could not see the point of incorporating the + symbol in regex expressions, but then I had a particular problem, some people spell their name Allan.  How could I cope with this double ll?  The answer was to insert a plus into the pattern, thus:

Summary, I now have a pattern that finds Alun, Alan and Allan.  Without the + it’s particularly difficult to find Allan as it contains 5 letters whereas Alan and Alun only have 4 letters.  + means 1-n matches (* means 0-n matches).  To see the power, and point of this symbol, try removing the plus.

Backslash has several roles in regex, firstly to introduce special characteristics such as anchors like \b (word boundary).  The backslash is also used to introduce literals, for example the period ‘.’ in the IP example below.  In terms of pattern matching, \ can also be used as a escape character, for example \s means whitespace and not the letter ‘s’. 

Here is an example which employs \d (decimal) to match the basic format of an IP address, however, it does not test for numbers bigger than 254.

\d tests for a number (as opposed to a letter), while these curly brackets {1,3} mean containing 1, 2, or 3 digits.

Guy Recommends: Free WMI Monitor for PowerShell

Windows Management Instrumentation (WMI) is one of the hidden treasures of Microsoft’s operating systems.  Fortunately, SolarWinds have created a Free WMI Monitor so that you can discover these gems of performance information, and thus improve your PowerShell scripts.

Take the guess work out of which WMI counters to use when scripting the operating system, Active Directory, or Exchange Server. Give this WMI monitor a try – it’s free.

Download your free copy of WMI Monitor

Matching the Beginning and End of Strings – Anchors

In many countries Thomas could be a first name or a surname, if we wanted to search for only a last name of "Thomas" then we would append the $, thus we need Thomas$.   Naturally, we have to assume that the surname would be at the very end of the data input.

To learn more about anchors, compare the above example with $Name = "Thomas Smith", or my original example, $Name = "Alan Thomas 1949"

Alternatively, if wanted to search specifically for a Christian name (first name) of Thomas, then we employ the ^ caret symbol.  For example, ^Thomas.

Other anchors include \b matches on word boundary, beginning or end of a word.

Advanced Search Techniques

Note: This example will only find one instance of ‘the’.  To make the search case insensitive try introduce (?i) before ‘the’, thus: $Pattern = "(?i)the".  As a result you should find two instances of ‘the’.

Alternative Match Techniques

The purpose is to check that you have a single block of text with no spaces.

The block [A-Za-z0-9] caters for upper [A-Z] and lower case [a-z] letter and numbers [0-9].

Guy Recommends: SolarWinds Engineer’s Toolset v10

This Engineer’s Toolset v10 provides a comprehensive console of 50 utilities for troubleshooting computer problems.  Guy says it helps me monitor what’s occurring on the network, and each tool teaches me more about how the underlying system operates.

There are so many good gadgets; it’s like having free rein of a sweetshop.  Thankfully the utilities are displayed logically: monitoring, network discovery, diagnostic, and Cisco tools.  Try the SolarWinds Engineer’s Toolset now!

Download your fully functional trial copy of the Engineer’s Toolset v10

PowerShell Regex Replace Text

The key command here is replace, as in [Regex]::replace.  Observe how replace has three arguments, the input text, the pattern to search for and finally, the pattern to replace.

Notice in passing that because we employ the double quotes PowerShell expands the variables $Pattern and $New.

Important: [Regex]::replace is case sensitive:
$Pattern = "Gray" won't work.

Review of PowerShell’s Regular Expressions

Regular expressions are different from DOS’s wildcards.  Even where they contain the same symbols as command-line syntax, PowerShell’s [Regex] doesn’t mean the same thing. They’re just similar enough to cause confusion.

Regular expressions are in a netherworld, while they aren’t easy, neither are they the hardest part of PowerShell.  With a little effort you can master [Regex

 Think of regular expressions as a programming language of their own.  One analogy I find useful is that of a foreign language, such as a French quotation inside an English text.  Thus don’t expect the rules from PowerShell to have any relation to [Regex], any more than you’d expect English grammar to apply inside that French quote.

PowerShell Resources

• At the PowerShell command line try:
  Get-Help about_Regular_Expression
  also
  Get-Help about_Wildcards 
• Cheat Sheet

More Examples of the PowerShell Regex Family

• Regex.Regex(String, RegexOptions) class constructor.
• Regex.Split(String, String, RegexOptions) method.
• Regex.IsMatch(String, String, RegexOptions) method.
• Regex.Match(String, String, RegexOptions) method.
• Regex.Matches(String, String, RegexOptions) method.
• Regex.Replace(String, String, String, RegexOptions) and also:
• Regex.Replace(String, String, MatchEvaluator, RegexOptions) methods.

Summary of Microsoft PowerShell Regex

Regex is bigger and better than the old DOS * wildcard.  The only problem is that the increased ability to control regular expressions brings greater complexity for the beginner.  As ever, my advice is to start slowly, choose a simple example and then build on success.  The key to mastering regex is to understand the syntax.

See more PowerShell examples for syntax advice

• PowerShell Syntax  • PowerShell Array  • PowerShell Array String Conversion  • Plist

• Get-Date  • PowerShell Quotes  • PowerShell variables  • RegEx  • PowerShell functions

• PowerShell Tutorials  • Conditional operators  • PowerShell Hashtable   • Windows PowerShell

Please email me if you have a better example script. Also please report any factual mistakes, grammatical errors or broken links, I will be happy to correct the fault.