Since every environment is different, all code should not be run in a production environment without your team or organization thoroughly testing first. We recommend the use of a test lab environment often referred to as a development/staging instance of Sitecore.

The disclaimer is provided because someone somewhere will inevitably not follow this recommendation and if they do hose their Sitecore environment, they have no one to blame but themselves.

All data and information provided in this book are for informational purposes only. Adam Najmanowicz, Michael West, and the SPE Team make no representations as to accuracy, completeness, currentness, suitability, or validity of any information in this book and will not be liable for any errors, omissions, or delays in this information or any losses, injuries, or damages arising from its display or use. All information found in this book is provided "as is" with no express or implied warranties.

Administration

Note: Examples included in the following modules

• System Maintenance

Analytics

Database

Globalization

Preferences

Reports

Note: Examples included in the following modules

• System Maintenance

Security

Here we'll discuss the Console, ISE, and other dialogs made available through SPE.

Thank you for taking the time to check out the latest and greatest changes for SPE. Send a tweet sharing how much you love the module on Twitter.

The following links provide a way to report issues and get the latest release.

• Book issue tracker

• Module issue tracker

See the for a compatibility matrix.

About the Module

The (SPE) module is a Sitecore development accelerator that can drastically increase your productivity and curtail the amount of time it takes to deliver a Sitecore solution.

The module provides a command line (CLI) and a scripting environment (ISE) for automating tasks. SPE works with the Sitecore process, capable of making native calls to the Sitecore API and manipulating files. Running commands and writing scripts follow the standard and well-known Windows PowerShell syntax. Windows PowerShell is a common tool used in IT for desktop and server management, so we decided to stick with that as a framework to build upon.

Colors

The Console, ISE, and Result dialog all provide a way a way to view output data. The $host variable provides access to configuring the colors for this output data.

Example: The following configures colors for the background and forground text in multiple streams.

Sitecore PowerShell Extensions provides an organization structure composed of modules, libraries, and scripts. Modules make up the highest level and can be grouped together by module folders.

Some benefits to using modules:

• The contained within each module can be enabled or disabled globally. For this to take full affect the integration should be rebuilt in the ISE.

• Organization of custom scripts is a cinch.

The Functions integration allows for scripts to be discoverable through autocomplete while authoring scripts. Functions can be "disabled" by disabling the containing module.

1. Begin by adding a script library called "Functions" to a module. This can be created by the new module wizard.

2. Add a script to the "Functions" script library with a name that represents the purpose.

3. Use the command Import-Function

The Sitecore task scheduler is capable of running PowerShell scripts when using the task command PowerShellScriptCommand. The Task Management module includes a few shortcuts to managing tasks.

The module provides the ability to create, edit, and run scheduled tasks.

References

You can include custom ribbon commands in the ISE to aid in improving the script authoring experience.

Add a custom plugin

For this example, we wish to have a plugin that analyzes the script and reports on any errors.

Create a new script stored under the following structure:

The Workflows integration allows for scripts to run like workflow commands. Rules can be used to control visiblity and enablement. The script is only executed when the command is triggered.

1. Begin by adding a new item to a workflow command of template type /Modules/PowerShell Console/PowerShell Script Workflow Action. We've added an insert option to help with this.

2. Edit the Type string field to your custom type or to the built in type Spe.Integrations.Workflows.ScriptAction, Spe.

Manage Templates

Change Template

Scripted Data Sources provide a way to use a PowerShell script to perform complex queries.

Here are some good reasons to use this feature:

• Delivering complex functionality based on multiple criteria.

• Your field may need to provide different set of items to choose from based on:

  • user name or role (in simplest case this can be done using right management, but maybe not always possible in a more elaborate scenario)

  • current day or month?

  • In a multisite/multimarket scenario you may want to show different items for each site

    based on engagement analytics parameters of the page

    based on where in the tree an item exist (some of it can be done with use of a “query:”)

  • anything you might want to build the code data source for…

