book

Windows PowerShell Best Practices

Name: Windows PowerShell Best Practices
Author: Ed Wilson
ISBN: 9780735676589

by Ed Wilson

January 2014

Intermediate to advanced

760 pages

20h 7m

English

Microsoft Press

Read now

Unlock full access

Windows PowerShell Best Practices
Dedication
Foreword
Introduction
Who is this book for?How is this book organized?System requirementsThe companion websiteAcknowledgementsSupport & feedbackErrataWe want to hear from youStay in touch
I. Understanding the basics of Windows PowerShell
1. Survey of Windows PowerShell capabilities
Understanding Windows PowerShellInstalling Windows PowerShellDeploying Windows PowerShellUsing cmdletsUsing command-line utilitiesSecurity issues with Windows PowerShellControlling execution of Windows PowerShell cmdletsConfirming commandsSuspending confirmation of cmdletsWorking with Windows PowerShellAccessing Windows PowerShellConfiguring Windows PowerShellSupplying options for cmdletsWorking with the help optionsUpdating help informationDiscovering information in helpAdditional resources
2. Using the CIM cmdlets
Using the CIM cmdlets to explore WMI classesUsing the classname parameterFinding WMI class methodsFiltering classes by qualifierRetrieving WMI instancesReduce returned properties and instancesClean up output from the commandWorking with Association classesAdditional resources
II. Planning for scripting
3. Using the Active Directory module
Understanding the Active Directory moduleInstalling the Active Directory moduleGetting started with the Active Directory moduleUsing the Active Directory moduleFinding the FSMO role holdersDocumenting Active DirectoryRenaming Active Directory sitesManaging usersCreating a userFinding and unlocking AD user accountsFinding disabled usersFinding unused user accountsAdditional resources
4. Identifying scripting opportunities
Automating routine tasksAutomation interfaceUsing RegRead to read the registryUsing WMI to read the registryUsing .NET to read the registryUsing intrinsic Windows PowerShell techniquesStructured requirementsSecurity requirementsDetecting the current userDetecting the user role.NET Framework version requirementsOperating system requirementsApplication requirementsModule requirementsAdditional resources

