Home > Store

PowerShell for SharePoint 2013 How-To

Register your product to gain access to bonus material or receive a coupon.

PowerShell for SharePoint 2013 How-To


  • Sorry, this book is no longer in print.
Not for Sale

eBook (Watermarked)

  • Your Price: $19.03
  • List Price: $23.79
  • Includes EPUB and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    Adobe Reader PDF The popular standard, used most often with the free Acrobat® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.


  • Copyright 2013
  • Edition: 1st
  • Book
  • ISBN-10: 0-672-33691-X
  • ISBN-13: 978-0-672-33691-1

Need fast, reliable, easy-to-implement solutions for automating SharePoint 2013 administration with PowerShell? This guide delivers exactly what you’re looking for: step-by-step help and guidance with the tasks you’ll perform most often. You’ll find tested PowerShell scripts and techniques for managing installations, servers, farms, IIS, users, services, sites, data, solutions, enterprise services, search, PerformancePoint business intelligence, and more. This edition adds time-saving techniques for managing user licensing and new SharePoint 2013 service applications, covers new cmdlets, and contains two new reference appendices. This focused resource for scripting SharePoint with PowerShell provides all the answers you need—now!

Fast, Accurate, and Easy to Use!

  • Run PowerShell scripts from the SharePoint 2013 Management Shell console
  • Perform unattended SharePoint installations
  • Configure new farms, add servers, and manage sites
  • Create new site collections and sub-sites
  • Review and set Farm Configuration Values and SharePoint Designer Settings
  • Display, get, create, remove, configure, and extend web applications
  • Create, manage, remove, back up, and restore SharePoint databases
  • Work with SharePoint solutions and features
  • Automatically publish and manage content
  • Establish and change external data connections via Business Data Connectivity Service
  • Control the new versions of Excel, Access, Visio, and Word Services
  • Script Office Web Apps to deliver more robust web/mobile solutions
  • Manage PerformancePoint business intelligence via cmdlets
  • Administer Enterprise Search, InfoPath Form Services, profiles, metadata, and Secure Store
  • Streamline Work Management Services to help users track tasks more efficiently



Download free content for PowerShell for SharePoint 2013 How-To here

Sample Content

Online Sample Chapter

PowerShell Basics for SharePoint 2013

Sample Pages

Download the sample pages (includes Chapter 2 and Index)

Table of Contents

Introduction     1

Overview of This Book     1

How to Benefit from This Book     1

How to Continue Expanding Your Knowledge     2

1 SharePoint 2013 Management Shell     3

How Do I Run PowerShell?     4

How Do I Make PowerShell Aware of SharePoint?     5

What Is the SharePoint 2013 Management Shell?     5

What Is the SharePoint 2013 Management Shell Loading?     6

2 PowerShell Basics     9

What Is a Cmdlet?     10

How Can I See the Possible Verbs for a Noun Command?     10

What Is a Parameter?     10

What Is a Switch Parameter?     10

How Can I See the Possible Parameters for a Cmdlet?     11

What Does F3 Do?     11

What Does F7 Do?     11

What Are Console Commands?     12

Path Environment Variable     13

Running Unsigned Scripts     13

Disabling the Confirmation Prompt     14

Generating Inline Credentials     14

Referencing an Assembly     15

3 SharePoint Installation and Configuration     17

Prepare the Microsoft SharePoint Installation Module     18

Install SharePoint Unattended     19

Install Without a Product Key in the Configuration File     20

Configure a New SharePoint Farm      21

Join a Server to the SharePoint Farm     22

Create a New Web Application     22

Create a New Site Collection     23

Create a New Subsite     24

4 Farm Management     27

Review Farm Configuration Values     28

Set the Farm Configuration Values     28

Refresh Installed Products     30

Change the Port of Central Admin     30

Change the Farm Passphrase     30

Retrieve the System Accounts     31

Retrieve Managed Accounts     32

Rename a Server on the Farm     32

Display the Configured Managed Paths     33

Create a New Managed Path     34

Remove a Managed Path     34

Merge Log Files     35

End the Current Log File     36

Review SharePoint Designer Settings     36

Configure SharePoint Designer Settings     37

Review Workflow Configuration Settings    38

