Can someone break down this script that I wrote?

armacory · 2021-01-12T22:44:13.000Z

Hi Fellow PowerShell Scripters,

I have written this script but I am not really good with describing things.

I sort of need the script to be broken down so that each section can be explained what it is, why each word or symbol is there and what each bit is related to, sort of like putting the way PowerShell preforms/runs the script but in words.

The script works fine.

Basically the script grabs a CSV file and it gets the email address and tries to see if there is an existing User profile or contact card in AD with the target email address attached to it, and adds a distribution list to it, if it cant find the target email address attached to anything then create a contact card then add the distribution list to that.

The CSV file contained 2 email addresses that already were a user or contact card and the other 2 didn’t exist in our server.

I did have some “Write-Output” commands in my script so that I can keep track of if my testing script worked before using it on the 100+ people.

I have changed the names, AD paths and the email addresses to Gmail and Hotmail for privacy.

Example of the CSV File:

Email

TestEmail1@gmail.com

TestEmail2@hotmail.com

TestEmail3@gmail.com

TestEmail4@hotmail.com

Plain Script (script without the Write-Output Command):

Import-Csv 'C:\examplepath\emailList.csv'| ForEach {

if ( Get-ADUser -Filter "EmailAddress -eq '$($_.Email)' " )

{

Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email

}

else

{

New-MailContact -OrganizationalUnit "%%%Active Directory Path%%%" -Name $_.Email -DisplayName $_.Email -ExternalEmailAddress $_.Email;

Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email

}

}

Script With the Write-Output Command:

Import-Csv 'C:\examplepath\emailList.csv'| ForEach {

if ( Get-ADUser -Filter "EmailAddress -eq '$($_.Email)' " )

{

Write-Output "Email Address Found In domain.internal"

Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email

Write-Output "Permission Added"

}

else

{

New-MailContact -OrganizationalUnit "%%%Active Directory Path%%%" -Name $_.Email -DisplayName $_.Email -ExternalEmailAddress $_.Email;

Write-Output "Contact Card Created" 

Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email

Write-Output "Permission Added To Contact Card" 

}

}

The script found the 2 “Gmail” accounts and added the distribution list to their “Member Of” property, the script couldn’t find the 2 “Hotmail” accounts though, so it created a contact card for each, assigning the listed email address as their display name section and in their E-mail section, then added the distribution list to their “Member Of” property.

Would be awesome for someone to break this down (only need to break down the plain one).

After getting the broken down version of the script I was thinking of publishing it.

Thanks in advance.

@Gmail_TC4647

Neally · 2021-01-12T23:15:33.000Z

spicehead-2jph7:

brake down this script that I wrote?

Neally · 2021-01-12T23:24:58.000Z

if you have specific questions ask the specific question, it’s silly to have a whole script explained.

# import the CSV
Import-Csv 'C:\examplepath\emailList.csv' | 
# takes each row of the CSV and gives it down the pipe
ForEach-object {
    # if statement matches condition
    # Get-ADUSer queries activeDirectory
    # -filter looks for a certain attribute in AD
    # $( ) is the subexpression operator
    # $_ is the current value in the pipe
    #  THUS $($_.Email) _> will take the value of the email column of the current row in the pipe of the CSV
    # is statement is looking for user in AD with a specific email address
    if ( Get-ADUser -Filter "EmailAddress -eq '$($_.Email)' " ){
        # add member to distribution group
        Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email
    }
    # if IF condition was not met, do else
    # is no AD user with email address is found
    else{
        # create new contact
        # new-mailcontact requires EXCHANGE btw
        New-MailContact -OrganizationalUnit "%%%Active Directory Path%%%" -Name $_.Email -DisplayName $_.Email -ExternalEmailAddress $_.Email;
        # add new contact to distribution group
        Add-DistributionGroupMember -Id "#Example Distribution List" -Member $_.Email
    }
}

Neally · 2021-01-12T23:25:51.000Z

Also, If you post code, please use the ‘Insert Code’ button. Please and thank you!

PLEASE READ BEFORE POSTING! Read if you're new to the PowerShell forum! Programming & Development

Hi, and welcome to the PowerShell forum! Don’t apologize for being a “noob” or “newbie” or “n00b.” There’s just no need – nobody will think you’re stupid, and the forums are all about asking questions. Just ask! Use a descriptive subject. Don’t say “Need help” or “PowerShell Help”, actually summarize what the problem is. It helps the rest of us keep track of which problem is which. Don’t post massive scripts. We’re all volunteers and we don’t have time to read all that, nor will we copy…

armacory · 2021-01-13T00:55:01.000Z

Hi @alexw ,

Thanks for your response and breaking down the script for me.

I did however notice the:

" # new-mailcontact requires EXCHANGE btw"

I have removed all the permissions and the 2 test external contact from my system and checked that they were also removed from exchange.

I ran the script again and here is a screenshot of the script and the result (censored)

PowerShell_1.jpg770×398 28.2 KB

After the script was completed I checked Exchange and the 2 external contacts that were created were in there:

Do you know if this is the script that is doing this or is there something in exchange or in AD that is forwarding it to exchange.

Regards

DoctorDNS · 2021-01-13T13:29:20.000Z

Put your brakes on, The word is break not brake! I assume English is the same in Aussie, although some days I am not sure

For the most part, just read the script out loud. For example,. take the line:

Import-Csv 'C:\examplepath\emailList.csv'| ForEach {

I would explain this beginning with : "This statement Imports the CSV file C:.… For each line in that file …

One thing I love is the obviousness of it. I recall a post made by Jeffrey Snover (the inventor of PowerShell!), commenting on a script that used MSMQ. His comment was along the lines of “i do not know anything about this technology, but I can understand what the script is trying to do”. Compare that with VBS - after 20 years trying I still struggle to explain some scripts.

As an aside, you are welcome to DM me and I will happily do this for you. My consulting rates are reassuringly expensive.

Neally · 2021-01-13T14:22:58.000Z

Arma Cory:

I don’t understand your question.

‘New-Mailcontact’ is an exchange cmdlet, so it will create a new contact in Exchange.

learn.microsoft.com

New-MailContact (ExchangePowerShell)

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the...

armacory · 2021-01-15T00:12:23.000Z

Hi Neally,

Ah I understand now, sorry my understanding was that it needed to be created in exchange as well, just the “btw” was mad me thing I was missing something, totally my fault.

All good now.

Thanks for all your help.

Cory

I have submitted my script Click to view: https://community.spiceworks.com/scripts/show/4858-bulk-adding-users-email-addresses-to-a-distribution-list-with-if-script-via-csv-file

@alexw