Something that would be beyond the reach of a regular Sitecore query and potentially something that you would really need to deliver code source for. But maybe you’re not in a position to deploy that on your environment?

Field Data Source

Field Data Source provides a great opportunity for a script.

Below are field types you may wish to use a script:

• Checklist

• Droplist

• Grouped Droplink

• Grouped Droplist

Rendering Data Source Roots

//TODO

Rendering Data Source Items

//TODO

References

• PowerShell Scripted Data Sources and

• Sitecore Spark on using scripted datasources

Notification

The Notification integration reveals to the user a notification above the content. The Sitecore rules engine may be used to control the enabled state; simply configure the Enable rule on the script. The script is executed every time the page loads.

Example: The following adds an information notification to the page for Sitecore 8 and a warning for Sitecore 7.

$title = "Thank you for using SPE!"
$text = "Today is $([datetime]::Now.ToLongDateString())"
$icon = @{$true="Office/32x32/information.png";$false="Applications/16x16/warning.png"}[$SitecoreVersion.Major -gt 7]

$notification = New-Object -TypeName Sitecore.Pipelines.GetPageEditorNotifications.PageEditorNotification -ArgumentList $text, "Info"

$notification.Icon = $icon
$pipelineArgs.Notifications.Add($notification)

Note: Examples included in the following modules

• License Expiration

Experience Button

The Experience Button integration adds a button to the Page Editor. Rules can be used to control visiblity and enablement. The script is only executed when the button is clicked.

1. Begin by adding a new script to the Experience Button library. The name of the script will appear in the tooltip.

2. Edit the script to perform the appropriate actions. The script can run in the background and show dialogs.

3. Change the icon of the item to match the script purpose.

4. Configure any Enable

Example: The following adds a command which will display a dialog asking a question, then send an email with the response.

Use the following in your scripts to get access to the arguments passed to the processor.

 $pipelineArgs = Get-Variable -Name pipelineArgs -ValueOnly

Configure any Enable rules to ensure your script only runs when necessary.

Logging In

Note: Examples included in the following modules

• Enforce user password expiration

Logged In

Note: Examples included in the following modules

• Automatically show quick info section

Logout

Note: Examples included in the following modules

• Unlock user items on logout

There are multiple methods of accessing help documentation in SPE to provide you with information on the commands available to you.

Viewing all available commands

A report is available which will show you all available SPE commands:

When executed, this report provides a paged view of the SPE commands.

Viewing command help

Console

To display the available help for a command in the Console, simply use the Get-Help command:

For full documentation, including examples, use the -Full parameter:

ISE

Through the Integrated Scripting Environment (ISE), SPE provides a method of acccessing help for available commands. To view the help for a command, simply highlight the command and press Ctrl + Enter.

After doing this, a dialog will appear with the relevant help information:

Documenting functions

When writing scripts, you are able to include formatted comments that will be used to provide help text for functions. If formatted correctly, this help text will be available through the methods described above.

Example: A simple function with documentation:

Once the script containing this function has been invoked, the help text will be available:

For further information on comment-based help, refer to the .

Online appendix

Online help is additionaly available for all SPE commands in this documentation, with detailed explanations of commands and their parameters, along with useful examples. These can be found in the .

The Event Handler integration provides a way to execute scripts when defined events are fired.

Steps required to activate this integration include the following:

1. Enable the Spe.Events.config or apply your own patch with the required events enabled.

2. Add a new integration point library to your new or existing module.

3. Add a new script to the appropriate event library.

4. Configure an Enable Rule if needed.

5. Profit!

Enable Configuration

While SPE comes with an example configuration, which is disabled by default, it contains several events that may not meet your requirements.

An event configuration patch may look like the following:

Add Event Script

To mimic the event item:added you should create nested script libraries such as Event Handlers -> Item -> Added followed by a script.

Prerequisites

Take a quick look at the to see which version of SPE you should be installing that is compatible with your Sitecore environment. Generally SPE has pretty good backwards compatibility but may require a new version to support the latest Sitecore CMS release.

