Adding HomeFolder Through PowerShell
April 27th, 2009
No comments
It’s been some time since my last post now, had alot of things to do at work, but now I’m back OnTrack with my blogging.
Last time we checked out how to add group membership through PowerShell, so now we should have a nice test environment in place, based on Star Trek. In this post, we are going to script up Users homefolders and add each user to the correct folder. We’ll accomplish this through the following four steps:- Add a Share on the Server
- Add unique folders for all Users
- Add unique Permissions to the FOlders
- Edit the User Objects in Active-Direcroty
I’m also going to re-use a script I wrote a couple of months ago, but we’ll get back to that.
Let’s start off by creating a Share. This can be done through the Create() method in the WMI class Win32_Share. The Win32_Share is well described in MSDN. Since we want to make the script re-usable, we should check if the Share already exists. This is a simple procedure through PowerShell.
PS > $Share = "C:\Share"
PS > $ShareName = "Share"
PS > if ((gwmi Win32_Share | Where { $_.Path -eq $Share}).Path -eq $Share ) {
>> Write-Host "Share: $ShareName already exists." -ForeGroundColor Red
>> }
If the Share Already exists “Share: Share already exists” will be prompted, if not we can continue with the script.
Now that we know that the share doesn’t exist, we have to check that the folder exists, and if not, create the folder.
PS > if (!(Test-Path $Share)) {
>> New-Item -Path $Share -type directory | Out-Null
>> }
and finally, we can create our Share through WMI. Setting type to 0 creates a Disk Drive Share.
PS > $CreateShare = [wmiclass]"Win32_Share" PS > $CreateShare.Create($Share,$ShareName,$Type) | Out-Null
Now that the share is up and running, we can create our HomeFolders. First we set up our HomeDrive and HomeFolder variables, we’ll also set up a User for the example.
PS > $Share = "Share" PS > $User = "jeapic" PS > $HomeDrive = "H" PS > $HomeDirectory = "\\" + $env:COMPUTERNAME + "\" + $Share + "\" + $UserSince the script runs on the server where the Share is created, we can use the environment variable to retrieve the computername. Next, we want to check if the user already has the homedrive and homedirectory set. We can use the Get-AD.ps1 script for this. I’m also adding the -ToObject switch since i want to use the object later on.
PS > $GetUser = ./Get-AD.ps1 -Domain $Domain -User $User -Filter sAMAccountName -ToObject
PS > if ($GetUser.homeDirectory -match $HomeDirecory -AND $GetUser.homeDrive -match $HomeDrive) {
>> Write-Host "User: $User HomeDrive Already Set" -ForeGroundColor Yellow
>> }
If the User already has the HomeDrive set, we won’t continue, if not, we can go ahead and add it. But before connecting the User to the folder, want to create and give the user FullControl of his HomeFolder. Here we can use the Set-FolderPermission.ps1 script
PS > $Domain = "powershell.nu" PS > $DomainUser = $Domain + "\" + $User PS > ./Set-FolderPermission.ps1 -Path $HomeDirectory -Access $DomainUser -Permission FullControlThe Set-FolderPermission.ps1 both created the folder and set up the permissions for us, now all we have to do is set HomeDrive and HomeDirectory to the User Object.
PS > $GetUser.Put("homeDirectory",$HomeDirectory)
PS > $GetUser.Put("homeDrive",$HomeDrive)
PS > $GetUser.SetInfo()
And that’s it.
Running the script Doesn’t require the Star Trek Csv file used in the other examples, it does however require you to loop through each Users that you want to add Homefolders to. In order to get a list of all Users within an OU you can use the Get-AD.ps1 script, as shown below.
PS > ./Get-AD.ps1 -domain "LDAP://OU=Star Trek: The Next Generation,DC=powershell,DC=nu" -User AllUsers -Property sAMAccountName | ForEach {
>> ./Add-STHomeFolder.ps1 -Domain powershell.nu -User $_.sAMAccountName -Share Share -HomeDrive H
>> }
All I have to do now is change the LDAP path above and repeat the ForEach on each OU that contains Users that I want to add a HomeFolder to.
Here are a couple of screenshots on running the scripts:
Click Here to Download the Add-STShare.ps1 Script.
Click Here to Download the Add-STHomeFolder.ps1 Script.
The Get-AD.ps1 script is also required.
Here’s the Set-Foldepermission.ps1 Script that’s also required.
[?]
And if we want to remove a user from a Group we can use the Delete() method.
If we want to Delete a User in Active-Directory, we can use the Delete() method.
It’s also possible to retrieve detailed information if we pipe the object to the Format-List CmdLet.
If we want to explore the properties on our Organizational-Unit, we can simply pipe the object to the Format-List CmdLet
And last step, removing an Organizational-Unit. It’s possible to accomplish through the deleteTree() method as shown below.
Nothing strange here, Domain name is APA.CORP and the server is called Server1
Lets connect to the Active-Directory through PowerShell. First we create a connection string.
Below is the code used in this post:
