Beginning PowerShell for SharePoint 2016

Transcription

1 Beginning PowerShell for SharePoint 2016 A Guide for Administrators, Developers, and DevOps Engineers Second Edition Nikolas Charlebois-Laprade John Edward Naguib

2 Beginning PowerShell for SharePoint 2016: A Guide for Administrators, Developers, and DevOps Engineers Nikolas Charlebois-Laprade John Edward Naguib Gatineau, Québec, Canada Cairo, Egypt ISBN-13 (pbk): ISBN-13 (electronic): DOI / Library of Congress Control Number: Copyright 2017 by Nikolas Charlebois-Laprade and John Edward Naguib This work is subject to copyright. All rights are reserved by the Publisher, whether the whole or part of the material is concerned, specifically the rights of translation, reprinting, reuse of illustrations, recitation, broadcasting, reproduction on microfilms or in any other physical way, and transmission or information storage and retrieval, electronic adaptation, computer software, or by similar or dissimilar methodology now known or hereafter developed. Trademarked names, logos, and images may appear in this book. Rather than use a trademark symbol with every occurrence of a trademarked name, logo, or image we use the names, logos, and images only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark. The use in this publication of trade names, trademarks, service marks, and similar terms, even if they are not identified as such, is not to be taken as an expression of opinion as to whether or not they are subject to proprietary rights. While the advice and information in this book are believed to be true and accurate at the date of publication, neither the authors nor the editors nor the publisher can accept any legal responsibility for any errors or omissions that may be made. The publisher makes no warranty, express or implied, with respect to the material contained herein. Cover image designed by Freepik Managing Director: Welmoed Spahr Editorial Director: Todd Green Acquisitions Editor: Gwenan Spearing Development Editor: Laura Berendson Technical Reviewer: Adam Driscoll Coordinating Editor: Nancy Chen Copy Editor: James A. Compton, Compton Editorial Services Compositor: SPi Global Indexer: SPi Global Artist: SPi Global Distributed to the book trade worldwide by Springer Science+Business Media New York, 233 Spring Street, 6th Floor, New York, NY Phone SPRINGER, fax (201) , orders-ny@springer-sbm.com, or visit Apress Media, LLC is a California LLC and the sole member (owner) is Springer Science + Business Media Finance Inc (SSBM Finance Inc). SSBM Finance Inc is a Delaware corporation. For information on translations, please rights@apress.com, or visit rights-permissions. Apress titles may be purchased in bulk for academic, corporate, or promotional use. ebook versions and licenses are also available for most titles. For more information, reference our Print and ebook Bulk Sales web page at Any source code or other supplementary material referenced by the author in this book is available to readers on GitHub via the book s product page, located at For more detailed information, please visit Printed on acid-free paper

3 Thanks to my parents for raising, helping, and support. Thanks to my wife and my daughter for understanding and support. Thanks to my whole family. I love you so much. John Naguib To my beautiful kids Eloïk & Emy, and wife Krystel. Thanks for allowing me to always reach my goals in life and set even bigger ones once I reach them. Nik

4 Contents at a Glance About the Authors...xvii About the Technical Reviewer...xix Acknowledgments...xxi Chapter 1: Introduction... 1 Chapter 2: What s New in SharePoint Chapter 3: PowerShell Basics Chapter 4: Installing and Deploying SharePoint with PowerShell Chapter 5: Managing SharePoint with PowerShell Chapter 6: Monitoring SharePoint with PowerShell Chapter 7: Upgrading from SharePoint 2013 to 2016 with PowerShell Chapter 8: Managing Office 365 SharePoint Online with PowerShell Chapter 9: Managing Add-ins and Solutions using PowerShell Chapter 10: Extending PowerShell for SharePoint Appendix: Common Cmdlets Index v