• Windows Management Framework 5.1 (PowerShell) is generally available for most Windows environments.

Imports a CliXml string with data that represents Microsoft .NET objects and creates the objects within PowerShell.

Syntax

ConvertFrom-CliXml [-InputObject] <String>

Relink Item

Example: The following changes the image linked on an item to a new image. Originally posted .

The section on working with items provided a variety of examples in retrieving items based on their language. In this section will show how to manage items and their languages.

Add Language Version

Example: The following example queries all of the content items and adds a new language version of "en-ca", while overwriting any that exist.

Example: The following example adds a language version from English to US and Polish while leaving the Title field blank. If a version already exists nothing happens.

Example: The following example adds a language version from English to Polish of Template Name Sample Item. If the version exists a new version is created for that language. Finally the results are displayed as a table showing only the Name, Language, and Version.

Example: The following example adds a language version in Polish to the Home item and all its children. If the version exists nothing happens. No fields were harmed in the making of this version.

Remove Language Version

Example: The following example queries all of the content items and removes the language version of "fr-CA".

New Item with Forced Language Version

Example: The following example creates a new item with language versions only matching the specified languages; all other language version are removed.

Parameters and Configuration

Supported parameters:

• -Recurse Translates item and its children

• -IfExist Accepts one of 3 pretty self explanatory actions: Skip, Append or OverwriteLatest

On top of the ignored fields in the -IgnoredFields the following fields are ignored as configured within the Spe.config file:

References

The task scheduler is a great way to run scripts in a periodic fashion. You may find the need to automatically archive log files into a compressed file. Perhaps send an email with a generated report based on stale site content.

Video Tutorial

Click for a demo

Scheduled Task Command

To help make the setup simple, we've provided a Task Command.

The command shown above is simply a type exposed as a public method in the Spe assembly. There exists an update method which accepts one or more items and executes the associated script.

Beneath Schedules you can create as many tasks as Sitecore will allow. Configure the Command and Items fields like that shown below.

The Items field contains the path to a script in the Script Library.

Below are some of the scripts found out-of-the-box with SPE.

Create and Manage Tasks

We've added a context menu item to provide you with a shortcut to the Task Scheduler Editor.

Create a new scheduled task:

Run or edit the scheduled task:

The scheduled task is capable of running 1-to-many scripts. Choose all that apply for the selected task. Each script runs within a shared session, making it possible to share results between scripts.

Note: Make use of the Enable Rule to take advantage of the rules engine.

The task schedule has an intuitive dialog for working with and changing the frequency.

Note: Examples included are in the following modules

• License Expiration

• Media Library Maintenance

• System Maintenance

See how Adam added .

The Web API integration point exposes scripts through a url. This can be especially helpful when a script needs to be executed on the server but without knowledge of the script contents.

The url will look something like the following: https://remotesitecore/-/script/v2/master/homeanddescendants?user=sitecore\admin&password=b

Here's the url broken down:

• API Version - Specifies which service is being requested.

  • v2 - This is the service that executes scripts stored in the integration point library.

• Database - Specifies which database contains the script.

  • master - This database requires the credentials to be provided.

• Script - Specifies the name of the script contained in the database. The SPE module containing the script needs to be enabled otherwise you'll receive a 404 error.

  • homeanddescendants - Replace this name with whatever your script is called in the Web API library.

• Query String Parameters (deprecated) - Specifies the additional bits of data for use by the web service.

  • user and password - Authenticates the request and in most cases will be needed. If the script is published to the web database the credentials are not required. You should use the Basic header instead of the query string.

  • All of the query string parameters added to the variable scriptArguments

Headers:

Use the Basic header to provide authentication information. Here is an example of how to build that for a script.

Note: Examples included in the following modules

• Getting Started

Security

The integration point is disabled by default and can be enabled through configuration as described . See Restfulv2. Be sure to enable the SPE script module in the content tree.

References

