Skip to main content

Creating an Error Log: Verifying the Log Exists

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

For those of you who have taken one of my PowerShell classes over the years, you know that I like to address all of the issues of a problem.  Our first issue is “does the error log exists?”  If we are going to append to if, we need to make sure that it is already present.  The function below can be added to your code to verify that the log exists.  If not, then it will create the log.  One thing to take note of, this code does note address error logs stored on a remote system.  This is only tested for error logs stored on the local system.

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
    }

<#
.SYNOPSIS
Verifies the existence of an your error log.

.DESCRIPTION
Verifies the existence of an your error log. If no error log is present,
then the file is created.

.PARAMETER Path
The directory location of the error log.

.PARAMETER Name
The name of the error log.

.EXAMPLE
Test-ErrorLog -Path c:\ps\error -Name Error.csv

.NOTES
===============================================================================
== Function: Test-ErrorLog                                                   ==
== Author: Jason A. Yoder                                                    ==
== Company: MCTExpert of Arizona                                             ==
== Date: October 2, 2016                                                     ==
== Copyright: All rights reserved.                                           ==
== Version: 1.0.0.0                                                          ==
== Legal: The user assumes all responsibility and liability for the usage of ==
== this PowerShell code.  MCTExpert of Arizona, Its officers, shareholders,  ==
== owners, and their relatives are not liable for any damages.  As with all  ==
== code, review it and understand it prior to usage.  It is recommended that ==
== this code be fully tested and validated in a test environment prior to    ==
== usage in a production environment.                                        ==
==                                                                           ==
== Does this code make changes: NO                                           ==
===============================================================================
#>

} # END: Function Test-ErrorLog



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.