Automating. Administration. Microsoft SharePoint with Windows. PowerShell 2.0. Gary Lapointe Shannon Bray. Wiley Publishing, Inc.

Automating

Microsoft®

SharePoint®

2010

Administration

with Windows

PowerShell®

2.0

Gary Lapointe

Shannon

_Bray

WILEY

TABLE

B®S8®0©«4}®8#«l6&

OF

CONTENTS

Introduction

xxv

Part

1

_Getting

_{Started With Windows Powershell Basics}

₁

Chapter

1 Windows PowerShell 101 3

Prepare

for Your

_Journey

4

Automate SharePoint:AHistorical

_Perspective

5

From STSADMtoWindowsPowerShell 7

Understand_{the Components} 8

TheSharePoint 2010 ManagementShell 8

Understand_RequiredPermissions 11

Windows PowerShell: An

_Object-Based

Scripting Language 12

Discover Cmdlets and

_Objects

14

Understand Variables andTypes 21

Declare and Use Variables 21

Understand

_{Object Types}

22

Declare andUse_Arraysand HashTables 28

Work withOutput 31

Understand the

_Object

Pipelineand

_{PipeBind Objects}

31 Format YourResults 35

Chapter

2

_Filtering

and

_Iterating

Your Data 39

AddConditionalLogic 40

UseComparisonand

_{Logic Operators}

—40

Use the If/Elself/Else Statements 45

Use the SwitchStatement 47

Filter Your Data 49

Use the

_Where-Object

Cmdlet 49

Usethe

_Sort-Object

Cmdlet 51

Usethe

_{Select-Object}

Cmdlet 53

Iterate

Through

Your Data 57

Use WhileLoops 57

UseDoWhileLoops 58

Use Do UntilLoops 59

Use ForLoops 59

Use ForeachLoops 61

XVI TABLE OF CONTENTS

Chapter

3

_Making

Your

PowerShell Reusable

65

ScriptYour Solutions 66

Create and Execute

_Scripts

66

Execute

_Script

Blocks 70

Define ScriptParameters 71

Comment YourScripts 74

Understandthe UseofFunctions 75

Create Functions 76

Define Function Parameters 79

Process

_Pipeline

Data 81

UnderstandScopes 82

CompartmentalizewithModules 85

Create and LoadScriptModules 86

Create Module Manifests 88

Add Error

_Handling

toScripts 92

Throw Errors 92

UseTrapBlocks 93

Use

_{Try/Catch/Finally}

Blocks 97

Understand

_Object

DisposalIssues 100

Part 2

_Installing

and

_Configuring

a

SharePoint

2010 Environment 107

Chapter

4

_Deploying

New Installations and

_Upgrades

109

InstallSharePoint 2010 110

Review_HelperFunctions 110

DefineXMLSettingsFile 113

Run theSharePoint2010 Server Installation Files 114

Run theScript 122

BuildaSharePoint 2010 Farm 123

Create andConfigure RequiredAccounts 124

Verify SQL Connectivity 125

Create XMLSettingsFile • 126

Review the Farm Build Cmdlets 127

Review the Central Administration Site Cmdlets 132

Run theScript 136

UpgradetoSharePoint 2010 137

SharePoint

_{Upgrade Approaches}

137

Perform

_Pre-upgrade

Scan 139

UpgradeContent Database 141

TABLE OF CONTENTS XVII

Chapter

5

_Configuring

Server

Communications

145

Configure

Intra-FarmCommunications 147

Network 147

Windows Firewall 151

SQLServerandtheDatabases 156

WindowsServices 161

Configure

Inter-Server Communications 164 Active_Directory 164

Chapter

6

_Configuring

Farm

_Application

_Settings

171

ConfigureIPFS 172

Configure InfoPath Forms ServicesOptions 174

Configure

Administrator-Approved

Form

_Templates

181

ManageForm

_Templates

, 184