• Watch Adam present this and much more on Sitecore! Experienced .

Ever wanted to package up items and files without opening the Sitecore Package Designer each time? There are a number of commands available for generating packages.

Package Creation

Example: The following example demonstrates how to generate a package.

$package = New-Package "Package-of-Stuff"
$package.Sources.Clear()

$package.Metadata.Author = "Michael West"
$package.Metadata.Publisher = "Team Awesome"
$package.Metadata.Version = "1.0"
$package.Metadata.Readme = @"
Set of instructions for the user.
"@

# Items using New-ItemSource and New-ExplicitItemSource
$source = Get-Item -Path "master:\templates\Feature\Forms" | 
    New-ItemSource -Name 'Feature Forms Items' -InstallMode Overwrite
$package.Sources.Add($source)

# Files using New-FileSource and New-ExplicitFileSource
$source = Get-Item -Path "$AppPath\App_Config\Include\Feature\Forms\Company.Feature.Forms.config" | 
    New-ExplicitFileSource -Name "Feature Forms Files"
$package.Sources.Add($source)

Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).xml"
Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"

Post Step

Example: The following adds a Post Step and custom attributes.

Example: The following adds a Post Step included with SPE to delete a file. The SPE Post Step code reads xml data stored in the comment section of the package.

Example: The following adds a Post Step Script included with SPE to change icons. The SPE Post Step code executes a script included with the package as stored in the attributes section.

Exports Microsoft .NET objects froms PowerShell to a CliXml string.

Syntax

ConvertTo-CliXml [-InputObject] <PSObject>

Detailed Description

The ConvertTo-CliXml command exports Microsoft .NET Framework objects from PowerShell to a CliXml string.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-InputObject <PSObject>

Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to ConvertTo-CliXml.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• object

Outputs

The output type is the type of the objects that the cmdlet emits.

• System.String

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE

Related Topics

• ConvertFrom-Xml

• ConvertTo-Xml

General

We generally see issues occurring due to an incompatible version of Windows PowerShell. Be sure to install Windows PowerShell version 3 or newer.

Installation

Elevated Session Hanging

There is an additional configuration file added to support Identity Server. If you are installing Sitecore 9.1 or later you will want to enable the configuration file Spe.IdentityServer.config.

Hanging Installation Wizard

Some users have reported an where the package installation in Sitecore hangs while installing SPE. One possible fix is to disable the Sitecore Analytics feature; this of course assumes you do not plan on using it for your instance.

Article: Martin Miles encountered the issue and proposed a fix .

Hack: Run this script on Sitecore 8.0.

Exception Messages

ISE throws exception when /sitecore/content/home is missing

• - Missing Home item (fixed in 3.2)

Modules

Integration Point is not working

Be sure the module is enabled and the integrations are rebuilt from within the ISE. The following are some of the integration issues you may experience:

• Content Editor Gutter - Entries not listed.

• Content Editor Ribbon - Buttons not visible or working.

• Control Panel - Entries not listed.

• Functions - Import-Function name parameter not populating with functions or can't be found after running the command.

Remoting

• 404 error in browser console can be caused by missing SPE files, a custom pipeline, or perhaps a rewrite rule.

• "The request failed with an empty response." could be caused when TLS is offloaded to a load balancer and traffic to the endpoint is no longer over HTTPS. Fixed by issue #.

• "The underlying connection was closed: An unexpected error occurred on a send." could be caused in Azure PaaS when requests are made using TLS 1.1 or lower. Setting the SecurityProtocol may help. Thanks to Jayesh Sheth for pointing to a resolution.

The world renowned Sitecore PowerShell Extensions module has so much to offer, but sometimes those new to the module may find it difficult to know where to start. This training guide provides you with everything you need to use and be productive with SPE.

Don't worry, you will be able to use it without having to write any code.

Learning Path

This guide provides a progressive roadmap from beginner to advanced SPE user. Follow this path to build your skills systematically:

