One helpful new feature of PowerShell v 2.0 is the -online parameter. As
its name suggests, -online enables us to get the latest support for a cmdlet
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.
Syntax: Get-help (Verb-Noun) -Online
When this technique works it's like magic; issue the -online command and be
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 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.
♣
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.
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: A Free Trial of the Network Performance Monitor
(NPM)
Solarwinds'
Orion performance monitor
will help you discover what's happening on your network. This
utility will also guide you through troubleshooting; the dashboard will
indicate whether the root cause is a broken link, faulty equipment or
resource overload.
Perhaps the NPM's best feature is the way it suggests solutions to network
problems. Its
second best feature is the ability to monitor the health of individual VMWare
virtual machines. If you are interested in troubleshooting, and creating network maps, then I recommend that you take advantage of Solarwinds' offer.
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.
PowerShell v 3.0 Update-Help
Starting with version 3, PowerShell provides an Update-Help cmdlet to
automatically refresh the help files. See more about
Update-Help.
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
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.
Windows Management Instrumentation (WMI) is one of the hidden
treasures of Microsoft operating systems.
Fortunately, Solarwinds
have created the
Free WMI Monitor so that you can actually see and understand these gems of
performance information. Take the guess work out of which
WMI counters to use for applications like Microsoft Active Directory,
SQL or Exchange Server.
