Skip to main content

Creating an Error Log: To Append or not to Append

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

You may be faced with a situation when you want to clear the error log before running your code.  We are now going to start building the code for our scenario from Monday. 

Function Test-ADUsers
{
    [CmdletBinding()]
    Param (
        [String[]]
        $Names

    )

    ForEach ($Name in $Names)
    {
        Try {Get-ADUser -Identity $Name -ErrorAction Stop}
        Catch {}
    }

} # END: Function Test-ADUsers

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

I left the test line at the end of the code so you can copy this into the ISE or SAPIEN PowerShell Studio and just execute the code.  Notice that we are not doing anything in our error handling as of yet.  Our next step is to add in the Test-ErrorLog code from yesterday.

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

# 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 -Name Errorlog.csv

    ForEach ($Name in $Names)
    {
        Try {Get-ADUser -Identity $Name -ErrorAction Stop}
        Catch {}
    }

} # END: Function Test-ADUsers

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

I removed the help file for Test-ErrorLog to help keep this post reasonably short.  Next we add a parameter to clear the error log if we want to.  We will call it –NoAppend.
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}
        Catch {}
    }

} # END: Function Test-ADUsers

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


-NoAppend is a switch parameter.  We simply test to see if it is used or not.  If it is, we remove the old file and then create a new one in its place.  This allows us to start with a clean error log whenever we need to.  Go ahead and give it a try.  Make sure you open the error log to verify that it is either appending, or being cleared.

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.