The Console is a command line interface (CLI) designed for efficiency, providing a streamlined tool for working with Windows PowerShell and Sitecore.

The default security configuration for SPE requires the Console to be in an before allowing the execution of commands. The following figure shows the Console when the User Account Controls (UAC) are disabled. While this is a common configuration for developers, we highly encourage you to ensure UAC is enabled in higher environments.

Shortcuts

Below are the shortcuts available in the console.

In this section we'll show how to manage item renderings.

List renderings

Example: The following demonstrates the use of Get-LayoutDevice and Get-Rendering to find all renderings on a page associated with the FinalLayout.

The SPE Modules support a wide variety of predefined script libraries to help with exposing scripts to the Sitecore interface.

The following list outlines the available libraries for Integration Points that may be added to modules. These may also be generated automatically when creating or updating modules.

The PowerShell Toolbox is quick way to access frequently used scripts.

Navigate to Sitecore -> PowerShell Toolbox and after selecting you should see the configured scripts:

Note: Examples included in the following modules

• Authorable Reports

• Logged in Session Manager

Edit MultilistField

Example: The following demonstrates how to set a field to a known list of Ids. The Id is already converted to a GUID string.

Example: The following replaces an instance of an Id with an alternate Id. The Id is already converted to a GUID string.

Example: The following adds new Ids to an existing list. Makes use of the Sitecore.Text.ListString class.

Returns Sitecore database archives.

Syntax

Get-Archive [[-Database] <Database>] [[-Name] <String>]

Returns the current user's browser user agent.

Syntax

Detailed Description

Closes the runner job window after the script completes.

Syntax

Close-Window

The following guide should provide you with enough information to setup a development environment configured to contribute to SPE. We'll begin with a single installation of Sitecore 8+.

The solution requires Visual Studio 2015 or later.

This guide assumes a source root location of "C:\Source" and a site root location of "C:\inetput\wwwroot". These are not prerequisites of the project, and you can use whatever folder locations suit you.

Single Instance for Sitecore 8 & 9

1. Meet the prerequisites found

2. Install Sitecore 8+ to a folder of your choice, for example C:\inetpub\wwwroot\SitecoreSPE_8

3. Clone the repo to your local development environment

Any changes you make going foward just require a build of the solution. Remember that when pulling down updates to the source, you should execute a Unicorn sync to ensure your items are up to date.

Multiple Instances

The SPE deployment process supports multiple sites and multiple versions of Sitecore. The following steps carry on from above to add further support for another Sitecore site, such as 8.x or 9.x.

1. Complete the steps for a Single Instance.

2. Install Sitecore 8.x/9.x to a folder of your choice, for example C:\inetpub\wwwroot\SitecoreSPE_91

3. Edit the sites definition in deploy.user.json to add your new Sitecore web root folder. Set the version property to 9.0

SPE can be deployed to as many Sitecore sites as you like. Each time you first deploy to a new installation, make sure you use Unicorn to sync the latest state of items into Sitecore.

Optional: PowerShell Remoting support

To add the SPE PowerShell Remoting Module scripts into your machine's PowerShell Module path, execute the .\Setup_Module.ps1 script from the source folder. This will add the \Modules folder from source into your PSModulePath environment variable. Once this is done, you can use Import-Module SPE on your development machine to run the remoting scripts.

Optional: Junction Support

As part of the SPE deployment process, all of the relevant binary, configuration and sitecore module files are copied over from the projects within the solution. This means that any changes to static files such as JS / CSS files require a full build for these to be deployed to the site. As the build triggers an application pool recycle of your site, this can be a little slow for quick changes.

For more rapid development, you can enable junction deployment on your sites. When this is enabled, rather than copying over the static files, will be setup for various folders so that the folders within the Sitecore installation are directly linked to the source folder. Any changes made in the solution are seen instantly, because the solution and the site are referencing the exact same files.

To enable a junction deployment for a site, add junction property to the site definition and set it to true:

Note that with junction deployments, a solution build is still required if you want to deploy any code or .config changes.