Modify Workflow Configuration Settings     39

Display Available Timer Jobs on the Farm     40

Get a Specific Timer Job     41

Enable a Timer Job     41

Disable a Timer Job     42

Start a Timer Job     42

Set the Schedule for a Timer Job    43

5 Web Application Management     45

Display Available Web Applications on the Farm     46

Get a Specific Web Application     46

Remove a Web Application     47

Create a New Web Application     48

Configure Web Application Settings     48

Extend a Web Application     49

Create an Alternate Access-Mapping URL     50

Display All Alternate Access Mappings     51

Get a Specific Alternate URL Entry     51

Change the Zone of an Alternate Access Mapping     51

Remove an Alternate Access Mapping     52

6 Service Application Management     53

Install Service Applications     54

Display Available Service Applications on the Farm     54

Get a Specific Service Application     55

Configure IIS Settings for a Service Application     55

Share a Service Application     57

Remove a Service Application     57

Display Service Instances on a Server     57

Get a Specific Service Instance     58

Start a Service Instance     59

Stop a Service Instance     59

Ancillary Cmdlets for Service Applications     60

7 SharePoint Database Management     61

Display All SharePoint Databases     62

Get a Specific Database     63

Create a New Content Database      63

Display All Content Databases for a Web Application     64

Detach a Content Database from a Web Application     65

Attach a Content Database to a Web Application     65

Delete a Content Database     66

Create a New Configuration Database      66

Delete a Configuration Database     67

Back Up a Configuration Database     67

Restore a Configuration Database     68

Back Up the SharePoint Farm     69

Restore the SharePoint Farm     69

Back Up a Site Collection     70

Restore a Site Collection     70

8 Site Management     71

Display All Available Site Collections on the Farm     72

Display Available Site Collections in a Web Application     72

Display Available Site Collections in a Content Database     73

Get a Specific Site Collection     73

Remove a Site Collection     74

Create a Site Collection     74

Set the Lock State of a Site Collection     75

Set the Storage Limits on a Site Collection     76

Create a Site Under a Site Collection     76

Display All Subsites Within a Site Collection     77

Get a Specific Subsite (Web)      78

Remove a Subsite (Web) from a Site Collection     78

Modify the Subsite (Web) URL     79

Move a Site Collection to a Different Content Database     79

Move All Site Collections from One Content Database to Another     80

Display All Deleted Site Collections     80

Display Deleted Site Collections in a Content Database     81

Get a Specific Deleted Site Collection     81

Remove a Deleted Site Collection     82

Restore a Deleted Site Collection     82

Configure Information Rights Management (IRM) Settings     83

9 Solutions and Features     85

Add a Solution to the SharePoint Farm     86

Display Available Solutions on the Farm     86

Get a Specific Solution     87

Deploy a Solution to a Web Application     87

Retract a Solution     88

Upgrade a Deployed Solution     89

Remove a Solution from the SharePoint Farm     90

Add a Sandboxed Solution to a Site Collection     90

Display Available Sandboxed Solutions in a Site Collection     91

Get a Specific Sandboxed Solution     91

Activate a Sandboxed Solution     91

Deactivate a Sandboxed Solution     92

Upgrade a Deployed Sandboxed Solution     92

Remove a Sandboxed Solution from a Site Collection     93

Display Available Features     93

Get a Specific Feature     94

Activate a Feature     95

Deactivate a Feature     95

Install a Feature in SharePoint     96

Uninstall a Feature from SharePoint     97

Export Installed Farm Solutions     97

10 Content Deployment     99

Create a New Deployment Path    100

Display Deployment Paths Configured on the Farm    100

Get a Specific Content Deployment Path    101

Remove a Content Deployment Path    101

Create a New Deployment Job    102

Display Deployment Jobs Configured on the Farm    102

Get a Specific Content Deployment Job    103

Remove a Content Deployment Job    103

Start a Content Deployment Job     103

Modify Content Deployment Configurations    104

11 User Licensing     105

Display User Licensing Status     106

Enable User Licensing Enforcement     106

Disable User Licensing Enforcement     107

Display Available User Licenses     107

Create a New License Mapping     108

Add a New License Mapping     108

