Skip to main content

Creating an Error Log: Option 1 - Use a Custom Object with a CSV file

This is day 4 of how to create an error log.

Today we will be using a custom object for our error log.  We can actually do this in two different ways.  We could create a custom object with specific information from the error object produced by PowerShell or create a custom log ourselves.

If we utilize the object created by PowerShell with a CSV error log, then we need to make sure that we only utilized 2D data.  That is information that is not a complex object itself.

Function Test-ADUsers
{
    [CmdletBinding()]
    Param (
        [parameter(Mandatory=$true)]
        [String[]]
        $Names,

        [Switch]
        $NoAppend

# Begin Support Functions
    )
    Function Test-ErrorLog
    {
    [CmdletBinding()]
    Param (
        [parameter(Mandatory=$true)]
        [String]
        $Path,

        [parameter(Mandatory=$true)]
        [String]
        $Name
        )

        # Test the path.
        If (!(Test-Path -Path $Path))
        {
            Write-Verbose "Creating the directory $Path"
            New-Item -Path $Path -ItemType Directory
        }

        # Test the file
        If (!(Test-Path -Path "$Path\$Name"))
        {
            Write-Verbose "Creating the file $Name"
            New-Item -Path "$Path\$Name" -ItemType File
        }

    } # END: Function Test-ErrorLog

# End Support Functions

    # Verify that the error log is present.
    Test-ErrorLog -Path c:\ps\error -Name Errorlog.csv

    # If -NoAppend is TRUE, then clear the error log.
    If(($NoAppend))
    {
        Write-Verbose "Clearing the error log"
        Remove-Item -Path C:\PS\error\ErrorLog.csv -Force
        New-Item -Path C:\PS\error -Name ErrorLog.csv -ItemType File     
    }

    ForEach ($Name in $Names)
    {
        Try {Get-ADUser -Identity $Name -ErrorAction Stop -ErrorVariable MyError}
        Catch
        {
            $Obj = New-Object -TypeName PSObject -Property @{
                TimeGenerated = (Get-Date).ToString()
                UserName = $Name
                Message = $MyError.Message
                }
            $Obj | Export-csv -Path C:\PS\Error\ErrorLog.csv -Append

            $MyError | Select *
        }
    }

} # END: Function Test-ADUsers

Test-ADUsers -Names "Administrator", "Bad", "Administrator"  -Verbose

Take a look at the Get-ADUser cmdlet.  We added the –ErrorVariable parameter to store our error object. Next, look at the Catch block. You can see the creation of the object to be sent to our error log.

TimeGenerated will be the time the error is recorded.  Notice, I’m only sending a string, not a SYSTEM.DATTIME object that is normally produce by Get-Date
UserName is the name of the user that we are currently testing.
Message contains the message property of the error object.


The Export-CSV cmdlet also has a huge advantage.  We are using the –Append parameter.  This means that we will add new records as needed.  The –NoAppend parameter that we created earlier prevents us from appending to a file that already exists.  The –Append parameter of Export-CSV is needed to ensure that we record all error instances when the code is ran.  Otherwise we will only have a record of the last error recorded.

Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

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

Return duplicate values from a collection with PowerShell

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

How to list all the AD LDS instances on a server

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.