Step 2 in our series is to add some users to Active Directory.
First we need a simple routine to add users to Active Directory
Update 3-11-2006 : The original add-aduser would only work in versions of PowerShell pre RC2. RC2 included some breaking changes to how the DirectoryEntry object handled. I;ve added an RC2 compatible routine.
Pre RC2 version
function add-aduser([string]$LoginName, [string]$DisplayName, [string]$FirstName, [string]$LastName)
{
$cn=$LoginName
$sam=$LoginName
$pw="P@ssword1"
$ad= new-object System.DirectoryServices.DirectoryEntry
$u = $ad.get_Children().Find("CN=Users")
$NewUser = $u.get_Children().add("CN=$cn",'User')
$NewUser.InvokeSet("sAMAccountName",$sam)
$NewUser.InvokeSet("displayName",$DisplayName)
$NewUser.InvokeSet("FirstName",$FirstName)
$NewUser.InvokeSet("LastName",$LastName)
$NewUser.CommitChanges()
$ad=new-object System.DirectoryServices.DirectoryEntry
$u = $ad.get_Children().Find("CN=Users")
$NewUser= $u.get_Children().Find("CN=$cn");
$NewUser.Invoke("SetPassword",$pw)
$NewUser.InvokeSet("AccountDisabled",$false)
# set that the password never expires
$NewUser.userAccountControl[0] = $NewUser.userAccountControl[0] -bor (65536)
$NewUser.CommitChanges()
}
RC2 Version
function add-aduser([string]$LoginName, [string]$DisplayName, [string]$FirstName, [string]$LastName)
{
$cn=$LoginName
$sam=$LoginName
$pw="P@ssword1"
# Get an ADSI object for the default domain
$ad= [ADSI]""
# Get the Users OU as default
$ou = $ad.psbase.Children.Find("CN=Users")
# Add the user
$NewUser = $ou.psbase.Children.Add("CN=$cn",'User')
# Set the basic properties
$NewUser.Put("sAMAccountName",$sam)
$NewUser.Put("displayName",$DisplayName)
$NewUser.Put("givenname",$FirstName)
$NewUser.Put("sn",$LastName)
# Commit changes
$NewUser.SetInfo()
# Set our password
$NewUser.psbase.Invoke("SetPassword",$pw)
# And enable the account
$NewUser.psbase.InvokeSet("AccountDisabled",$false)
# set that the password never expires
$NewUser.userAccountControl[0] = $NewUser.userAccountControl[0] -bor (65536)
# Commit changes
$NewUser.SetInfo()
}
This gets us a function we can call to add test users. Note we're hardcoding the OU to users, to make this more production you'd want to parameterize the OU, passwords and set the AccountControl flags to Change Password on next login, there's a lot of other resources out there to help with that.
So If we put that in a script file loaded from our Profile we can call it like this
add-aduser "joeb" "joe blogs" "joe" "blogs"
That's nice but with PowerShell we can do better. We really want to data drive this and the built-in import-csv function will parse a CSV and create a collection of objects that match the CSV schema.
Take a simple User's CSV file like this
LoginName, DisplayName, FirstName, LastName, Email
brianb, Brian Ballack, Brian, Ballack, brianb
walterf, Walter French, Walter, French, walterf
Now if we run an import-xml command on the CSV file this is the output
Each line has been parsed and an object created. To see this more clearly we can use the get-member command to reflect over the object and see what the object looks like.
(Note: it will be PSCustomObject not MshCustomObject in post RC0 builds , I'm running Exchange 2007 on this VPC which requires PowerShell RC0)
As you can see the CSV columns have been added as a NoteProperty property (this is part of the extensible type system).
So now we can create a really simple function to import a CSV file of users, pipe the output to a foreach loop and add each user to Active Directory.
# Function: Import-Users
# Description: Create users in active directory as listed in the import CSV file
# Parameters: UserFile Location of the CSV file containing the users
#
function Import-Users([string]$UserFile)
{
Import-Csv $UserFile | foreach-object { add-aduser $_.LoginName $_.DisplayName $_.FirstName $_.LastName }
}
Note that when you receiving a collection of objects in the pipeline in a scriptblock you have to loop over each object. The $_ is a special variable that gives you the current object in the loop which you can use to access properties and methods.
To call we just do
Import-Users Users.CSV
With this power 500 users are as easy as 1 user.
We're not limited to just using CSV files, I've just picked that format as I'm always amazed at the amount of data I get given in Excel spreadsheets and word documents and CSV is the easiest intermediate format to work with. There is also an import-xml command which we will use later to import an XML file containing portal content. As Powershell can call any .Net library the System.Data set of classes could also be used to pull information from databases.
The next entry will be adding our users to SharePoint.