How to Read Help Files (Part 6 of 7)

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

Comments

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory. To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.

How to run GPResult on a remote client with PowerShell

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.

Error icon when creating a GPO Preference drive map

You may not have an error at all. Take a look at the drive mapping below. The red triangle is what threw us off. It is not an error. It is simply a color representation of the Replace option of the Action field in the properties of the drive mappings. Create action This give you a green triangle. The Create action creates a new mapped drive for users. Replace Action The Replace action gives you a red triangle. This action will delete and recreate mapped drives for users. The net result of the Replace action is to overwrite all existing settings associated with the mapped drive. If the drive mapping does not exist, then the Replace action creates a new drive mapping. Update Action The Update action will have a yellow triangle. Update will modify settings of an existing mapped drive for users. This action differs from Replace in that it only updates settings defined within the preference item. All other settings remain as configured on the mapped drive. If the

Jason Yoder, MCT

Search This Blog