5 Contents About the Authors...xvii About the Technical Reviewer...xix Acknowledgments...xxi Chapter 1: Introduction... 1 The SharePoint Challenges... 1 History of PowerShell... 3 What Is PowerShell?... 4 SharePoint Foundation versus SharePoint Server... 6 What You Will Learn in This Book... 6 Summary... 6 Chapter 2: What s New in SharePoint New Features... 7 Zero Downtime Patching... 7 OneDrive Redirection... 7 File Size... 7 Durable Links... 9 App Launcher...10 Fast Site Creation Filename Support Hybrid Search Sharing of Documents with QR Code vii

6 Contents Office Online Server (OOS) Automatic Indexing for Large SharePoint Lists MinRoles Summary Chapter 3: PowerShell Basics Terminology Session Cmdlets...21 Profile Snap-In Module PowerShell Operators and Common Operations Printing Values on Screen Console Colors Variables Comments Casting Conditional Logic Functions Loops Piping Instance Referrer Error Handling Enumerations...34 Arrays Environment Variables WhatIf Rollback Graphical User Interface Demo Project Selective Deletion of Files in a Folder Customization viii

7 Contents Leaping Ahead Desired State Configuration Dynamic Method and Property Names Summary Chapter 4: Installing and Deploying SharePoint with PowerShell Requirements Hardware Requirements Software Requirements Roles and Features Domain Controller Users and Groups Application Server Role Installing the Software Components Installing SQL Server Installing SharePoint Prerequisites Installing SharePoint Configuring Your SharePoint Farm Creating the Databases Configuring Central Administration Creating Your First Web Application Creating Your Root Site Collection Granting Users Access Putting It All Together Writing to the Registry Automatic Login Script Orchestrator Summary ix

8 Contents Chapter 5: Managing SharePoint with PowerShell x Interacting with Objects Site Collections Webs Lists Creating a New List Removing a List Instance Restoring a List Instance Copying a List Instance Putting It Together: Creating Common Lists List Items List Fields Permissions List Permissions on an Object Breaking Permission Inheritance Granting New Permissions Removing Permissions Updating Permissions Objects Disposal Summary Chapter 6: Monitoring SharePoint with PowerShell Features Getting a Reference to an Existing Feature Activating a Feature Disabling a Feature Backups Viewing Backup History Automating a Site-Collection Backup Restores Restoring a Site Collection Backup Disabling a Timer Job

9 Contents Enabling a Timer Job Changing a Timer Job s Schedule Starting a Timer Job Managing Services Getting a Reference to a Service Instance Starting a SharePoint Service Instance Stopping a SharePoint Service Instance SharePoint Health Analyzer Getting References to Health Analyzer Rules Disabling a SharePoint Health Analyzer Rule Enabling a SharePoint Health Analyzer Rule Summary Chapter 7: Upgrading from SharePoint 2013 to 2016 with PowerShell Why Should I Upgrade? The Upgrade Process Overview of the Source Environment Copying the Database to the New Farm Restoring the Database to the New Farm Upgrading the Content Database Additional Steps Summary Chapter 8: Managing Office 365 SharePoint Online with PowerShell Overview of the Environment SharePoint Online Management Shell Connecting to the Office 365 Instance Listing Available Commands SharePoint Online Cmdlets Site Collections SPOSiteGroup Users xi

10 Contents Apps Tenant Web Doing More with the Client Context Summary Chapter 9: Managing Add-ins and Solutions using PowerShell Solutions Types of Solutions Adding a New Farm Solution Apps Configuring your Environment to Support Apps App Management Service Application The Microsoft SharePoint Foundation Subscription Settings Service Application Final Configuration Steps Importing an App Package Exporting App Packages Installing an App Package Uninstalling a SharePoint App The App Catalog Creating an App Catalog Adding an App to the Catalog Managing App Permissions Updating an Existing App Summary Chapter 10: Extending PowerShell for SharePoint Creating Modules and Cmdlets Creating a Function Summary xii

