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

With the AD Recycle Bin Turned on, What Happens when you Create a User Account with a Password that does not meet the Password Policy?

This was an interesting observation from one of my Windows Server 2012 classes.  While working with the AD Recycle bin in a lab, one of my students discovered some interesting accounts that were created. When he created user accounts that did not meet password complexity requirements, an account is temporarily made and then deleted.  When a new password is provided that meets the password requirements, then a new account is made. We discovered this in two places.  First off in the Active Directory Administrative Center.  This is what caused the initial confusion.  Take a look.  This is in the Deleted Objects OU. You can see multiple deleted accounts for Test2 and one for Test3.  Test3 is a valid, functioning user account.  Using the PowerShell command Get-ADObject –IncludeDeletedObjects –Filter * –Properties ObjectSID we can see that indeed, two accounts were created, with one of them deleted. Notice the RID portion of the SID is different. ...

Sticky Key problem between Windows Server 2012 and LogMeIn

This week I instructed my first class using Windows Server 2012 accessed via LogMeIn and discovered a Sticky Key problem every time you press the Shift key. Here is my solution to resolve this.  First off, in the Preferences of LogMeIn for the connection to the Windows Server, click General . Change the Keyboard and mouse priority to Host side user and click Apply at the bottom. On the Windows 2012 server, open the Control Panel – Ease of Access – Change how your keyboard works . Uncheck Turn on Sticky Keys . Click Set up Sticky Keys . Uncheck Turn on Sticky Keys when SHIFT is pressed five times . Click OK twice. If you are using Windows Server 2012 as a Hyper-V host, you will need to redo the Easy of Use settings on each guest operating system in order to avoid the Sticky Key Problem. Updated Information: March 20, 2013 If you continue to have problems, Uncheck Turn on Filter Keys .

Backup and Restore AD LDS with DSDBUTIL.exe

Active Directory Lightweight Directory Services allow you to create a directory service that allows applications to have access to user accounts, groups, and authentication similar to Active Directory Domain Services.  The big advantage here is that the schema of the directory service will not be bound by the rules of an Active Directory database.  Exchange 2007/2010, for example, use an instance of AD LDS on the Edge Transport Server to provide for user authentication from the internet.  Because your Active Directory database is not exposed to the internet, this is more secure. Applications will handle most of the dirty work should they require AD LDS.  You may want to make sure the database is being backed up and also have a restore plan in place.  Should the database become corrupt, the application that uses that database will fail.  This document will walk you through backing up and restoring an instance of AD LDS using the dsdbutil.exe command. Fi...