Skip to main content

How to read Help Files (Part 1 of 7)

By
Every job has a mission critical skills that you need to master to perform your duties.  An airline pilot needs to master the safe landing.  A surgeon must master the usage of a scalpel.  You, as a PowerShell coder must master the reading of the help files. 

Reading help files is a regular them on my blog. I receive a lot of request for help.  Not only from moderating the forums on PowerShell.com, but I also get contacted out of the blue for consulting.  I look at the code that was generated and I sometimes just want to say “What were you thinking?”  I think that because of mistakes that reading the help files would have prevented from happening.

Normally not reading the help files is due to either a lack of knowledge about the help files or just a plain lack of motivation.  I cannot do anything about an individual’s motivation level, but I can help with the knowledge part.  The PowerShell help system is very robust. In this series, I plan on walking you through a detailed, step-by-step guide on how to use the help system.

Since PowerShell V3, we have had updatable help.  That means that you must update the help system before it provides you with any real information.  To do this, open PowerShell as an Administrator and execute the command Update-Help.  I suggest doing this in the shell.  You can do this in the ISE, but it takes longer.  Update-Help uses your internet connection to download the help files for all modules stored in the locations specified by $env:PsModulePath.  To see these locations:

$env:PSModulePath.Split(“;”)

PS C:\> $Env:PSModulePath.Split(";")
C:\Users\JASON\Documents\WindowsPowerShell\Modules
C:\Program Files\WindowsPowerShell\Modules
C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules\
C:\Program Files (x86)\Microsoft SDKs\Azure\PowerShell\ServiceManagement

If you install a new feature or software that has a PowerShell module, you will need to run Update-Help once again.  Update-Help will only update once every 24 hours so you may have to run

Update-Help –Force


Tomorrow we will look at the basic help file.
Labels:

Comments

Post a Comment

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

By
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
Post a Comment
Read more

Return duplicate values from a collection with PowerShell

By
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
Post a Comment
Read more

How to list all the AD LDS instances on a server

By
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.
Post a Comment
Read more