Skip to main content

Expanding Custom ErrorVariable usage in PowerShell

By

Using the PowerShell common parameter –ErrorVariable allows you to capture the error that a cmdlet has produced so you can work with it. Take a look at the following code:

$Computers = "NotOnline"

ForEach ($Computer in $Computers)

{

    Get-WmiObject Win32_OperatingSystem -ComputerName $Computers -ErrorVariable +MyErrors

    Get-Service -ComputerName $Computer -ErrorVariable +MyErrors

    Get-Content -Path c:\DoesNotExists.txt -ErrorVariable +MyErrors

}

If we look at the $MyError variable, we receive the same information that is displayed on the screen:

$MyErrors

Get-Content : Cannot find path 'C:\DoesNotExists.txt' because it does not exist.

At line:6 char:5

+     Get-Content -Path c:\DoesNotExists.txt -ErrorVariable MyErrors

+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : ObjectNotFound: (C:\DoesNotExists.txt:String) [Get-Content]

   , ItemNotFoundException

    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.GetContentComman

   d

What about when we use code like this in which we want to reuse the error variable?

$Computers = "NotOnline"

ForEach ($Computer in $Computers)

{

    Get-WmiObject Win32_OperatingSystem -ComputerName $Computers -ErrorVariable MyErrors

    Get-Service -ComputerName $Computer -ErrorVariable MyErrors

    Get-Content -Path c:\DoesNotExists.txt -ErrorVariable MyErrors

}

 

 

This is what is contained inside the $MyErrors variable:

$MyErrors

Get-Content : Cannot find path 'C:\DoesNotExists.txt' because it does not exist.

At line:6 char:5

+     Get-Content -Path c:\DoesNotExists.txt -ErrorVariable MyErrors

+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : ObjectNotFound: (C:\DoesNotExists.txt:String) [Get-Content]

   , ItemNotFoundException

    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.GetContentComman

   d

 

Only one error remains.

 

In other words, you would have to write code to take a look at each error and decide what to do then.  This may not be suitable for your code.  You could turn your custom error variable into an array. You can do this by adding the  ‘+’ character in front of your custom variable.  See below:

 

$Computers = "NotOnline"

ForEach ($Computer in $Computers)

{

    Get-WmiObject Win32_OperatingSystem -ComputerName $Computers -ErrorVariable +MyErrors

    Get-Service -ComputerName $Computer -ErrorVariable +MyErrors

    Get-Content -Path c:\DoesNotExists.txt -ErrorVariable +MyErrors

}

 

 

Now here is the output of $MyErrors:

PS C:\Users\Jason> $MyErrors

Get-Content : Cannot find path 'C:\DoesNotExists.txt' because it does not exist.

At line:6 char:5

+     Get-Content -Path c:\DoesNotExists.txt -ErrorVariable MyErrors

+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : ObjectNotFound: (C:\DoesNotExists.txt:String) [Get-Content]

   , ItemNotFoundException

    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.GetContentComman

   d

 

Get-WmiObject : The RPC server is unavailable. (Exception from HRESULT: 0x800706BA)

At line:4 char:5

+     Get-WmiObject Win32_OperatingSystem -ComputerName $Computers -ErrorVariable  ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : InvalidOperation: (:) [Get-WmiObject], COMException

    + FullyQualifiedErrorId : GetWMICOMException,Microsoft.PowerShell.Commands.GetWmiObje

   ctCommand

 

Cannot open Service Control Manager on computer 'NotOnline'. This operation might require

other privileges.

Get-Content : Cannot find path 'C:\DoesNotExists.txt' because it does not exist.

At line:6 char:5

+     Get-Content -Path c:\DoesNotExists.txt -ErrorVariable +MyErrors

+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : ObjectNotFound: (C:\DoesNotExists.txt:String) [Get-Content]

   , ItemNotFoundException

    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.GetContentComman

   d

 

You can see that it contains all the errors. Your variable is now an array.  You can get the count information of how many cells are in the array.

$MyErrors.count

4

 

You can also access the array via index number.

$MyErrors[1]

Get-WmiObject : The RPC server is unavailable. (Exception from HRESULT: 0x800706BA)

At line:4 char:5

+     Get-WmiObject Win32_OperatingSystem -ComputerName $Computers -ErrorVariable  ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : InvalidOperation: (:) [Get-WmiObject], COMException

    + FullyQualifiedErrorId : GetWMICOMException,Microsoft.PowerShell.Commands.GetWmiObje

   ctCommand

 

The custom error variable will continue to append new data to it until you send data to it without the ‘+’ character.  For that reason, the first time you use it in your script, you may want to omit the ‘+’ character so you clear the array each time the script is ran in your current PowerShell session.

 

Labels:

Comments

Post a Comment

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

By
As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th
Post a Comment
Read more

Return duplicate values from a collection with PowerShell

By
If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe
Post a Comment
Read more

How to list all the AD LDS instances on a server

By
AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.
Post a Comment
Read more