ManageData Connection Files 186

ConfigureWebService Proxies 187

Configure

ContentDeployment 188

PreparetheEnvironment 189

ManageContent

_Deployment

Jobs 193

Configure

Incomingand_Outgoing Email 199

Configure

OutgoingEmail 200

Configure

IncomingEmail 201

Part 3

_Deploying

and

_{Managing Applications}

207

Chapter

7

_Managing

Web

_Applications

209

Configure ApplicationPools , 210

Distinguish Typesof

_Application

Pools 210

List and Control

_Application

Pool State 213

CreateApplicationPools 217

Create and Extend Web

_Applications

220

CreateaNew Web

Application

221

ExtendaWeb

Application

223

Use XML Files for_ScriptingWeb

_Applications

224

Understand AlternateAccess_Mapping 226

CreateaNew IIS

_Binding

229

Adda NewAlternateAccess _Mapping 229

EditIIS

_Bindings

230

Edit Alternate AccessMappings 231

Remove a_Bindingfrom IIS 232

XVIII TABLE OF CONTENTS

ConfigureWeb

_Applications

234

Modify

the General

_Settings

ofaWeb

Application

234

Work with

_Managed

Paths 243

Implement Security

246

Manage

Blocked File_Types 246

Manage UserPermissions 247

ManageWeb _ApplicationPolicies 250

AccessWeb

Applications

from the Server 253

Configurethe

DisableLoopbackCheck

Setting 254

Configure

the BackConnectionHostNamesSetting 254

Chapter

8

_Managing

Site

Collections

and Sites 257

Understand Site Collections and Sites 258

Manage

Site Collections 260

CreateaSite Collection 261

RetrieveaSite Collection 265

Modify

aSiteCollection 267

DeleteaSite Collection 269

MoveaSite Collection 269

ManageSiteCollectionsas aFarmAdministrator 270

Manage

Sites 271 CreateaSite 272 RetrieveaSite 273 ModifyaSite 275 DeleteaSite 278 Configure Auditing 278

Configure

AuditLog

Trimming

279

Configure

Audit

_Settings

for Documents and Items 280

Configure

Audit

_Settings

forLists, Libraries,and Sites 281

ManageQuotas and Locks 282

CreateaNew Quota

Template

283

RetrieveQuota

Templates

283

Apply

aQuota

Template

toaSite Collection 284

Configure

Locks 285

Manage

Security 287

Manage

SharePointGroups 290

ManageSharePointUsers 294

Create Permission Levels 301

Chapter

9

_{Understanding}

Authentication

303

Understand the Various Forms of Authentication 304

TABLE OF CONTENTS XIX

Configure

Classic Mode Web

_Applications

310

Configure

Secure Sockets

_Layer

₃₁₁

Configure

Kerberos 312

Configure

ClaimsMode Authentication 315

CreateaWeb

Application Using

Claims_{Mode Authentication 315}

Configure

Forms-BasedAuthentication 317

RetrieveanAuthentication Provider ₃₂₀

ConfigureSharePointtoUseaClaim ₃₂₁

Chapter

10

_Managing

Features

and Solutions

329

Deploy

and

_Manage

Features 330

Understand theComponentsofaFeature 331

Retrieve Features 335

InstallFeatures ₃₃₉

Uninstall Features 341

Activate Features 342

Deactivate Features 343

Deploy

andManageFarm Solutions 345

AddaFarm Solution ₃₄₆

Deploy

aFarm Solution ₃₄₇

Retrieve Farm Solutions 349

RetractaFarm Solution 350

RemoveaFarm Solution ₃₅₂

Update

aFarm Solution ₃₅₂

Start AdministrationJobs 354

RemoveaFarm Solution_DeploymentLock 355

Deploy

and

_Manage

SandboxedSolutions 356

The Solution

_Gallery

₃₅₇

AddaSandboxed Solution ₃₅₈

Deploy