11 Contents Appendix: Common Cmdlets Set-SPServer Get-SPFarmConfig Set-SPPassPhrase Add-SPSolution Backup-SPFarm Backup-SPSite Copy-SPSite Disable-SPTimerJob Enable-SPTimerJob Export-SPAppPackage Export-SPWeb Get-SPAppInstance Get-SPBackupHistory Get-SPFarm Get-SPServiceApplication Get-SPServiceApplicationPool Get-SPServiceInstance Get-SPSite Get-SPTimerJob Get-SPUser Get-SPWeb Get-SPWebApplication Get-SPWebTemplate Import-SPAppPackage Import-SPWeb Install-SPApp Install-SPSolution xiii

12 Contents Mount-SPContentDatabase Move-SPSite New-SPAppManagementServiceApplication New-SPAppManagementServiceApplicationProxy New-SPConfigurationDatabase New-SPContentDatabase New-SPServiceApplicationPool New-SPSite New-SPSubscriptionSettingsServiceApplication New-SPSubscriptionSettingsServiceApplicationProxy New-SPWeb New-SPWebApplication Remove-SPConfigurationDatabase Remove-SPContentDatabase Remove-SPServiceApplication Remove-SPServiceApplicationPool Remove-SPSite Remove-SPSolution Remove-SPWeb Remove-SPWebApplication Request-SPUpgradeEvaluationSite Set-SPServiceApplicationPool Set-SPTimerJob Set-SPWeb Start-SPServiceInstance Start-SPTimerJob Stop-SPServiceInstance xiv

13 Contents Test-SPContentDatabase Uninstall-SPAppInstance Uninstall-SPSolution Update-SPAppCatalogConfiguration Update-SPAppInstance Update-SPSolution Index xv

14 About the Authors Nikolas Charlebois-Laprade is a Microsoft Premier Field Engineer in Gatineau, Canada. His background as a Software Engineer and as a Technical Program Manager makes him a well-rounded web technologies expert. Nik is always looking to fill up gaps between two technology stacks by coming up with innovative solutions that help empower the users. He is currently involved in helping various PowerShell Desired State Configuration (DSC) open-source projects reach their next level of maturity. His wife and kids are what motivates him to always push the boundaries of what s possible to achieve. John Edward Naguib is a Microsoft MVP in Office Servers and Services, an experienced collaboration & senior consultant and solution architect with deep knowledge of SharePoint. In addition to being a consultant and architect he has a strong application development background in.net. John also has experience with several other Microsoft products, including Office 365 and Azure, and holds MCP, MCTS, MCITP, MCPD, MCT, and TOGAF 9 Foundation certificates. John is a recognized SharePoint expert within the industry, speaker, event organizer, and Wiki Ninja blogger, and has published several gold award articles on Microsoft TechNet. You can find John on xvii

15 About the Technical Reviewer Adam Driscoll is an experienced software developer and a Cloud and Datacenter MVP based out of Madison, WI, USA. He has experience working with a range of Microsoft technologies and programming languages. Adam is the author of the open-source project PowerShell Tools for Visual Studio. This extension is used by thousands of developers around the world and currently ships as part of the Visual Studio installation package. xix

16 Acknowledgments Whilst writing this book I have had the help and support of many people. First I would like to thank my Microsoft MVP colleague Chendrayan Venkatesan for his recommendations; it is appreciated. Then I need to thank the fantastic team at Apress: Gwenan Spearing, Acquisitions Editor; Nancy Chen, Coordinating Editor; and Laura Berendson, Development Editor. I would like also to thank my Microosft MVP colleague Adam Driscoll for being the Technical Reviewer. I would also like to thank Microsoft Corporation and whole Microsoft MVP program for all the things you are doing for MVPs. Last but not least, I would like to thank my colleague Nikolas Charlebois-Laprade. It was an honor for me to work with him on this book and I hope we work on another project soon. John Naguib xxi