Skip to main content

Expire and Un-Expire User Accounts with PowerShell

In class we had a project that required us to read in a text file that started with a users email address and then was followed by dates on the same line.  The data file appeared as below

JDoe@contoso.com,1/12/2012,1/13/2012,1/14,2012

JaneD@contoso.com,2/3/2012,3/4/2012

The requirement was for this script to run every morning and expire any accounts who had a date that matched the current date.  Also, any accounts who’s expiration date was the previous day needed to be un-expired.  Below is the code to do it.

 

<#
Function: Test-File
Verifies that a file exists.

Returns True is the file is present.
#>

Function Test-File
{
param
(
$FilePath, $FileName
)

$TestPath = $FilePath + "\" + $FileName
$FileReady = Test-Path -path $TestPath
Write-output $FileReady

}
#End: Test File

<#
.
SYNOPSIS

Confirms if a module is available.



.
DESCRIPTION

Confirms if the provided parameter is available on
the local client.


.
PARAMETER ModuleName

The name of the module who?s presence is being checked.

.
EXAMPLE

Confirm-Module ActiveDirectory



Checks to see if the ActiveDirectory module is
present on the local machine

Returns True is present and False if not.



.
OUTPUTS

Boolean

.
Link
Get-Module

#>

Function Confirm-Module

{

Param
($ModuleName = $(Throw "You need to provide a module name."))

# Place the name of the module from Get-Module into
# the variable $Data
$Data = (Get-Module -ListAvailable -Name $ModuleName).name

# If the contents of $Data is equal to the variable
# $ModuleName, the module is present, return
# True. If not, return $False.
If ($Data -eq $ModuleName){Return $True}
Else {Return $False}
}



<#
.
SYNOPSIS

Exampines a list of users and date and expires a users account should the date match the present date.
Also will un-expire any user account that had an expiration date of the previous date.


.
DESCRIPTION

Exampines a list of users and date and expires a users account should the date match the present date.
Also will un-expire any user account that had an expiration date of the previous date.

The data file is in the format
UserEmailAddress,date

Any number of dates can be to the right of the email address as long as the dates are seperated by commas and the short date format (ie. 1/20/2012)

Designed to run as a scheduled task in the morning.


.
PARAMETER $FilePath

Forlder location of the data file.
ex: c:\data


.
PARAMETER $FileName

Name of the data file.
ex: VacationDates.txt

.
EXAMPLE

Expore-Users C:\Data VacationDates.txt


Parses a list of user email addresses and dates and determines which user accounts should be expired.




.
Link

Get-Module
Get-ADUser
Set-ADUser

#>


Function Expire-User
{
Param
($FilePath = "C:\Users\Administrator\Documents",
$FileName = "vacationData.txt"
)

# Verify that thefile exists.
# Return TRUE if it does.
# Break fro mthe script if FALSE.
$Result = Test-File $FilePath $FileName
If (-not $Result)
{
Write-host "Data File not found" -ForegroundColor White -BackgroundColor DarkRed
BREAK
}

# Verify that the Active Directory module is available.
If (-not (Confirm-Module ActiveDirectory))
{
Write-host "Active Directory Module not available"
-ForegroundColor White -BackgroundColor DarkRed
BREAK
}
Import-Module ActiveDirectory

# Read the data file.
$UserList = Get-Content ($FilePath + "\" + $FileName)

# Get Todays date - Use the .NET Frameforwork date format:
# d - Short date
$Date = Get-Date -Format d


# Loop Through each string in the data file and find
# user data that contains todays date.

ForEach ($UserData in $UserList)
{
If ($UserData -match $Date)
{
$UserObject = ($StringArr = ($UserData.Split(",")[0]))
#Get-ADUser -filter 'EmailAddress -eq $UserObject' |
#Set-ADUser -AccountExpirationDate $date
}



}
# End: ForEach ($User in $UserList)


# Check for accounts that need to reset the expiration.
$Yesterday = ((Get-Date).AddDays(-1)).ToShortDateString()


# Create the date object to store the AD un-expired time
# of January 1, 1970
$NewDate = Get-Date 1/1/1970

# Get any user object that was expired on the previous
# day and unexpire the account.
Get-ADUser -filter * -Properties AccountExpirationDate |
Where-Object {$_.AccountExpirationDate -eq $Yesterday} |
Set-ADUser -AccountExpirationDate $NewDate




Write-host "End"

}
# End: Function Expire-User

Expire-User

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.