Skip to main content

How to Read Help Files (Part 7 of 7)

This is it!  The last in this series on how to read PowerShell Help Files.

Help files are available for more than just cmdlets.  PowerShell actually has an entire book of material to help you learn PowerShell built it.  Type this command:
Get-Help About_*

What you see are help files about various aspects of using PowerShell.  You will see help on programming constructs, PowerShell features, and different elements of the syntax. 
The help concerning programming such as About_IF and About_Switch start off very basic and adds in additional elements as you go.  I’ve used the About files many times to solve problems and discover why technologies are not working.

You also have help files for the PowerShell Providers.  The PSProviders give you easy access to data that would otherwise be difficult to access, such as the registry.  To see all of your PSProviders:

Get-PSProvider

PS C:\> Get-PSProvider

Name                 Capabilities                            Drives                                                             
----                 ------------                            ------                                                              
Registry             ShouldProcess, Transactions             {HKLM, HKCU}                                                       
Alias                ShouldProcess                           {Alias}                                                            
Environment          ShouldProcess                           {Env}                                                              
FileSystem           Filter, ShouldProcess, Credentials      {C, D, E}                                                          
Function             ShouldProcess                           {Function}                                                         
Variable             ShouldProcess                           {Variable}                                                          
Certificate          ShouldProcess                           {Cert}                                                             
WSMan                Credentials                             {WSMan}                                                            


To get help on each provider, just ask for it by name.  For example: Get-Help Registry or Get-Help FileSystem.

That is it on reading the Help Files.  I encourage you to invest in reading the help files for cmdlets as you start using them.  This initial investment will slow you down at first, but it will pay in dividends later.  Not only in saving you time because you know how to use a cmdlet, but also in extra coding.  One of the coding errors that my PowerShell students make is they write a lot of extra code to do something that is already built into a cmdlet.  By investing in reading the help files up front, you will have to code less and produce your scripts faster and more efficiently.

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.