There are a loads of things in life that are true, one of them is that most people never read the Terms & Conditions, and another is that they also don’t bother with the instructions before doing something! However, in my experience you often miss things you could have done with knowing, and those can turn out to be things that could have made the task so much easier. Why wouldn’t we want to make our jobs easier?
Sometimes my wife says I’m lazy, but I very much disagree, I’m incredibly efficient, or at least I try to be. In every corner of my life I am always trying to find ways to do it better, or quicker, and have it take less time. We recently had a heated discussion about getting a tumble dryer. Mrs Price says “we don’t need one, and your just too lazy to hang up the washing!” (I reckon 10% of the clothes are mine!) but I say, “think of all the time you could spend doing something else if all you have to do is whack it in the tumble dryer!?” Some may disagree, but this is me trying to make an (in my opinion) incredibly boring process more efficient so I can do better things and that’s something built into the fibre of my being - to strive to make stuff more efficient.
Why the heck am I talking about my washing? Well it’s because Windows PowerShell is my tumble dryer (I just won the top 10 worst analogies of all time award), PowerShell enables me to automate what could take forever to do, or just require too many clicks. That then allows me to get back to, well, learning more about PowerShell, but, how can I make sure I’m learning about PowerShell in the right way - and is there even a right way?
Well, alongside books and videos, I tend to learn best by doing, and that is where
Get-Help come in super handy.
The Beauty of Get-Command
When your learning a new language, you need to know the vocabulary to speak it, if you go abroad you’ll probably have a small phrasebook with you so you can quickly find the words you need.
Get-Command is PowerShell’s version of that vocab phrase book, and it’s extremely handy when your learning, and you’re not sure what cmdlet you’re looking for, or if other cmdlets exist that are related to the one your currently using.
Let’s see it in action.
If you’d like to follow along, open up Windows PowerShell (on Windows 10, just right-click Start and select Windows PowerShell - no need to run as an administrator).
Narrow it down
In your PowerShell prompt, type
Get-Command and brace yourself! The list could run for a while, especially if you have modules for Active Directory and Exchange installed. Don’t run it this way and then go scrolling to find the cmdlet you’re looking for. That is *not an efficient way to use
Get-Command! There’s a much easier way to cmdlet discovery, and that’s to use wildcards ().
Let’s say you want to do something with a Service in PowerShell, but you haven’t the foggiest idea where to start. First thing to do is to avoid using Google, there’s no need, not at this stage. So, how do we go about finding all cmdlets to do with Services?
Now, there’s a couple of things to notice about this.
- PowerShell’s cmdlet structure is *Verb-Noun*, and the *verb* and *noun* are *never* plural, they are singular. Which is why it’s `Get-Command`, and not
Get-Command**s**(note the s), sometimes this will catch you out, so it’s worth remembering if you’re not finding what you’re looking for.
- The two wildcards, at the start and end of the word service, should allow us to pick up anything with *service* in, which is what we’re after.
You’ll see far fewer cmdlets are returned when you hit Enter, and the selection is much more helpful. Now, that’s all well and good, but you could still say, I don’t know what some of these do. That’s where
Get-Help can come in handy.
The Beauty of Get-Help
Get-Command is great for quickly finding a cmdlet, perhaps if you have forgotten a cmdlet you already know (and know what it does), but
Get-Help is super helpful for giving you a glimpse into what a cmdlet does in the same kind of display format as
Get-Command, which allows you to decide which one your after.
Additionally, it is perhaps the easiest PowerShell command to use with the added benefit that it’ll teach you lots.
So, we’re typing in the same except we’re changing the cmdlets. When you hit return notice how there’s a Synopsis column, with, wouldn’t you know, an excerpt from the synopsis of the cmdlets help documentation!
Now we can quickly see which cmdlets we need to use to interact with Services through PowerShell! How great is that!
So we’ve found the cmdlet we need, and we’ve decided we’re going to restart a service, but do we just type
Restart-Service or do we need to add parameters, like the name of the service?
I reckon we need to run
Get-Help against the
Restart-Service cmdlet and see what it does! So let’s do that:
You’ll get a brief but helpful syntax, and description with some other info that should tell you all you need to know about how to use
Even more helpful is the Remarks at the bottom, which tell you parameters you can add on to your original
Get-Help command to get the full help documentation, and even just see some examples to copy. The latter is going to be helpful if the syntax doesn’t make any sense to you yet (it’s worth reading up on PowerShell syntax, but I may post something about it one day!)
Give this a quick go:
Get-Help Restart-Service -Examples
Superb huh? You can now see exactly how you can use
Restart-Service to actually restart a running service and do what you originally set out to do. The beautiful part of this, is that you can obviously run this for any PowerShell cmdlet on the system your using, and if Microsoft has included help documentation, then you’ll know how to use the cmdlet.
This post could go on forever, but there’s much more you can do with
Get-Help - and here is what you should do right now:
- Add some parameters to the above (like
I could write about what the above cmdlets can do, and it would be a waste of my time and yours. You can get everything you need from running the above 2 commands, and that will help you truly understand how powerful both cmdlets are when your learning (and even when your already a PowerShell pro I expect - and I’m still very very far from that!)
Here’s some stuff you should remember:
- Less is more when it comes to wildcards - When your trying to track down a cmdlet using wildcards,
*serv*may sometimes produce better results than
*service*. If you’re not getting any results, try deleting a few characters and see if it helps.
- Read the Help, always - This is self-explanatory, but if you need to Google how to do something, you probably haven’t read the help documentation on it yet, and you’ll probably find the answer in there.
- Try the examples - You learn by copying, so play with the examples that you get from the
Thanks for your time!
I hope you’ve enjoyed reading.