Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying PowerShell Troubleshooting Guide
  • Table Of Contents Toc
PowerShell Troubleshooting Guide

PowerShell Troubleshooting Guide

By : Michael Shepard
4.7 (3)
Buy this Book
close
close
PowerShell Troubleshooting Guide

PowerShell Troubleshooting Guide

4.7 (3)
By: Michael Shepard
Buy this Book

Overview of this book

The techniques in this book apply to beginners who have just started to learn PowerShell, as well as advanced scripters who have a good grasp of the language.
Table of Contents (10 chapters)
close
close
close
Preface
Icon
Preface
Icon
What this book covers
Icon
What you need for this book
Icon
Who this book is for
Icon
Conventions
Icon
Reader feedback
Icon
Customer support
Lock Free Chapter
1
1. PowerShell Primer
Icon
1. PowerShell Primer
Icon
Introduction
Icon
Cmdlets
Icon
Functions
Icon
Scripts
Icon
Pipelines
Icon
Variables
Icon
Modules
Icon
Further reading
Icon
Summary
2
2. PowerShell Peculiarities
Icon
2. PowerShell Peculiarities
Icon
PowerShell strings
Icon
Function output
Icon
Pipeline processing
Icon
PowerShell error handling
Icon
Further reading
Icon
Summary
3
3. PowerShell Practices
chevron up
Icon
3. PowerShell Practices
Icon
Filter left
Icon
Format right
Icon
Comment-based help
Icon
Using Write-* cmdlets
Icon
Further reading
Icon
Summary
4
4. PowerShell Professionalism
Icon
4. PowerShell Professionalism
Icon
Naming conventions
Icon
Modularization
Icon
Version control
Icon
Unit testing
Icon
Further reading
Icon
Summary
5
5. Proactive PowerShell
Icon
5. Proactive PowerShell
Icon
Error handling
Icon
CmdletBinding()
Icon
SupportsShouldProcess
Icon
Parameter value validation
Icon
Pipeline input
Icon
Pipelines and function execution
Icon
Parameter type transformation
Icon
#REQUIRES statements
Icon
Set-StrictMode and Set-PSDebug -strict
Icon
Further reading
Icon
Summary
6
6. Preparing the Scripting Environment
Icon
6. Preparing the Scripting Environment
Icon
Validating operating system properties
Icon
Validating service status
Icon
Validating disk and memory availability
Icon
Validating network connectivity
Icon
Further reading
Icon
Summary
7
7. Reactive Practices – Traditional Debugging
Icon
7. Reactive Practices – Traditional Debugging
Icon
Reading error messages
Icon
Using Set-PSDebug
Icon
Debugging in the console
Icon
Debugging in the ISE
Icon
Event logs
Icon
The PSDiagnostics module
Icon
Using –confirm and –whatif
Icon
Reducing input set
Icon
Using Tee-Object to see intermediate results
Icon
Replacing the foreach loop with the foreach-object cmdlet
Icon
Further reading
Icon
Summary
8
8. PowerShell Code Smells
Icon
8. PowerShell Code Smells
Icon
Code smells
Icon
Language-agnostic code smells
Icon
PowerShell-specific code smells
Icon
Missing Param() statements
Icon
Homegrown common parameters
Icon
Unapproved verbs
Icon
Accumulating output objects
Icon
Sequences of assignment statements
Icon
Using untyped or [object] parameters
Icon
Static analysis tools – ScriptCop and Script Analyzer
Icon
Further reading
Icon
Summary
9
Index
Icon
Index

Comment-based help

As mentioned in Chapter 1, PowerShell Primer, the help system in PowerShell is very useful. When writing functions and scripts in PowerShell, it is important to provide the same kind of documentation so users are able to use the code correctly.

In order to get the minimal amount of help available, the only requirement is to create a function. Take a look at the following screenshot, for example, shows the help content generated automatically for a simple function:

Comment-based help

There is even help for specific parameters, as shown in the following screenshot:

Comment-based help

It should be clear that PowerShell is using the definition of the function to generate the help content. This is extremely helpful for several reasons, some of which are listed as follows:

  • The syntax section is never out of sync with the definition. There is no need to worry about missing or misspelled parameters or whether the brackets are in the right places.
  • It is not necessary to create a separate file (or any file at all) in order...
CONTINUE READING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
PowerShell Troubleshooting Guide
End of Section 3
Next Section
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon