Home > Articles

Windows PowerShell: When to Choose Workflow Versus Script Functions

  • Print
  • + Share This
With many maintenance tasks to perform on your network, you don't enjoy running a bunch of individual functions on multiple computers. Isn't there a better way? Timothy Warner, author of Sams Teach Yourself Windows PowerShell in 24 Hours, explains how to take advantage of the PowerShell workflow to group and simplify your day-to-day network activities.
Like this article? We recommend

Windows PowerShell gives systems administrators so many options for solving our network management problems, it can sometimes be challenging to decide which method is most effective. Take workflows, for instance. In my experience, not many Windows sysadmins have a realistic understanding of how the PowerShell workflow, well, works.

A workflow in general terms is a predefined business process. The process, whatever it is, consists of a series of steps (activities) that accomplish a given result.

Microsoft added the Windows Workflow Foundation (WF) engine to version 3.0 of the .NET Framework. This means that when you run a PowerShell-defined workflow, the PowerShell runtime (a) compiles the script into Extensible Application Markup Language (XAML); and (b) submits the XAML data to the local computer's WF engine for processing.

Let's imagine that you need to perform the following tasks on a fleet of 12 new servers:

  1. Set hostname (and reboot).
  2. Join Active Directory (AD) domain (and reboot).
  3. Enumerate all installed .dll files and copy an output file to a network share.

Those three configuration tasks involve some aspects that may cause some "speed bumps":

  • How can we ensure that the hostname change occurs before the AD join step?
  • What happens if one of the target computers gets "stuck"?
  • When and how can we verify that the long-running .dll enumeration step completed successfully for all 12 servers?

One of the cool things about Windows PowerShell is that you can write advanced functions by using PowerShell itself. You don't need to be a .NET developer and code your functions in C#.

We'll start by examining the similarities between PowerShell functions and workflow. Then we'll tease apart the differences, which should make it clear which approach is best for our case study example.

Workflow Versus Functions: Initial Similarities and Differences

If we write "Hello world" samples, we see that the general syntax of PowerShell functions is practically identical to that of PowerShell workflows. Here's the workflow:

workflow Start-ConfigWF {
      Param ([string]$param1)
      Write-Output "Hello $param1"
}

And here's an equivalent function:

function Start-ConfigFunc {
      Param ([string]$param1)
      Write-Output "Hello $param1"
}

You call workflows and functions in the same way:

Start-ConfigWF -param1 'world'
Hello world

Start-ConfigFunc -param1 'world'
Hello world

This is a contrived example, but you get the idea: The PowerShell team designed the workflow syntax to mimic that of traditional PowerShell functions.

Never forget, however, that a PowerShell workflow is XAML under the hood. You can see the underlying Start-ConfigWF XAML by running the following command:

Get-Command -Name Start-ConfigWF | Format-List *

Although you certainly can (and will) include PowerShell commands in your workflow definitions, the built-in workflow activities aren't PowerShell at all, but rather PowerShell abstractions of WF activities. To wit, some key workflow activities are as follows:

  • InlineScript: For running ad hoc PowerShell commands.
  • Parallel: For running workflow tasks in a "fan out" fashion (multiple computers working simultaneously).
  • Sequence: For running workflow tasks in a serial fashion (one computer at a time).
  • Checkpoint-Workflow: For setting a rollback/resume location in a workflow.
  • Suspend-Workflow: For gracefully pausing and resuming a workflow.

For my money, Invoke-Command goes a long way in PowerShell functions. With it, you can perform parallel command execution on up to 32 computers at once by default. You can apply the -ThrottleLimit parameter to scale the "fan out" in either direction.

But can Invoke-Command, PowerShell remoting, and advanced functions make a configuration script resume after a system restart? What about configuration tasks that need to be performed in a specific sequence?

Workflow-Only Feature: Sequencing

Let's say you write a PowerShell script that performs the following actions:

Function Start-ConfigFunc2 {
      Param ([string[]]$computername)
      Get-CimInstance -ClassName Win32_BIOS -PSComputerName $computername
      Get-Service -Name *svchost* -PSComputerName $computername
}

Do you have any assurance whether the WMI call or the process call will happen first, and on which hosts? No, you don't. But what about situations when sequence does matter? That's a perfect use case for PowerShell workflow.

Look at this sample workflow:

workflow Start-ConfigWF2 {
    param ([string[]]$computername)
    foreach -Parallel ($computer in $computername) {
        sequence {
            Get-CimInstance -ClassName Win32_BIOS -PSComputerName $computer
            Get-Service -Name *svchost* -PSComputerName $computer
        }
    }
}
Start-ConfigWF2 -computername 'dc1','mem1'

In this case, the foreach -Parallel construction specifies that we'll hit all target computers simultaneously. However, the sequence keyword ensures that the Get-CimInstance fires first, and then the Get-Service.

This is powerful stuff, especially when we consider certain operations that must complete before others to fulfill dependencies.

Workflow-Only Features: Checkpointing, Persistence, and Resumability

In my experience, PowerShell function scripts that use remoting to target multiple systems can run into all kinds of snags. For example, it's annoying when my script bombs out halfway through execution. What are you left with in terms of picking up the proverbial pieces?

The ability to checkpoint and suspend/resume workflows is probably the most important reason for you to consider using them in your production configuration-management work.

You set checkpoints at potentially volatile parts of your workflow. One easy way to add them to your workflow scripts is by adding the -PSPersist parameter to the activity you want to complete just before the checkpoint:

workflow Start-ConfigWF3 {
    param ([string[]]$computername)
    foreach -Parallel ($computer in $computername) {
        sequence {
            Get-CimInstance -ClassName Win32_BIOS -PSComputerName $computer -PSPersist $true
            Restart-Computer -Wait -Force -PSComputerName $computer
            Get-Service -Name *svchost* -PSComputerName $computer
        }
    }
}
Start-ConfigWF3 -computername 'mem1'

I know I keep repeating this, but it's important: You're writing a sort of pseudo-PowerShell script when you write a workflow script. The Restart-Computer activity call above isn't the same Restart-Computer cmdlet that you've used in traditional PowerShell.

The -Wait switch keeps the workflow running on the management computer throughout the target computers' restart process.

If the computer running this workflow crashed, we'd be able to resume the workflow from the checkpoint. By the way, to resume a crashed workflow from a checkpoint, you simply run the workflow again. The WF engine on the management computer will figure out where it needs to resume, based on the last checkpoint defined in the script.

Finally, we can suspend and resume workflows. Here's a quick test:

workflow Test-Suspend {
    $d = Get-Date
    Suspend-Workflow
    (Get-Date) - $d
}
Test-Suspend

Id     Name     PSJobTypeName   State        HasMoreData    Location       Command
--     ----     -------------   -----        -----------    --------       -------
7      Job7     PSWorkflowJob   Suspended    True           localhost      Test-S...

Do you see what happened? Suspending a job creates a persistent PSWorkflowJob on the management computer. You can then connect to and resume the job from the local host or a remote computer:

Resume-Job -Id 7

Final Thoughts

I hope that you now have a better idea of when to use PowerShell workflows versus traditional functions. In short, unless you have long-running tasks that need to survive restarts and may require persistence, you're safe using both simple and advanced functions.

This article wouldn't have been possible without the direct and indirect assistance of my mentor, PowerShell MVP Don Jones. I'll leave you with some of his workflow-related writings to move you further along your learning curve:

Happy PowerShelling!

  • + Share This
  • 🔖 Save To Your Account

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