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

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.

How to run GPResult on a remote client with PowerShell

In the past, to run the GPResult command, you would need to either physically visit this client, have the user do it, or use and RDP connection.  In all cases, this will disrupt the user.  First, you need PowerShell remoting enabled on the target machine.  You can do this via Group Policy . Open PowerShell and type this command. Invoke-Command –ScriptBlock {GPResult /r} –ComputerName <ComputerName> Replace <ComputerName> with the name of the target.  Remember, the target needs to be online and accessible to you.

Error icon when creating a GPO Preference drive map

You may not have an error at all.  Take a look at the drive mapping below. The red triangle is what threw us off.  It is not an error.  It is simply a color representation of the Replace option of the Action field in the properties of the drive mappings. Create action This give you a green triangle. The Create action creates a new mapped drive for users. Replace Action The Replace action gives you a red triangle.  This action will delete and recreate mapped drives for users. The net result of the Replace action is to overwrite all existing settings associated with the mapped drive. If the drive mapping does not exist, then the Replace action creates a new drive mapping. Update Action The Update action will have a yellow triangle. Update will modify settings of an existing mapped drive for users. This action differs from Replace in that it only updates settings defined within the preference item. All other settings remain as configured on the mapped drive. If the