Skip to main content

Getting Rid of the Back Ticks

For those of you who have been utilizing my blog posts over these past several years, you may have noticed that I generally rely on the back tick to prevent my code from horizontally extending outside of the screen and to provide order to cmdlets with a lot of parameters.  The back tick consists of only 3 pixels.  Here it is: `  Did you miss it?  So, if the back tick is bad, how to do you prevent horizontal scrolling? 

The back tick does allow for some very orderly presentation of code.  Take a look at this simple example:

$Obj = New-Object -TypeName PSObject

$Obj | Add-Member -MemberType NoteProperty `

        -Name "Prop1" `

        -Value "PowerShell Rocks"

 

 

This code simply makes an object with one property.  Notice that in using the Add-Member cmdlet, I separated three different parameters using the back tick.  The problem, it may not be easy to see.  Here is an alternative using splatting.

$Prop1 = @{

    MemberType = "NoteProperty"

    Name="Prop1"

    Value = "PowerShell Rocks"}

 

$Obj = New-Object -TypeName PSObject

$Obj | Add-Member @Prop1

 

 

In this example, we created a hash table utilizing the name of the parameter as the key, and what we want to set it to as the value.  This method still allows for an orderly presentation of the cmdlets parameters.  It also has another advantage.  If you need to create another object with the same property, you can just reuse the splat. Here is some code to create a new Fine Grain Password Policy written without using back ticks.

New-ADFineGrainedPasswordPolicy -Name "Group1PSO" -Precedence 10 -ComplexityEnabled $True -Description "PSO for Group 1" -DisplayName "Group1PSO" -LockoutDuration "0.12:00:00" -LockoutObservationWindow "0.00:15:00" -LockoutThreshold 3 -MaxPasswordAge "10.00:00:00" -MinPasswordAge "1.00:00:00" -MinPasswordLength 8 -PasswordHistoryCount 10 -ReversibleEncryptionEnabled $False

 

This is not very easy to read.  It is essentially noise.  And now with the back ticks:

 

New-ADFineGrainedPasswordPolicy -Name "Group1PSO" `

 -Precedence 10 `

 -ComplexityEnabled $True `

 -Description "PSO for Group 1" `

 -DisplayName "Group1PSO" `

 -LockoutDuration "0.12:00:00" `

 -LockoutObservationWindow "0.00:15:00" `

 -LockoutThreshold 3 `

 -MaxPasswordAge "10.00:00:00" `

 -MinPasswordAge "1.00:00:00" `

 -MinPasswordLength 8 `

 -PasswordHistoryCount 10 `

 -ReversibleEncryptionEnabled $False

 

Much better and very organized.  It is easy to both see which parameters are being used and their values. And now utilizing splatting:

  $Params = @{

    Name = "Group1PSO"

    Precedence = 10

    ComplexityEnabled = $True

    Description = "PSO for Group 1"

    DisplayName = "Group1PSO"

    LockoutDuration = "0.12:00:00"

    LockoutObservationWindow = "0.00:15:00"

    LockoutThreshold = 3

    MaxPasswordAge = "10.00:00:00"

    MinPasswordAge = "1.00:00:00"

    MinPasswordLength = 8

    PasswordHistoryCount = 10

    ReversibleEncryptionEnabled = $False}

 

 New-ADFineGrainedPasswordPolicy @Params

 

Yes, there is a little bit more code.  The advantage is that you do not have to worry about if the recipient of this code will notice a back tick or not.  In my past PowerShell V2 classes, I had to spend some time with the ISE magnification on high to demonstrate the back tick being used as the escape character.  This included line continuation.  Moving forward with the V3 classes, I will be focusing on splatting as my means of line continuation when parameters are involved.

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.