aSandboxed Solution 359

RetrieveSandboxedSolutions 360

RetractaSandboxedSolution 362

RemoveaSandboxed Solution 362

Update

aSandboxedSolution 363

Part

4 Services

and Service

_Applications

367

Chapter

11

_Managing

Service

_Applications

369

Manage

Service Instances 371

Retrieve Service Instances ₃₇₁

Start Service Instances 373

Stop

Service Instances 375

XX TABLE OF CONTENTS

Retrieve Service

_Applications

377

Create Service

_Application

Pools 378

Create Service

_Applications

381

Manage

Service

_Application

Proxies 382

RetrieveServiceApplication Proxies 382

CreateServiceApplicationProxies 383

Manage Proxy Groups 384

SecureService _Applications 388

Retrieve Service_ApplicationAdministrators and Permissions 389 Set Service_ApplicationAdministratorsandPermissions 391

PublishandConsume ServiceApplicationsAcross Farms 394

ExportCertificates 396

Establish the Trust

_Relationship

396

Grant Permissions 397

PublishaService

Application

400

Connectto aService

_Application

401

Chapter

12

_Provisioning

_Support

Services 403

Provision Web

_Analytics

Services 404

Provision the Web

_Analytics

ServicesServiceApplication 405

Test the Service

_Application

412

Provision StateServices 412

Provision theState ServicesServiceApplication 413

TesttheStateServices Service

_Application

417

Provision Secure Store Services 417

ProvisiontheSecure Store Services Service

_Application

418 GenerateaSecure

Key

₄₂₂

TesttheSecureStore Services Service

_Application

423

Provision UserCodeServices 423

Start the User Code Service 423

Setthe User Code Service

_Identity

424

Test the User Code Service 426

ProvisionClaimstoWindows TokenServices ₄₂₆

Start the c2wts ServiceInstance 427

Set thec2wts

_Identity

₄₂₈

Reset thec2wts

_Identity

₄₂₈

Test the ClaimstoWindows Token Service 429

Provision

_Usage

andHealthData Collection Services 430

Provision the ServiceApplication 430

Provision the ServiceApplication

Proxy

431

Configure

the Service Instance 432

TABLE OF CONTENTS XXI

Chapter

13

_Provisioning

Business

_{Intelligence,}

Business

_{Connectivity,}

and Word

Automation Services 437

Provision Excel Services 438

Provision the Excel Services ServiceApplication 439

Create theSecure Store_{Target Application} 442

Test theService_Application 446

ProvisionAccessServices 448

Enable theSession State Service 449

Provision the Access Services Service

_Application

451

Test the ServiceApplication 454

Provision VisioGraphicsServices 456

Provision the Visio ServicesService

_Application

457

Create the Secure Store

_{Target Application}

460

Test the Service

_Application

461

Provision PerformancePointServices 462

Provision the PerformancePointService_Application 464

Set the UnattendedService Account 467

Test theService

_Application

468

Provision Business_ConnectivityServices 470

Provision theBCS Service_Application 471

Test theService_Application •.474

ProvisionWordAutomationServices 476

Provision theWord Automation Services Service

_Application

476

Test the Service

_Application

₄₇₉

Chapter

14

_Provisioning

Search

Services 481

Understand EnterpriseSearch

_Concepts

482

Understand Administration

_Topology

_Components 482

Understand

_{Query Topology Components}

483

Understand Crawl

_{Topology Components}

485

Understand

_Query

Processor_Components 486

Understand ServicePlacement 487

Understand the

_Crawling

Process 488

Retrieve_EnterpriseSearch Services 491

Retrieve theService

_Application

492

Retrievethe_{Crawl Components 492}

Retrieve the_{Query Components} 493 Retrievethe Crawl Database 494 Retrieve the_PropertyDatabase 495

ProvisionEnterpriseSearch Services 496

XXII TABLE OF CONTENTS

