Skip to main content

How to Read Help Files (Part 6 of 7)

By
As I promised yesterday, here are a few tips and tricks for help files based on cmdlets.

As you invest more heavily into PowerShell and you read the help files, you may get to the point that you will realize which cmdlet to use and what the parameter is you need, but you cannot remember how to use the parameter.  Get-Help can focus on the specific parameter of a cmdlet.

Get-Help Stop-Process –Parameter ID

 PS C:\> Get-Help Stop-Process –Parameter ID

-Id
    Specifies the process IDs of the processes to be stopped. To specify multiple IDs, use commas to separate the IDs. To find the PID of a process, type
    "get-process". The parameter name ("Id") is optional.
   
    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

This displays the full help file for the –ID parameter of Stop-Process.  If you just want the parameter section of the help file type:

Get-Help Stop-Process –Parameter *

If you want just the examples:
Get-Help Stop-Process –Examples

If you would like to keep multiple help files open in a searchable window, try this:
Get-Help Stop-Process –ShowWindow

Also, if you prefer and online help file in a web browser:
Get-Help Stop-Process –Online

This is it for help on cmdlets.  Tomorrow we will look at more ways to use Get-Help


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

Where did a User’s Account Get Locked Out?

By
Updated: May 15, 2015 When this article was originally published, two extra carriage returns were add causing the code to malfunction.  The code below is correct.   My client for this week’s PowerShell class had a really interesting question. They needed to know where an account is being locked out at. OK, interesting. Apparently users hop around clients and forget to log off, leading to eventual lock out of their accounts. The accounts can be unlocked, but are then relocked after Active Directory replication. This problem is solved in two parts. The first one is to modify the event auditing on the network. The second part is resolved with PowerShell. The first part involves creating a group policy that will encompass your Domain Controllers. In this GPO, make these changes. Expand Computer Configuration \ Policies \ Windows Settings \ Security Settings \ Advanced Audit Policy Configuration \ Audit Policies \ Account Management Double click User Account Management C...
18 comments
Read more