Windows PowerShell Variables
Introduction to Windows PowerShell VariablesAll scripting languages use placeholders or variables to hold data.
Furthermore, each language has its own rules and symbols. I have found that
using PowerShell
variables is straightforward, just remember to introduce your variable with a dollar sign, for example: $Memory. Topics for PowerShell's Variables
♣
Variables are handy for storing data which can be used
later in the script; for example, storing a file path. Creating
a PowerShell variable could not be more straightforward; just declare the
variable by putting the dollar sign in front of the name you wish to call the variable. Let us create, then set, a variable called $Mem:
$Mem= WmiObject
Win32_ComputerSystem Once we have created $Mem, then we can put the variable to work and calculate the RAM memory in Mega bytes.
# PowerShell $ Variable Example $Mem= WmiObject Win32_ComputerSystem $Mbyte =1048576 # Another
variable "Memory Mbyte " + [int]($Mem.TotalPhysicalMemory/$Mbyte)
PowerShell has no built-In mechanism for enforcing variable types, for example, string variables can begin with letters or numbers. Yet
numeric variables can also begin with letters (or numbers). However, you
can restrict the values a PowerShell variable accepts by preceding it
with [int] or [string], here is an example: Example
1a:
Declaring a
PowerShell Variable as an Integer
# Declaring PowerShell Integer Variable [int]$a =7 $a +3 $a
# PS>10
Example 1b: "Twenty" is not an [int]
# Declaring PowerShell Integer Variable [int]$a =7 $a ="Twenty" $a
# PS> Error "Cannot Convert value.
Note 1: I cannot resist pointing out the
significance of [Square brackets]. The reason is that PowerShell only ever uses square
brackets for optional items, and declaring the type of a variable is just that -
[optional[. Example
2:
Declaring the Variable Without Specifying the Type.
$b = 7 $b = "Twenty" $b
# PS> Twenty
There is no error
here because $b was not
declared as number or a string. Do you think that PowerShell variables are case sensitive or insensitive? The answer is insensitive, just as with most other
PowerShell commands, upper or lower case work equally.
When Windows PowerShell evaluates a potential variable name, it carries on from the $Dollar until it meets a word breaking character such as a space or punctuation mark. This
does not give me a problem because I only use
snappy OneWord names, but if you use variables with strange characters - watch out! If you insist on using variables with names such as a*?,v**, then you could enclose them in braces - thus {a*?,v**}. Clever stuff, but
best to keep it simple, and don't ask for trouble I say.
Guy Recommends: A Free Trial of the Network Performance Monitor
(NPM)
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
Reserved Words - Not To Be Used For Variables
Avoid using these reserved keywords for your variables: Break, continue,
do, else, ElseIf, for, foreach, function, filter, in, if, return, switch,
until, where and while.
Incidentally, you can join string variables simply by using a plus (+) sign. The reason that I mention this is because I spent ages searching fruitlessly for a special text concatenator, only to
discover that the plain plus sign was all I needed.
Declaring Multiple Variables
In scripting we are always seeking ways of writing tighter code. In
the case of variables you could make multiple declarations on the same line;
for example:
$DriveA, $DriveB, $DriveC, $DriveD = 250, 175, 330, 200
PowerShell Variables - Text Examples
What you find when researching WMI objects is that there are so many.
The purpose of this script is filter, or home in on, a keyword such as
Win32, or network. To aid the research and to recycle the code I
introduce a variable $Type.
To begin with I set the value of $Type to "Win32", later it would be
a trivial task to amend to "Network". Once again, note how this
script uses the built in $_. variable, and see how it uses .name in this
pipeline.
# PowerShell Variables Including $_.
$i=0
$Type = "Win32"
$WMI = Get-WmiObject -List | Where-Object {$_.name -Match $Type}
Foreach
($CIM in $WMI) {$i++}
Write-Host 'There are '$i' types of '$Type
See more on
my Get-WmiClass function »
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
You can control, or restrict,
PowerShell variables with the
set-Variable command. These extra properties of 'Option' and 'Scope' are not really necessary for beginners, nevertheless as you grow in ambition, you may like to revisit these additional features.
Option can set the variable to be read-only or constant. Constant variables sound strange, but their killer feature is they cannot be deleted.
# Example: PowerShell Set-Variable constant Set-Variable Thermometer 32 -option
constant.
Note 2: That when initializing with set-variable, $Thermometer is wrong, plain Thermometer is what you need here. Once the value is set to 32 it cannot be changed. Scope can be local, global or script.
The default value for the scope of a variable is local.
# Example: PowerShell Set-Variable Global Set-Variable AllOverPlace
99 -scope global
Note 3: For more information about Set-Variable, try
Help Set-Variable.
Note 4: The value would be 99, again you don't add the $dollar sign when you execute set-variable.
Actually, there is an alternative method for setting and creating Scope:
# Set PowerShell Global Variable $global:runners = 8
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
Before we look at the pipeline variable $_. let us have a general
look at PowerShell .dot properties. PowerShell variables support the dot (.) properties. For example:
$alert = Get-Service NetLogon $alert.status
# PS> Started
Not only is $variable.property a neat technique, but
also note that Get-Service alerter.status does not work, you get an error saying: 'Cannot find any service called
alerter.status'.
$_ or $_. takes the dot notation one stage further. It acts a placeholder for the current object. The official definition for $_. is the current pipeline object; used in script blocks,
filters, the process clause of functions, where-object, foreach-object and switches. However, I believe that
special PowerShell variable $_. is best explained by examples.
PowerShell Example to find all services that are Running (not stopped)
# PowerShell Pipeline $_. example Get-Service | where {$_.status -eq "Running" }
Remember that this Get-Service command lists all those services on the machine. Status is a property of the service. One of the possible values for status is "Running", another value is "Stopped".
Should you wish to employ a 'where' clause, then you need the $_. variable to introduce or link to the property 'status', hence $_.status.
Example to find all WmiObjects containing 'CIM'
Get-WmiObject -List | where-object {$_.name -Like "CIM*"}
Note 5: The point is that the list is too long when you try: Get-WmiObject -List
By pipelining $_.name, we can filter just names containing "CIM".
Incidentally it does not work without the wildcard * -Like "CIM*".
However you could experiment with -Match, or -Contains.
See more on PowerShell's $_.
meaning In the Current Pipeline
Guy Recommends: SolarWinds' Free Bulk Import Tool
Import users from a spreadsheet. Just provide a list of the
users with their fields in the top row, and save as .csv file.
Then launch this FREE utility and match your fields with AD's
attributes, click and import the users.
Optionally, you can
provide the name of the OU where the new accounts will be born.
Download your FREE bulk import tool.
You can enumerate PowerShell's variables with this command:
Another example showing more information and more control:
Get-Variable | Format-Table name, value -auto
|
Variable Name |
Description |
|
$_ |
The current pipeline object; used in script blocks, filters, the process clause of functions, where-object, foreach-object and switch |
|
$^ |
contains the first token of the last line input into the shell |
|
$$ |
contains the last token of last line input into the shell |
|
$? |
Contains the success/fail status of the last statement |
|
$Args |
Used in creating functions that require parameters |
|
$Env:Path |
Environmental Path to files. |
|
$Error |
If an error occurred, the object is saved in the $error PowerShell variable |
|
$foreach |
Refers to the enumerator in a foreach loop. |
|
$HOME |
The user's home directory; set to %HOMEDRIVE%\%HOMEPATH% |
|
$Input |
Input piped to a function or code block |
|
$Match |
A hashtable consisting of items found by the -Match operator. |
|
$MyInvocation |
Information about the currently script or command-line |
|
$Host |
Information about the currently executing host |
|
$LastExitCode |
The exit code of the last native application to run |
|
$PSVersionTable |
Chech the version of PowerShell |
|
$true |
Boolean TRUE |
|
$false |
Boolean FALSE |
|
$null |
A null object |
$PsUnsupported ConsoleApplications |
List unsupported commands |
|
$OFS |
Output Field Separator, used when converting an array to a string. By default, this is set to the space character. |
|
$ShellID |
The identifier for the shell. This value is used by the shell to determine the ExecutionPolicy and what profiles are run at startup. |
|
$StackTrace |
contains detailed stack trace information about the last error |
PowerShell Variables in Action
Example 1) To discover which version of
PowerShell you are running, go to the PowerShell command line and type: $host
Example 2) You could modify the Environment Path value thus:
|