Display All License Mappings     109

Remove a License Mapping    110

12 InfoPath Forms Services     111

Browser-Enabled Form Templates     112

Throttle Data Connection Timeouts     112

Throttle the Data Connection Response Size     113

Modify Authentication Settings     113

Configure Session State     114

Enable View State     115

Verify and Upload a Form Template     116

Upload Multiple Form Templates at Once     116

Activate or Deactivate a Form to or from a Site Collection     117

Remove a Form from InfoPath Form Services      117

Quiesce a Form from InfoPath Form Services     118

Enable the Web Service Proxy     118

Export Forms Services Administration Files     119

Import Forms Services Administration Files    120

13 Enterprise Search     121

Display the Enterprise Search Service Information     122

Display Enterprise Search Service Instances     122

Get a Specific Enterprise Search Service Instance     123

Configure the Crawl Account for Enterprise Search    124

Configure the Enterprise Search Service Performance Level     124

Display Enterprise Search Service Applications     125

Get a Specific Enterprise Search Service Application     126

Create a Custom Metadata Category     126

Display Available Metadata Categories     127

Get a Specific Metadata Category     127

Create a Custom Metadata Crawled Property     128

Display Available Crawled Properties     129

Get a Specific Metadata Crawled Property     130

Create a Custom Metadata-Managed Property     130

Display Available Managed Properties     131

Get a Specific Metadata-Managed Property     132

Create a Metadata Mapping     133

Use Advanced Cmdlets for Search     133

14 Profile Service     135

Get the Identity of the Profile Service Application     136

Get a Specific Profile Service Application Instance     136

Configure Settings on the Profile Service Application     137

Remove Old Comments     137

Remove Old Ratings     138

Remove Old Tags     138

Update the Profile Photo Store     139

Refresh the Feed Cache     139

Refresh a Specific User’s Feed Cache     140

Use Advanced Cmdlets for the Profile Service     140

15 Business Data Connectivity Service     143

Get the Identity of the BCS Service Application     144

Get a Specific BCS Service Application Instance     144

Configure the BCS Database     145

Get a BCS Metadata Object     145

Import a BCS Model     146

Export a BCS Model     147

Set the Entity Notification Web     147

Get the Entity Notification Web     148

Create an OData Connection     148

Get an OData Connection    149

Update an OData Connection     150

16 Secure Store Service     153

Get the Identity of the Secure Store Service Application     154

Get a Specific Secure Store Service Application Instance     154

Enable Auditing for the Secure Store Service     155

Configure the Secure Store Database     155

Generate a New Master Key     156

Refresh the Encryption Key     157

Create Application Fields     157

Create a Target Application     159

Create a New Application Entry     159

17 Metadata Service     161

Get the Identity of the Metadata Service Application     162

Get a Specific Metadata Service Application Instance     162

Configure the Metadata Service Accounts     163

Configure the Term Store Database     163

Configure the Content Type Hub     164

Get the Identity of the Metadata Service Application Proxy     164

Get a Specific Metadata Service Application Proxy Instance     165

Configure the Metadata Service Connection Options     166

18 Session State and State Service     169

Enable Session State     170

Disable Session State     170

Display Session State Information     171

Configure the Timeout of the Session State     172

Display State Service Applications Configured on the Farm     173

Get a Specific State Service Application     173

Rename a State Service Application     174

Perform State Service Database Operations     174

19 Work Management Service     177

Get the Identity of the Work Management Service Application     178

Get a Specific Work Management Service Application Instance     178

Configure the Refresh Threshold     179

Configure the Search Query Threshold     179

Configure the User Synchronization Per Server     180

Get the Identity of the Work Management Service Application Proxy     181

Get a Specific Work Management Service Application Proxy Instance     181

20 Machine Translation Service     183

Get the Identity of the Machine Translation Service Application     184

Get a Specific Machine Translation Service Application Instance     184

Get the Identity of the Machine Translation Service Proxy     185

Get a Specific Machine Translation Service Application Proxy Instance     185

Configure the Translation Processes     186

Configure Translations Throughput     186

Configure Enabled Document File Extensions for Translation     188

Modify Database Information     189

Modify Translation Timeouts     190