5. Configuring the script environment
Configuring a profileCreating aliasesCreating functionsOverriding existing commandsAliasing the functionLooping the arrayPassing multiple parametersMultiple parameters with $argsMultiple named parametersCreating variablesCreating PSDrivesEnabling scriptingCreating a profileChoosing the correct profileCreating other profilesAccessing functions in other scriptsCreating a function libraryUsing an include fileAdditional resources
6. Avoiding scripting pitfalls
Lack of cmdlet supportComplicated constructorsVersion compatibility issuesTrapping the operating system versionLack of WMI supportWorking with objects and namespacesListing WMI providersWorking with WMI classesChanging settingsModifying values through the registryLack of .NET Framework supportUse of static methods and propertiesVersion dependenciesLack of COM supportLack of external application supportAdditional resources
7. Tracking scripting opportunities
Evaluating the need for the scriptReading a text fileExport command historyFan-out commandsQuery Active DirectoryUsing [ADSISearcher]Using Active Directory cmdletsJust use the command lineCalculating the benefit from the scriptRepeatabilityDocumentabilityAdaptabilityScript collaborationAdditional resources
III. Designing the script
8. Designing the script
Understanding functionsUsing functions to provide ease of code reuseUsing two input parametersUsing a type constraintUsing more than two input parametersUsing functions to encapsulate business logicUsing functions to provide ease of modificationUnderstanding filtersAdditional resources
9. Designing help for scripts
Adding help documentation to a script with single-line commentsWorking with temporary foldersUsing multiple-line comment tags in Windows PowerShell 4.0Creating multiple-line comments with comment tagsCreating single-line comments with comment tagsUsing comment-based helpThe 13 rules for writing effective commentsUpdate documentation when a script is updatedAdd comments during the development processWrite for an international audienceConsistent header informationDocument prerequisitesDocument deficienciesAvoid useless informationDocument the reason for the codeUse of one-line commentsAvoid end-of-line commentsDocument nested structuresUse a standard set of keywordsDocument the strange and bizarreAdditional resources
10. Designing modules
Understanding modulesLocate and load modulesListing available modulesLoading modulesInstall modulesCreating a modules folderWorking with the $modulePath variableCreating a module driveChecking for module dependenciesUsing a module from a shareCreating a moduleAdditional resources
11. Handling input and output
Choosing the best input methodReading from the command lineUsing the $args automatic variableSupplying multiple values to $argsUsing the Param statementCreating a mandatory parameterUsing parameter attributesCreating a parameter aliasValidating parameter inputUsing multiple parameter argumentsWorking with passwords as inputStore the password in the scriptStore the password in a text fileStore the password in the registryStore the password in Active Directory Domain ServicesPrompt for the passwordWorking with connection strings as inputPrompting for inputChoosing the best output methodOutput to the screenOutput to fileSplitting the output to both the screen and the fileOutput to emailOutput from functionsAvoid populating the global variableUsing a namespace in the global variableAdditional resources
12. Handling errors
Handling missing parametersCreating a default value for the parameterDetecting the missing value and assigning it in the scriptAssigning the value in the Param statementMaking the parameter mandatoryLimiting choicesUsing PromptForChoice to Limit SelectionsUsing ping to identify accessible computersUsing the −contains Operator to examine the contents of an arrayUsing the −contains operator to test for propertiesHandling missing rightsAttempting and failingChecking for rights and exiting gracefullyUsing #RequiresRequire Administrator rightsRequiring specific modulesHandling missing WMI providersIncorrect data typesOut of bounds errorsUsing a boundary checking functionPlacing limits on the parameterAdditional resources
13. Testing scripts
Using basic syntax checking techniquesLooking for errorsRunning the scriptDocumenting what you didConducting performance testing of scriptsUsing the store and forward approachUsing the Windows PowerShell pipelineComparing the speed of two scriptsReducing code complexityEvaluating the performance of different versions of a scriptCommand-line parametersFunctionsDisplaying the results and creating the log fileUsing standard parametersUsing the debug parameterUsing the Verbose parameterUsing the whatif parameterUsing Start-Transcript to produce a logAdvanced script testingAdditional resources
14. Documenting scripts
Getting documentation from helpGetting documentation from commentsUsing the AST parserAdditional resources
IV. Deploying the script
15. Managing the execution policy
Selecting the appropriate script execution policyThe purpose of script execution policiesUnderstanding the different script execution policiesUnderstanding the Internet zoneDeploying the script execution policyModifying the registryUsing the Set-ExecutionPolicy cmdletUsing the Set-ExecutionPolicy cmdlet on a local computerUsing the Set-ExecutionPolicy cmdlet via a logon scriptUsing Group Policy to deploy the script execution policyUnderstanding code signingAdditional resources
16. Running scripts
Logon scriptsWhat to include in logon scriptsMethods of calling the logon scriptsScript folderDeploy locallyDeploy an MSI package locallyStand-alone scriptsDiagnosticsReporting and auditingHelp desk scriptsAvoid editingProvide a good level of help interactionAdditional resources
17. Versioning scripts
Why version control?Avoid introducing errorsEnable accurate troubleshootingTrack changesMaintain a master listingMaintain compatibility with other scriptsInternal version number in the commentsIncrementing version numbersTracking changesVersion control softwareAdditional resources
18. Logging results
Logging to a text fileDesigning a logging approachOverwriting the logAppending to the logUsing the Out-File cmdletText locationNetworked log filesWriting directly to the fileWriting to the local file and copying to the networkLogging to the event logUsing the Aapplication logCreating a custom event logLogging to the registryAdditional resources
19. Troubleshooting scripts
Understanding debugging in Windows PowerShellWorking with syntax errorsWorking with runtime errorsWorking with logic errorsUsing the Set-PSDebug cmdletTracing the scriptWorking with trace level 1Working with trace level 2Stepping through the scriptEnabling strict modeUsing Set-PSDebug -strictUsing the Set-StrictMode cmdletDebugging scriptsSetting breakpointsSetting a breakpoint on a line numberSetting a breakpoint on a variableSetting a breakpoint on a commandResponding to breakpointsListing breakpointsEnabling and disabling breakpointsDeleting breakpointsAdditional resources
20. Using the Windows PowerShell ISE
Running the Windows PowerShell ISENavigating the Windows PowerShell ISEWorking with the script paneTab expansion and IntelliSenseWorking with Windows PowerShell ISE snippetsUsing Windows PowerShell ISE snippets to create codeCreating new Windows PowerShell ISE snippetsRemoving user-defined Windows PowerShell ISE snippetsAdditional resources
21. Using Windows PowerShell remoting and jobs
Understanding Windows PowerShell remotingClassic remotingWinRM—Windows Remote ManagementCreate a remote Windows PowerShell sessionRun a single Windows PowerShell commandUsing Windows PowerShell jobsAdditional resources
22. Using Windows PowerShell Workflow
Why use Windows PowerShell WorkflowWorkflow requirementsA simple workflowParallel PowerShellWorkflow activitiesWindows PowerShell cmdlets as activitiesDisallowed core cmdletsNon-automatic cmdlet activitiesParallel activitiesCheckpointing a Windows PowerShell workflowUnderstanding checkpointsPlacing checkpointsAdding checkpointsWorkflow checkpoints are freeCheckpoint activityUsing the CheckPoint-Workflow activityAdding a sequence activity to a workflowAdditional resources
23. Using the Windows PowerShell DSC
Understanding Desired State ConfigurationThe DSC processConfiguration parametersSetting dependenciesConfiguration dataCreating users with the user providerCreating groups with the group providerControlling configuration driftAdditional resources
A. About the author
Index
About the Author
Copyright

Content preview from Windows PowerShell Best Practices

Chapter 4. Identifying scripting opportunities

Automating routine tasks

One of the most important tasks when developing a scripting program is to track and coordinate the development endeavors of the scripting team. However, this process is not done in most companies. As a result, much time is wasted developing multiple scripts that perform the same tasks and implement similar functionality.

This is an area in which the judicious application of collaboration tools can play a significant role. One such collaboration tool that can easily be pressed into service is the Microsoft SharePoint Portal product. The discussion forum can be used to track requests for scripts, ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9780735676589Purchase book

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills

Windows PowerShell Best Practices

by Ed Wilson

Chapter 4. Identifying scripting opportunities

Automating routine tasks

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.