Start the ServiceInstance 497

Configure

the Search Service 499

Create the ServiceApplication 501

Configure

the AdministrationComponent 504

Createthe Crawl andQuery Components 506 Createthe Service

_Application

Proxy 518

PerformaFullorIncremental Crawl 519

ProvisionFoundationSearch Services 520

StarttheFoundationSearch Service 521

ExamineFoundationSearch ServicesSettings 526

Startand_StopFull Crawls 526

Chapter

15

Provisioning

Metadata and User Profile Services 527

ProvisionManaged MetadataServices 528

Provision the

Managed

MetadataServices

Service

_Application

528

Test the ServiceApplication 535

Provision User Profile Services 536

Provision the User Profile Services ServiceApplication 537

Test the ServiceApplication 545

Provision the User ProfileSynchronizationService 545

Test the

_{Synchronization}

Service 548

Address Common Issues 551

Part

5

_Managing

and

_Maintaining

a

SharePoint Environment

557

Chapter

16

_{Managing Operational Settings}

559

Manage Logging

560

ReviewDiagnostic

Configuration

Settings 562

Modify

Diagnostic

Configuration

Settings 563

Review

_Log

Levels 565

Modify

LogLevels 567

Reset_LogLevels 568

Create New Log Files 569

Merge

Existing Log Files 569

Review_LogEvents 571 Write_LogEvents 573 Examinethe HealthAnalyzer 577

Review and

_Modify

Rule Definitions 578 Review FailedRules 579

ManageTimerJobs 581

ReviewTimer Jobs 581

ExecuteaTimer Job 583

TABLE OF CONTENTS XXIII

Understand the

_Developer

Dashboard 585

Overviewofthe

_Developer

Dashboard 585

Configure

the_DeveloperDashboard 587

Chapter

17 Back

_Up

and Restorea SharePoint Environment 591

BackUpand RestoreaFarm 592

BackUpaFarm 593

BackUpanInactive Farm

_{Configuration}

597

Restorea Farm 600

Retrieve_{Backup History} 603 BackUpand RestoreaSite Collection 605

BackUpaSiteCollection 605

RestoreaSite Collection 607

Export

andImportSites and Lists 609

Export

aSiteorList 610

Import

aSiteorList 613

Chapter

18

_Optimizing

the Performance ofa SharePoint Environment 617

Configure

Resource

_Throttling

618

Configure

PerformanceCounter_Monitoring 620

Monitor HTTP

Throttling

625

Configure Caching Options 629

Configure Page Output Caching 629

Configure Object Caching 631

ConfigureBLOBCaching 634

Configure

Remote BLOBStorage 636

ConfigureRBSinSQL Server 638

MigrateContent toAnother Provider 641

DisableRBS 642

Part 6

Advanced

Administration

643

Chapter

19 Remote Administration 645

Use ClassicRemoting 646

Configure

Windows PowerShellRemoting 649

Enable

_Remoting

650

Enable CredSSP 652

Increase

_Memory

for Remote Sessions 654 ExecuteRemote Commands 655

Use Invoke-Command 656

UseEnter-PSSession 661

Uselmport-PSSession 663

XXIV TABLE OF CONTENTS

Configure

Sessions 672

CreateSession

_{Configurations}

672

SecureSession

Configurations

676

Chapter

20

_{Multi-Tenancy}

679

CreateaTenantHostingWebApplication 681

Create the WebApplication 683

Create theManaged Paths 684

ConfigureServiceApplications 685

Provision the

_Subscription

SettingsService 685

Configure

Tenant Services 688

ManageFeature Packs and SiteSubscriptions 695

Manage

Feature Packs 696

Manage

Site

_{Subscriptions}

699

Provision Tenants 701

CreateMember Sites 701

CreatetheTenantAdministrationSite 702

Configure

UserProfileand_ManagedMetadata

Service

_Applications

703 Store Tenant Information 705