Home > Articles > Programming > Windows Programming

How to Use Regular Expressions TODAY in Your Windows PowerShell Code

Do you need to learn all about regular expressions before using them with PowerShell? Nope. Timothy Warner, author of Sams Teach Yourself Windows PowerShell 5 in 24 Hours, doesn't waste time with boring backstory. Learn how to combine regex with your PowerShell code to jump right into performing search-and-replace operations, validation, and more.
Like this article? We recommend

If you're a Window systems administrator (and decidedly not a programmer), I would hazard a guess that your PowerShell adoption thus far has been a bit...slow. Am I correct?

Let me speed things up for you. I'll teach you in this article how to use regular expressions (regex for short, typically pronounced REJ-ex) in your PowerShell code to parse string data with laser-like efficiency.

Suppose you're tasked with one or more of the following real-world scenarios:

  • Finding personally identifiable information in a folder containing hundreds of files
  • Finding and replacing globally unique identifiers (GUIDs) in hundreds of server log files
  • Validating date formats and password strength in your company's intranet portal

The aforementioned tasks are trivial for .NET programmers: "I'll just use regex!" they say. However, if you're getting into PowerShell automation slowly, your blood might run cold at the thought of performing complicated pattern matches.

Don't stress! By the end of this article, you'll understand what regex actually does, and you'll learn how to implement regex patterns in PowerShell by using the -match operator, the -replace operator, and the Select-String cmdlet. Let's begin.

Regular Expression Basics

In a nutshell, regular expressions represent a rule set for performing pattern matching on string data. You're probably familiar with using the old MS-DOS wildcard characters. For instance, we can run the following command at the prompt to find all .xls or .xlsx files in the current folder whose names contain the word report:

C:\>dir *report*.xl?

In this example, the asterisk (*) represents zero or more characters, and the question mark (?) substitutes for any single character.

Open an administrative PowerShell console, and let's dive right in. We can use the -match operator to perform true/false tests against incoming string data. Doing so gives you valuable practice with both regex and PowerShell syntax.

The following tests should both evaluate to True. Can you see why?

'project14' -match 'pro'
'project14' -match '14'

Your first regular expressions lesson is that you can perform literal matches. The subject string project14 contains both pro and 14, so both expressions evaluate to True. Of course, this question arises: Does the match value include just the matching characters, or the entire string?

Windows PowerShell populates the $matches automatic array variable with the previous regex match result. Run the previous tests again, this time adding $matches after each. In the following code, I'm using the PowerShell command separator, the semicolon (;), to keep the example compact:

PS C:\> 'project14' -match 'pro' ; $Matches
True

Name                           Value
----                           -----
0                              pro

PS C:\> 'project14' -match '14' ; $Matches
True

Name                           Value
----                           -----
0                              14

Now let's say we have a bunch of files whose names start with the word project. Do you think the following expression will result in True or False?

'project14' -match 'project*'

If you tried the previous example, you know we'll get False here. Why? Your second regular expression lesson is that some regex metacharacters operate only on the preceding character, so 'project*' can be translated as "one or more occurrences of t." Yes, that's right. With regex, you need to construct your match patterns one character at a time.

While the asterisk matches one or more occurrences of the preceding character, the question mark actually behaves much like the MS-DOS question mark wildcard. Let's say we wanted to match project10 through project19:

'project14' -match 'project1?'

A metacharacter in regex is a character (or character combination) that's processed by the regex engine in a non-literal way.

Let's check out another metacharacter:

'8675309' -match '\d'

The \d metacharacter is called a character class, and it matches one or more instances of (you guessed it) the preceding character in the string. You can use quantifiers to match specific occurrences. Take a look:

'8675309' -match '\d{7}'

The $matches variable should show you the entire subject string (8675309) instead of only the number 8, because the {7} denotes seven repetitions of the digit match. The following table shows other examples of using the \d character class with the { } quantifier.

Example

Interpretation

'\d{1,3}'

Match between one and three times

'\d{5,}'

Match five or more times

Regex has many character classes, but I can't explain them all here. Instead, the following table gives you a "punchlist" of my favorites.

Character Class

Action

\w

Matches entire words

\b

Matches word boundaries

\s

Matches whitespace

One more regex concept before we do some "real world" examples: Put match ranges in square brackets ([ ]). The following expression should evaluate to True (be sure to inspect $matches as well):

'admin@company.com' -match '[a-z]+'

The match should have been 'admin' in this case. Yes, I sneaked in another metacharacter; in regex syntax, the plus (+) quantifier matches one or more instances of the preceding character. This is unlike the asterisk, which you'll recall matches zero or more instances of the preceding character. The range construct is awesome in regex, because your subject string might have variable length.

Using the -match Operator in the Real World

Let's say we need to parse a list of universal naming convention (UNC) paths in a text file named C:\input\servers.txt:

\\dc1\logs
\\mem2\documents
\\23ressvr\share1
\\sharepoint.company.pri\doclibe
\\server234\dfs1
\\server532\dfs2
\\server99\dfs5

