Ezine 190 – PowerShell 2.0 Get-Help -online

PowerShell 2.0 – The Get-Help -online Parameter

One new and helpful feature of PowerShell v 2.0 is the -online parameter.  As its name suggests, -online enables us to get the latest support information direct from Microsoft’s website.  The main purpose of this page is simply to explain how to get PowerShell’s -online switch to work.  My secondary aim is to present a case study on the frustration of learning a skill that is ostensibly simple but nevertheless slippery.

Get-help Verb-Noun -online

When this technique works it’s like magic; you issue the -online command and are amazed to see the browser launch at a url such as:
http:// go.microsoft.com/fwlink/? LinkID=113322.  The point is that if Microsoft ever amends the help file then the latest information will be there on the website, there will be no need for Microsoft to update PowerShell every time they edit a cmdlet’s help file.

If the -online switch worked for you straightaway, then read no further.  However, if you are struggling with its syntax, then read on and I will explain the knack of using PowerShell’s -online parameter.  See more about -online

Example to get online information about the get-Service cmdlet

The secret of success is to start with the instruction ‘get-Help’, or just plain ‘Help’ if you prefer.  Next comes the name of the cmdlet that you want to research, and finally, the word -online.

get-Help get-Service -online

While the above command works fine, however, this command below fails because I forgot to precede the cmdlet with get-Help.

get-Service -online

To double check your understanding try this:

get-help get-help

You should see -online listed among the parameters; for even more information append the -full parameter.

Next try this example:

get-Help get-Service

There should be no sign of -online amongst the parameters.  However, you should see in the ‘Related Links’ at the bottom:
Online version: http://go.microsoft.com/fwlink/?LinkID=113332

Guy Recommends: WMI Monitor and It’s Free!Solarwinds Free WMI Monitor

Windows Management Instrumentation (WMI) is one of the hidden treasures of Microsoft’s operating systems.  Fortunately, SolarWinds have created a Free WMI Monitor so that you can discover these gems of performance information, and thus improve your scripts.

Take the guess work out of which WMI counters to use when scripting the operating system, Active Directory or Exchange Server. Give this WMI monitor a try – it’s free.

Download your free copy of WMI Monitor

Guy’s Learning Frustration

My first mistake was to believe that -online was a parameter supported by every PowerShell cmdlet, whereas in reality it’s only available with get-Help.

My second problem was unfortunate; I used an early beta version of PowerShell 2.0. The Microsoft developers had not added the -online parameter to this version, thus I had no chance of finding it!  My stupidity here is not being more careful with beta software; how many more fingers will I burn before absorbing this lesson?

This saga of understanding -online reminds me a pupil called DK, who I taught science.  The reason that DK could not learn to read was merely because he did not know what the word ‘next’ meant.  The English teacher would say. "David what’s this next word", pointing to ‘Cat’.  David replied, "I don’t know".  Once we discovered his learning block was the word ‘next’, DK’s education blossomed and he went on become a successful formula one mechanic.

Guy Recommends: Tools4ever’s UMRAUMRA The User Management Resource Administrator

Tired of writing scripts? The User Management Resource Administrator solution by Tools4ever offers an alternative to time-consuming manual processes.

It features 100% auto provisioning, Helpdesk Delegation, Connectors to more than 130 systems/applications, Workflow Management, Self Service and many other benefits. Click on the link for more information onUMRA.

PowerShell Forums

In this instance, it was Marco Shaw at the Microsoft TechNet forum who patiently explained to me how to get the -online parameter to work.  And there is another good forum at microsoft.public.windows.powershell.  Without seeming ungrateful, my plea is that wherever possible technical forums should amalgamate.  While I prize diversity in the food and beer industries, I would welcome centralization is the case of PowerShell forums.

Summary of PowerShell 2.0’s -online Parameter

Just remember that the -online technique for getting extra help is a parameter of get-Help.  For all other cmdlets your best chance of finding the most relevant url is to look in the ‘Related Links’.

If you like this page then please share it with your friends


See more Windows PowerShell tutorials

PShell Home   • Introduction   • Dreams   • 3 Key Commands   • PowerShell Help About   • Get-Help

PowerShell v 3.0   • Set-ExecutionPolicy   • Get-Command   • Cmdlet scripts   • Import-Module

PowerShell Version Check   • Backtick   • PowerShell examples   • PowerShell ISE   • Get-Member

Please email me if you have a better example script. Also please report any factual mistakes, grammatical errors or broken links, I will be happy to correct the fault.