Home > Articles > Programming > Windows Programming

Quick and Efficient PowerShell Script Debugging with Breakpoints

Writing a perfect PowerShell script on the first try is next to impossible (though it's nice to dream). Debugging is a crucial skill for every developer, and learning easier and faster ways to find script problems can really improve the process. Adam Bertram explains how to use breakpoints to troubleshoot your PowerShell scripts.
Like this article? We recommend

You've created a complex PowerShell script, executed it, and it works great in your test environment. Yay! Then a couple days go by and you try your great new script in production—and it bombs miserably in five different places. Not so yay. What went wrong? What's different in your test environment versus your production environment? Why is this beautiful script of yours failing?

Questions, questions, questions. It's time to get down to debugging.

As a start to tracking down problems in your script, PowerShell provides several debugging features. One feature is breakpoints, which have been around for a very long time, and are not new to PowerShell. In simplest terms, a breakpoint is a spot in your script that, when executed, will break (pause) the script's execution. When a PowerShell script hits a breakpoint, it will pause execution and wait for input.

Depending on how the breakpoint was created, you get the option to poke around in your script's current running environment. You can discover the progress of the script up to the breakpoint, review the history of functions called, and a lot more. Breakpoints are an excellent way to peek inside a script at a certain point in time to see what's happening.

Breakpoints can be created in PowerShell in one of two ways: by using the Write-Debug cmdlet, or by using the Set-PsBreakPoint cmdlet. Let's examine how these methods work.

Using Write-Debug to Insert Breakpoints

Of the two methods, Write-Debug is the little brother to Set-PsBreakpoint. It is limited in scope and use, but it pauses a PowerShell script and provides some methods to see what might have gone wrong with the script.

Write-Debug requires a few flags to be set:

  • The script or function must be "advanced," which means you must include the [CmdletBinding()] keyword. If this keyword is not included, any Write-Debug lines you may use will simply be ignored.
  • The $DebugPreference automatic variable must be set to Inquire, or the -Debug parameter must be passed to the script or function.

Let's look at an example. I've built a script, shown in Figure 1, that creates a few fictional users. Before each user is created, the script has a Write-Debug line that sets a breakpoint, so I can confirm that I actually want to create the users. Notice the required [CmdletBinding()] keyword at the top of the figure.

Figure 1 Using [CmdletBinding()] and Write-Debug.

If I run this script, I get no output at all. It simply runs through and does nothing, as Figure 2 shows. Why?

Figure 2 By default, no output.

The problem is either that I didn't have $DebugPreference set correctly, or I didn't use the -Debug parameter.

Let's first address $DebugPreference. By default, $DebugPreference is set to SilentlyContinue. The example in Figure 2 shows you exactly what that setting does. When faced with a Write-Debug line, it silently continues, doing nothing. Let's change $DebugPreference to Inquire, which will force any Write-Debug line to set a breakpoint and give the user some options for continuing, as shown in Figure 3.

Figure 3 $DebugPreference has triggered the breakpoint.

Even though I expected NewUser.ps1 to behave exactly as it did the last time I used the script, Write-Debug actually triggered a breakpoint, prompting me for a choice of what to do. I can confirm that I'd like to continue the operation for this individual ([Y]), or go ahead and confirm them all ([A]), or halt script execution and don't continue ([H]), or suspend the pipeline ([S])and give control back to the host. I chose to suspend the operation, as shown in Figure 4. The arrow in the figure indicates how you can tell the pipeline is suspended.

Figure 4 Double arrows (>>) indicate a suspended pipeline.

Now let's say $DebugPreference is still set to SilentlyContinue, as shown in Figure 5. The first few lines indicate that simply executing NewUser.ps1 with SilentlyContinue brings about no output. However, if I add a -Debug parameter, the script is triggered by that breakpoint now.

Figure 5 Using the -Debug parameter.

The -Debug parameter is created automatically as soon as you add the [CmdletBinding()] keyword. It's used as a way of essentially overriding $DebugPreference and forcing the script to halt at any breakpoint that it sees.

Using Set-PsBreakPoint to Insert Breakpoints

Once you've mastered setting breakpoints with Write-Debug, it's time to move up to the big leagues with Set-PsBreakPoint. This cmdlet not only sets breakpoints, but also gives you more options for controlling when the breakpoint is triggered, so you can peruse the script's environment at the time the breakpoint was set.

Unlike Write-Debug, Set-PsBreakPoint has three options for setting the breakpoint: on a particular line, when a variable is used, or when a certain command is executed inside the script (see Figure 6).

Figure 6 Set-PSBreakpoint options.

Set-PsBreakPoint also differs from Write-Debug in how the cmdlet is used. Set-PsBreakPoint is typically used outside the actual script, rather than inside the script itself.

Let's use our previous script example to compare the cmdlets. In Figure 7, I've set a breakpoint on line 7 using Write-Debug.

Figure 7 Using Write-Debug to set a breakpoint.

I can set the same breakpoint using Set-PsBreakPoint, without having to muck up my script with a bunch of Write-Debug lines. I simply set the breakpoint in my current PowerShell session (see Figure 8). PowerShell monitors my NewUser.ps1 script and triggers the breakpoint as soon as the script hits line 7.

Figure 8 Triggering a breakpoint on a specific line number.

The console output changes when a script hits a breakpoint created with Set-PsBreakPoint. You come to a [DBG] prompt, as shown in Figure 9. This separates Set-PsBreakPoint from Write-Debug; not only does Set-PsBreakPoint set a breakpoint, but it provides you with a debugging session where you have control of how to proceed, as shown in Figure 10.

Figure 9 The debugger menu.

Figure 10 Debugger menu options.

The debugging menu gives you the option to stepInto the next step in the script in a controlled manner (see Figure 11).

Figure 11 Stepping into code via the debugger.

You also have the option to see where you are in the script with the list (l) option. The arrow in Figure 12 points out the asterisk (*) that indicates where in the script the breakpoint occurred.

Figure 12 The breakpoint has occurred at line 7.

This menu offers a lot of options, giving you much more control over how the script's execution behaves when you're debugging. This feature makes Set-PsBreakPoint the big brother of Write-Debug.

Final Thoughts

We all hope never to need to debug a PowerShell script, but fallible humans make mistakes. Unless it's extremely simple, you probably will never write a perfect script the first time. Debugging is an important skill, and breakpoints are a critical component of debugging.

While you're in the mood to learn about breakpoints, check out the other cmdlets related to breakpoints, such as Enable-PsBreakpoint and Disable-PsBreakpoint. If you can master breakpoints in PowerShell, you'll be well on your way to becoming a master PowerShell debugger. If you want further information about the debugger, read Microsoft TechNet's great article "The Windows PowerShell Debugger." It has a ton of great information and dives deep into many of the features we don't have time to go over here.

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