Skip to main content

PowerShell Switch Parameter

One of the things that I’ve noticed in the PowerShell cmdlets are parameters without values.  These switches alter the way that the cmdlet functions without providing any input.  This is the switch parameter functionality.  Here is how it works. 

When you declare a parameter as a switch parameter, its value is set to $False.  Using what ever logic you like, you can test to see if the condition became $True.  That means the user executed the function and specified the switch.  Let’s look at a simple example:

function Test1 ([Int32]$Value,[switch]$Add5){
if ($Add5 -eq $True) {$Value += 5}
Write-Host $Value
}





In the function Test1, we have two values, a number and the switch parameter called $Add5.  This function is simple.  You provide it a number and it displays the number.  If you add the –Add5 parameter, it adds 5 to the number you provided.  Here is an example:





PS C:\Users\Jason> test1 5

5


PS C:\Users\Jason>








In the above example, we executed the script with the value of 5.  The result was 5.










PS C:\Users\Jason> test1 5 -Add5

10


PS C:\Users\Jason>










In this example, we included the –Add5 switch parameter.  In our code, we stipulated that if this parameter is $True, the we add 5 to the $Value that we gave the function.





The switch parameter functionality is good to use when you need to have a Boolean value as a parameter.

Comments

Unknown said…
it's easy to understand. Nice post

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.