Invoking an installation

To start a Sitecore installation, use the following syntax:


Install-SitecoreConfiguration [-Path] <String> [[-Tasks] <String[]>] [[-From] <String>] [[-To] <String>]
[[-Skip] <String[]>] [[-WorkingDirectory] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

This starts the Sitecore installation and uses the given configuration loaded from the specified path.

The working directory is set as follows:

  • If provided, the working directory is set to the given path.
  • The current directory is used.

One or more tasks can also be passed to enable the execution of only a selection of tasks from the full configuration. If no tasks are passed (or an empty list is provided) all the tasks are executed. Task execution can be further restricted by using the From and To parameters to specify an inclusive subset of tasks.

The parameters contained in the configuration file can also be overridden at the command line.

Examples

Examples based on JSON configuration files.

Example 1

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json

Starts an installation based on a JSON configuration file.

Example 2

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -Tasks Alpha,Beta,Epsilon

Starts an installation based on a JSON configuration file and executes only the named tasks.

Example 3

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -Skip Alpha,Beta

Starts an installation based on a JSON configuration file and executes all the tasks except the named tasks.

Example 4

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -From Beta

Starts an installation based on a JSON configuration file and executes from the specified task.

Example 5

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -From Alpha -To Beta

Starts an installation based on a JSON configuration file and executes all the tasks from the task named Alpha to the task named Beta.

Example 6

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -SiteName 'MySite'

Starts an installation based on a JSON configuration file and overrides the value for the SiteName parameter contained in that file.

Example 7

PS C:\> Install-SitecoreConfiguration -Path .\MyConfig.json -SkipValidation

Starts an installation based on a JSON configuration file and skips parameter validation.

If you have suggestions for improving this article, let us know!