After Hours optimize

10 fundamental concepts for PowerShell scripting

PowerShell can save you a lot of time on Windows admin tasks -- but to use it effectively, you need to understand how it works. Here's a crash course in PowerShell basics to get you started.

PowerShell scripts offer a handy way to automate various chores. Here are some key concepts that will help beginners as they start developing PowerShell scripts.

Note: This article is also available as a PDF download.

1: PS1 files

A PowerShell script is really nothing more than a simple text file. The file contains a series of PowerShell commands, with each command appearing on a separate line. For the text file to be treated as a PowerShell script, its filename needs to use the .PS1 extension.

2: Execution permissions

To prevent the execution of malicious scripts, PowerShell enforces an execution policy. By default, the execution policy is set to Restricted, which means that PowerShell scripts will not run. You can determine the current execution policy by using the following cmdlet:

Get-ExecutionPolicy

The execution policies you can use are:

  • Restricted - Scripts won't run.
  • RemoteSigned - Scripts created locally will run, but those downloaded from the Internet will not (unless they are digitally signed by a trusted publisher).
  • AllSigned - Scripts will run only if they have been signed by a trusted publisher.
  • Unrestricted - Scripts will run regardless of where they have come from and whether they are signed.

You can set PowerShell's execution policy by using the following cmdlet:

Set-ExecutionPolicy <policy name>

3: Running a script

For years now, if you wanted to run an executable file from the command line the practice was to navigate to the file's path and then type the name of the executable file. However, this age-old method doesn't work for PowerShell scripts.

If you want to execute a PowerShell script, you will usually have to type the full path along with the filename. For example, to run a script named SCRIPT.PS1, you might type:

C:\Scripts\Script.ps1

The big exception is that you can execute a script by simply typing its name if the folder containing the script is in your system's path. There is also a shortcut you can use if you are already in the folder containing the script. Instead of typing the script's full path in such a situation, you can enter .\ and the script's name. For example, you might type:

.\Script.ps1

4: Pipelining

Pipelining is the term for feeding one command's output into another command. This allows the second command to act on the input it has received. To pipeline two commands (or cmdlets), simply separate them with the pipe symbol (|).

To help you understand how pipelining works, imagine that you want to create a list of processes that are running on a server and sort that list by process ID number. You can get a list of processes by using the Get-Process cmdlet, but the list will not be sorted. However, if you pipeline the cmdlet's output into the Sort-Object ID command, the list will be sorted. The string of commands used looks like this:

Get-Process | Sort-Object ID

5: Variables

Although you can use pipelining to feed one command's output into another command, sometimes pipelining alone won't get the job done. When you pipeline a command's output into another command, that output is used immediately. Occasionally, you may need to store the output for a while so that you can use (or reuse) it later. This is where variables come into play.

It's easy to think of a variable as a repository for storing a value, but in PowerShell, a variable can store a command's full output. For example, suppose you want to store the list of processes running on a server as a variable. To do so, you could use this line of code:

$a = Get-Process

Here, the variable is named $a. If you want to use the variable, simply call it by name. For example, typing $a prints the variable's contents on the screen.

You can assign a variable to the final output of multiple commands that have been pipelined together. Just surround the commands with parentheses. For example, to sort the running processes by process ID and then assign the output to a variable, you could use this command:

$a = (Get-Process | Sort-Object ID)

6: The @ symbol

By using the @ symbol, you can turn the contents of a list into an array. For example, take the following line of code, which creates a variable named $Procs that contains multiple lines of text (an array):

$procs = @{name="explorer","svchost"}

You can also use the @ symbol when the variable is used, to ensure that it is treated as an array rather than a single value. For instance, the line of code below will run the Get-Process cmdlet against the variable I defined a moment ago. In doing so, Windows will display all the processes used by Windows Explorer and Svchost. Notice how the @ symbol is being used in front of the variable name rather than the dollar sign that we usually see used:

Get-Process @procs

7: Split

The split operator splits a text string based on a character you designate. For example, suppose that you want to break a sentence into an array consisting of each individual word in the sentence. You could do so by using a command like this one:

"This is a test" -split " "

The result would look like this:

This
is
a
test

8: Join

Just as split can split a text string into multiple pieces, the join operator can combine multiple blocks of text into one. For example, this line will create a text string consisting of my first name and last name:

"Brien","Posey" -join " "

The space between the quotation marks at the end of the command tells Windows to insert a space between the two text strings.

9: Breakpoints

Running a newly created PowerShell script can have unintended consequences if the script contains bugs. One way to protect yourself is to insert breakpoints at strategic locations within your script. That way, you can make sure that the script is working as intended before you process the entire thing.

The easiest way to insert a breakpoint is by line number. For instance, to insert a break point on the 10th line of a script, you could use a command like this:

New-PSBreakpoint -Script C:\Scripts\Script.ps1 -Line 10

You can also bind a breakpoint to a variable. So if you wanted your script to break any time the contents of a$ changed, you could use a command like this one:

New-PSBreakpoint -Script C:\scripts\Script.ps1 -variables a

Notice that I didn't include the dollar sign after the variable name.

There are a number of verbs you can use with PSBreakpoint including New, Get, Enable, Disable, and Remove.

10: Step

When debugging a script, it may sometimes be necessary to run the script line by line. To do so, you can use the Step-Into cmdlet. This will cause the script to pause after each line regardless of whether a breakpoint exists. When you are done, you can use the Step-Out cmdlet to stop Windows from stepping through the script. It is worth noting, however, that breakpoints are still processed even after the Step-Out cmdlet has been used.

Incidentally, if your script uses functions, you may be interested in the Step-Over cmdlet. Step-Over works just like Step-Into, except that if a function is called, Windows won't step through it. The entire function will run without stopping.

Additional resources

About

Brien Posey is a seven-time Microsoft MVP. He has written thousands of articles and written or contributed to dozens of books on a variety of IT subjects.

7 comments
Iberica
Iberica

I have written a Powershell script to search certain text in the VBA coding. It works and is able to search within the .dot files giving me useful results but in the same directory there are .dotm files which does not seem to be searching. G:\inpro\templates\word> get-childitem -recurse -force | select-string -pattern "agent_attention" "applicant_and_title" | select-object path I cannot wait to find out why! Iberica

tfl
tfl

@{...} j is NOT an array , rather a hash table. Similar features, but still different.

i_tiberius
i_tiberius

#3 is not accurate - it's always been a choice from among 3 options: Option 1) as you described, navigate to the directory of the executable and fire it, or Option 2) use both path and filename of the executable file in the command line (to save navigation), or Option 3) include the path to the executable file in the PATH environment variable. In options 2 and 3 you can call the file from your current directory, and generally Option 3 takes it. The PATH environment variable goes back to the Stone Age of DOS. As for #9, in PS v.2, New-PSBreakpoint is replaced by Set-PSBreakPoint. ( http://blogs.msdn.com/b/powershell/archive/2008/04/24/changes-in-upcoming-ctp.aspx )

robert.johnson2
robert.johnson2

Could not get the "Save to Tech Republic Favorites" link to work. Is this a result of the site upgrade as well?

Jody Gilbert
Jody Gilbert

Thanks -- It was a casualty of the site upgrade; it's working now. j

ricmrodrigues
ricmrodrigues

@tfl  Spot on. @{} is a hash table, @() is an array and another really important concept to talk about while we're at it is objects. @{} can resemble an object but certain things, like piping don't work the same. To create a proper object one can use (among other variances):


$object = New-Object PSObject #create instance

#add properties to it

$object | Add-Member NoteProperty <name> <value>


then you can do something like:


$object | Sort-Object <propname>

which wouldn't be possible with a hash table