It is not currently supported for a junction deployment site to be changed back into a non-junction deployment site. If you wish to do this, you should manually delete the following folders from your Sitecore installation before updating the junction property back to false: sitecore modules\PowerShell and sitecore modules\Shell\PowerShell

Syntax

Detailed Description

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Script <String>

-OnScriptEnd <SwitchParameter>

Retrieves a Sitecore cache.

Syntax

Get-Cache [[-Name] <String>]

Detailed Description

The Get-Cache command retrieves a Sitecore cache.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Name <String>

Name of the cache to retrieve. Supports wildcards.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Sitecore.Caching.Cache

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE

Related Topics

Avoid these common mistakes when starting with SPE. Learning from others' errors will save you time and frustration.

Forgetting Item Editing Context

Items in Sitecore cannot be modified directly. You must use the editing context.

The Integrated Scripting Environment (ISE) is a great way to group together commands and save for later use. This tool helps you write scripts in Powerful Ways!

The default security configuration for SPE requires the ISE to be in an before executing scripts. The following figure shows the ISE when the User Account Controls (UAC) are disabled. While this is a common configuration for developers, we highly encourage you to ensure UAC is enabled in higher environments.

Let's have a quick walk through of each ribbon tab available.

Home Tab

Retrieves a Sitecore Database.

Syntax

Get-Database [[-Name] <String>] [-Item <Item>]

There are some really amazing contributions and add-ons to SPE from the community.

Unicorn

A well known and widely adopted module Unicorn has published some SPE commands. These commands are available (and optional) after installing Unicorn. Below are some samples ripped off from Kam Figy's blog posts here and here.

Configurations

Example: The following lists configurations by name.

Syncing

Example: The following syncs configurations just like you would through the Unicorn Control Panel or the PowerShell API.

Partial Syncing

Reserializing

Partial Reserializing

Converting to Raw Yaml

Converting from Raw Yaml

Deserialization

Packaging

SPE Modules

The following are Sitecore modules that enhance the SPE experience.

• :

• :

• :

The Sitecore PowerShell Extensions (SPE) module provides powerful cmdlets for managing Sitecore content items. This section covers everything you need to know about working with items programmatically.

Quick Start

The core item management cmdlets mirror standard PowerShell conventions:

Documentation Topics

Fundamentals

Before working with items, understand these foundational concepts:

• - PowerShell providers and navigating Sitecore databases

• - Built-in variables available in SPE scripts

Core Item Operations

Learn how to perform essential item operations:

• - Find items by path, ID, query, or URI

• - Update properties, work with field types, and manage versions

• - Create new items and delete existing ones

• - Transfer and duplicate items

Specialized Operations

Handle specific aspects of item management:

• - Add, remove, and manage language versions

• - Work with presentation details and renderings

• - Manage item permissions and access control

Advanced Topics

Optimize your scripts and follow best practices:

• - Performance optimization, bulk operations, and coding patterns

Common Patterns

Pattern: Find and Update Items

Pattern: Bulk Create Items

Pattern: Copy Content Between Databases

Pattern: Audit and Report

Dynamic Parameters

SPE extends standard PowerShell cmdlets with dynamic parameters specific to Sitecore. These parameters appear based on context:

• Language - Specify language versions (-Language "en-US" or -Language *)

• Version - Specify item versions (-Version 2 or -Version *)

• Database - Target specific databases when using IDs

See the page for detailed parameter documentation.

Path Formats

SPE supports multiple path formats for flexibility:

Note: The /sitecore portion is optional when using provider paths.

Working with Field Types

SPE provides intelligent handling of Sitecore field types through automated PowerShell properties:

See for comprehensive field type examples.

Performance Considerations

When working with large datasets, consider these performance tips:

• Use fast: queries instead of Get-ChildItem -Recurse when possible

• Leverage BulkUpdateContext for multiple updates

• Use SecurityDisabler judiciously for read operations