Modify the Maximum Translation Attempts     191

Modify the Recycle Threshold     191

21 Excel Services     193

Create a Trusted File Location     194

Display All Trusted File Locations     195

Get a Specific Trusted File Location     196

Remove a Trusted File Location     197

Create a Trusted Data Connection Library     197

Display All Trusted Data Connection Libraries     198

Get a Specific Trusted Data Connection Library     199

Remove a Trusted Data Connection Library     199

Create a New Safe Data Provider     200

Display All Safe Data Providers     201

Get a Specific Safe Data Provider     201

Remove a Safe Data Provider     202

Create a Blocked File Type     202

Display All Blocked File Types     203

Get a Specific Blocked File Type     203

Remove a Blocked File Type     204

Create a User-Defined Function Reference     204

Display All User-Defined Function References     205

Get a Specific User-Defined Function Reference     206

Remove a User-Defined Function Reference     206

Modify Excel Services Objects     207

22 PerformancePoint Services     209

Configure the Unattended Service Account     210

Display the Unattended Service Account     210

Create a Trusted Content Location     211

Create a Trusted Data Source Location     212

Display All Trusted Content Locations     212

Display All Trusted DataSource Locations     213

Display Details of Trusted Locations     213

Get a Specific Trusted Location     214

Remove a Trusted Location     214

Configure PerformancePoint Services to Enforce Trusted Locations     215

Configure PerformancePoint Services Application Settings     216

23 Access Services     217

Configure the Application Log Size     218

Configure the Cache Timeout    218

Modify the Maximum Columns in a Query     219

Modify the Maximum Calculated Columns in a Query     219

Configure the Maximum Order By Clauses     220

Configure the Maximum Number of Rows in a Query     220

Configure the Maximum Number of Records in an Access Table     221

Configure the Maximum Number of Sources in a Query     222

Enable and Disable the Use of Outer Joins     222

Allow or Restrict Nonremotable Queries     223

Throttle Access Services Memory Utilization     224

Throttle Session Memory Utilization     224

Configure User Sessions     225

Limit Template Sizes     225

Modify Access Services Databases      226

24 Visio Graphics Services     227

Configure the Unattended Service Account     228

Create a New Safe Data Provider     228

Display All Safe Data Providers     229

Get a Specific Safe Data Provider     230

Remove a Safe Data Provider     230

Setting the Description of a Data Provider     231

Configuring Visio Performance Settings     231

25 Word Automation Services     233

Configure the Conversion Processes     234

Configure Conversion Throughput     234

Configure Supported Document Formats for Conversion     236

Modify Database Information     237

Modify Job Monitoring     238

Modify Conversion Timeouts     239

Modify the Maximum Conversion Attempts     239

Modify the Maximum Memory Usage     240

Disable Word 97–2003 Document Scanning     240

Disable Embedded Fonts in Conversions     241

Modify the Recycle Threshold     242

26 Office Web Apps     243

Create a New WOPI Binding in SharePoint     244

Review Current SharePoint WOPI Bindings     245

Configure the Default Action for an Application     245

Remove WOPI Bindings from SharePoint     246

Configure the WOPI SharePoint Zone     247

Disable Certain WOPI Actions     247

Resolve Invalid Proof Signature     248

A stsadm Versus SharePoint PowerShell     249

A Operations     249

B Operations     250

C Operations     250

D Operations     250

E Operations     251

G Operations     251

I Operations     252

L Operations     252

M Operations     252

O, P, and Q Operations     252

R Operations     252

S Operations     253

U Operations     254

V Operations      254

B Upgrade and Migration     255

Test-SPContentDatabase     255

Upgrade-SPContentDatabase     255

Upgrade-SPFarm     256

Test-SPSite     256

Repair-SPSite     256

Upgrade-SPSite     256

Additional Upgrade Cmdlets     256

C Enterprise Search Reference     259

Administrative     259

Crawling     259

Metadata     260

Miscellaneous     261

Querying     262

Service Application     263

Topology     264

D App Management Service Reference     265

App Settings and Configuration     265

Denied Endpoint Management     266

Installation and Provisioning of Apps     266

Marketplace Management     266

Service Application     267

Index     269


Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020