We need to find out (a) whether server532 exists in the file; and, if so, (b) the name(s) of any shared folder(s) hosted by that server. How can we do this? Well, the first thing we need to do is grab all the servers.txt content and import the data into our PowerShell run space:

Get-Content -Path 'C:\input\servers.txt'

That's not enough, though. We need to filter that file content by using the Where-Object cmdlet, the -match operator, and a regex expression:

Get-Content -Path 'C:\input\servers.txt' | Where-Object { $_ -match '\\\\server532' }

You probably know that the $_ token is shorthand notation for the current object in the PowerShell pipeline. But doubtless you're wondering what \\\\ means. Get ready for regular expression lesson three: We need to escape certain characters to suppress the .NET regex engine from processing them as non-literals.

The UNC example is particularly confusing because the backslash (\) is the escape character, and we need to escape the two literal backslashes that precede any UNC path.

Let's try another example. This time, we want to match \\sharepoint.company.pri from servers.txt:

Get-Content -Path 'C:\input\servers.txt' | Where-Object { $_ -match '\\\\\w+\.\w+\.\w+' }

Whoa, Nelly! Now we're truly getting into the thick of things. Notice that I used the shorthand \w+ construction to match one or more occurrences of a word character. Because the period/dot (.) isn't a word character, I escape the two periods in the hostname sharepoint.company.pri. Cool, eh?

Introducing Select-String

For jobs when you need to dip into one or more files, find matches, and potentially make replacements, Select-String is what you need. Consider the following sample file named C:\input\customers.csv:

FirstName,LastName,SSN,Birthdate
Carey,Landry,123-45-6789,5/22/1981
Kayla,Duquette,344-55-5677,4/2/1970
Mike,Connor,543-21-9876,11/29/1955
Wendy,Robbins,987-32-4244,10/4/1968

First of all, the names and metadata in this example are entirely fictional. Second, notice that we have a comma and no intervening space separating each column entry (this file contains comma-separated values, after all).

Now imagine that instead of four records this database file has several thousand records. We're tasked with identifying every U.S. Social Security number (SSN) in the file. As you may know, the SSN has the following general format:

111-22-3333

We're keeping things extra-simple here; in the real world, you'll want to employ a regex expression that matches only valid SSNs. For instance, real SSNs don't start with 000 or 666.

I habitually use the Select-String -AllMatches switch parameter to gather all matches instead of only one match per line:

Select-String -Path 'C:\input\customers.csv' -Pattern '\d{3}\-\d{2}\-\d{4}' -AllMatches

input\customers.csv:2:Carey,Landry,123-45-6789,5/22/1981
input\customers.csv:3:Kayla,Duquette,344-55-5677,4/2/1970
input\customers.csv:4:Mike,Connor,543-21-9876,11/29/1955
input\customers.csv:5:Wendy,Robbins,987-32-4244,10/4/1968

Notice that the result set gives us the line number where each match took place. Let's finish up by redacting each exposed Social Security number with the string pattern XXX-XX-XXXX:

Select-String -Path 'C:\input\customers.csv' -Pattern '\d{3}\-\d{2}\-\d{4}'
-AllMatches | ForEach { $_ -replace '\d{3}\-\d{2}\-\d{4}', 'XXX-XX-XXXX' } C:\input\customers.csv:2:Carey,Landry,XXX-XX-XXXX,5/22/1981 C:\input\customers.csv:3:Kayla,Duquette,XXX-XX-XXXX,4/2/1970 C:\input\customers.csv:4:Mike,Connor,XXX-XX-XXXX,11/29/1955 C:\input\customers.csv:5:Wendy,Robbins,XXX-XX-XXXX,10/4/1968

I used the ForEach construct to loop through the dataset and the -replace operator to replace the SSN matches with our redaction string. The results look good, but if you open the source file, you won't see the letter X everywhere. What's up?

Well, Select-String writes MatchInfo objects to the pipeline. In order to replace the source string data, we need to operate on that source string data.

My proposed solution is to use Get-Content to "vacuum" the customers.csv text into our run space, perform the match/replace, and then export the final result set to a new file. Try the following:

$file = 'C:\input\customers.csv'
$content = Get-Content $file
$content | ForEach-Object {$_ -Replace '\d{3}\-\d{2}\-\d{4}', 'XXX-XX-XXXX' } | Set-Content $file

Here's what each line does:

  1. Store the .csv file path string as the variable $file.
  2. Create a second variable named $content that actually contains the .csv file contents.
  3. Perform the replacement using our regex expression, and write the result set back to the file with Set-Content. Done and done!
Get-Content -Path 'C:\input\customers.csv'

FirstName,LastName,SSN,Birthdate
Carey,Landry,XXX-XX-XXXX,5/22/1981
Kayla,Duquette,XXX-XX-XXXX,4/2/1970
Mike,Connor,XXX-XX-XXXX,11/29/1955
Wendy,Robbins,XXX-XX-XXXX,10/4/1968

Next Steps

Clearly, using regular expressions is an enormous subject. I'm going to leave you with a laundry list of useful resources. Enjoy!

Some online regex testers that I like:

Some neat online regex tutorials:

Some Windows regex applications that can make learning and using regex easier:

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020