See for detailed performance guidance.

See Also

• - Securing SPE and managing users/roles

• - Core cmdlet reference

• - Security cmdlet reference

• - Automate item operations remotely

Getting Help

This guide helps you quickly secure your Sitecore PowerShell Extensions installation with essential security configurations.

Critical Security Warnings

Quick Security Checklist

Before deploying SPE to any environment beyond your local development machine, complete these essential steps:

✓ Environment Assessment

• Confirm this is a Content Management (CM) server

• Verify the server is NOT internet-facing

• Ensure the server is behind a firewall

• Confirm this is NOT a Content Delivery (CD) instance

✓ Web Services Security

By default, all SPE web services are disabled except those required for the Sitecore UI. Keep them disabled unless you have a specific need.

• Review enabled services in App_Config\Include\Spe\Spe.config

• Only enable services you specifically need

• Configure HTTPS for any enabled external services

• Review the documentation

✓ User Access Control

• Review default role permissions (under core:\content\Applications\PowerShell)

• Ensure only trusted administrators have access

• Enable Session Elevation (UAC) for production environments

• Configure appropriate token expiration times

✓ Application Pool Security

• Review the application pool service account permissions

• Ensure the account follows the principle of least privilege

• Verify file system access is restricted to necessary directories only

• Consider using a named service account instead of ApplicationPoolIdentity

✓ Content Editor Security

• Verify PowerShell Console visibility is restricted to sitecore\Developer role

• Verify PowerShell ISE visibility is restricted to sitecore\Developer role

• Review context menu security settings

• Test that non-privileged users cannot access SPE features

Initial Configuration Steps

Step 1: Review Default Settings

The default security configuration is found in:

• App_Config\Include\Spe\Spe.config

Do not modify this file directly. Instead, create configuration patch files.

Step 2: Create Your Security Patch

Create a new configuration file: App_Config\Include\Spe\Custom\Spe.Custom.config

Example: Basic production security configuration:

Step 3: Configure IIS Authentication

Protect the SPE services directory at the IIS level.

Edit sitecore modules\PowerShell\Services\web.config:

This denies anonymous access to all SPE web services.

Step 4: Test Your Configuration

1. Log in as a non-administrator user

2. Verify you cannot access the PowerShell Console

3. Verify you cannot access the PowerShell ISE

4. Log in as an administrator

Environment-Specific Recommendations

Development Environment

For local development machines, you may use relaxed settings:

QA/Staging Environment

Use the same strict security as production, but you may extend session timeouts slightly for testing convenience:

Production Environment

Use the strictest settings:

For Azure AD/SSO environments, use:

Identity Server Configuration (Sitecore 9.1+)

If using Sitecore 9.1 or later with Identity Server, enable this configuration file:

File: App_Config\Include\Spe\Spe.IdentityServer.config

This prevents infinite loops in the SPE Console when using OWIN cookie authentication.

Next Steps

After completing the initial setup:

1. Review the to understand the security model

2. Configure for your environment

3. If you need external access, carefully review security

4. Learn about

Common Mistakes to Avoid

❌ Don't install on CD servers - SPE is for CM only ❌ Don't expose to the internet - Keep SPE behind firewalls ❌ Don't use Allow elevation in production - Always require password or confirmation ❌ Don't enable unnecessary web services - Only enable what you specifically need ❌ Don't grant broad access - Limit to administrators only ❌ Don't skip session elevation - UAC is critical for production environments

Getting Help

If you need assistance with SPE security:

• Review the detailed documentation

• Check the

• Visit the

• Join #module-spe on Sitecore Community Slack

Returns all the clones for the specified item.

Syntax

Get-ItemClone [-Item] <Item>

Get-ItemClone [-Path] <String>

Get-ItemClone -Id <String> [-Database <String>]

Detailed Description

The Get-ItemClone command returns all the clones for the specified item.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Item <Item>

The item to be analysed for clones presence.

-Path <String>

Path to the item to be analysed for clones presence.