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

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.

How to run GPResult on a remote client with PowerShell

In the past, to run the GPResult command, you would need to either physically visit this client, have the user do it, or use and RDP connection.  In all cases, this will disrupt the user.  First, you need PowerShell remoting enabled on the target machine.  You can do this via Group Policy . Open PowerShell and type this command. Invoke-Command –ScriptBlock {GPResult /r} –ComputerName <ComputerName> Replace <ComputerName> with the name of the target.  Remember, the target needs to be online and accessible to you.

Error icon when creating a GPO Preference drive map

You may not have an error at all.  Take a look at the drive mapping below. The red triangle is what threw us off.  It is not an error.  It is simply a color representation of the Replace option of the Action field in the properties of the drive mappings. Create action This give you a green triangle. The Create action creates a new mapped drive for users. Replace Action The Replace action gives you a red triangle.  This action will delete and recreate mapped drives for users. The net result of the Replace action is to overwrite all existing settings associated with the mapped drive. If the drive mapping does not exist, then the Replace action creates a new drive mapping. Update Action The Update action will have a yellow triangle. Update will modify settings of an existing mapped drive for users. This action differs from Replace in that it only updates settings defined within the preference item. All other settings remain as configured on the mapped drive. If the