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

How to run GPResult on a remote client with PowerShell

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

Set up your Environment to utilize Invoke-GPUpdate

By
I’m sitting in O’Hare enjoying my 3 hour layover as I get ready to teach a Windows 10 class in Fort Wayne.  I’m actually prepping for my class in Fort Wayne in a few weeks, 10982 Supporting and Troubleshooting Windows 10.  This class is very much like the Windows 7 version that I used to teach so I decided to up the detail quite a bit.  In the GPO troubleshootin chapter, I’m including a demonstration on how to use PowerShell’s Invoke-GPUpdate.  I needed to make sure the environment is set up for me to be able to utilize this cmdlet.  If you read the Notes section on Invoke-GPUpdate’s help file, you will see there are three firwall rules that need to be in place:          Remote Scheduled Tasks Management (RPC)          Remote Scheduled Tasks Management (RPC-ERMAP)          Windows Management Instrumentation (WMI-IN) I decided to create a little PowerShell script to crea...
Post a Comment
Read more

Sticky Key problem between Windows Server 2012 and LogMeIn

By
This week I instructed my first class using Windows Server 2012 accessed via LogMeIn and discovered a Sticky Key problem every time you press the Shift key. Here is my solution to resolve this.  First off, in the Preferences of LogMeIn for the connection to the Windows Server, click General . Change the Keyboard and mouse priority to Host side user and click Apply at the bottom. On the Windows 2012 server, open the Control Panel – Ease of Access – Change how your keyboard works . Uncheck Turn on Sticky Keys . Click Set up Sticky Keys . Uncheck Turn on Sticky Keys when SHIFT is pressed five times . Click OK twice. If you are using Windows Server 2012 as a Hyper-V host, you will need to redo the Easy of Use settings on each guest operating system in order to avoid the Sticky Key Problem. Updated Information: March 20, 2013 If you continue to have problems, Uncheck Turn on Filter Keys .
6 comments
Read more