Invoke-Script

Executes a script from Sitecore PowerShell Extensions Script Library. This command used to be named Execute-Script - a matching alias added for compatibility with older scripts.

Syntax

Invoke-Script [-Item] <Item> [-ArgumentList <Object[]>]

Invoke-Script [-Path] <String> [-ArgumentList <Object[]>]

Detailed Description

Executes a script from Sitecore PowerShell Extensions Script Library.

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

Aliases

The following abbreviations are aliases for this cmdlet:

  • Execute-Script

Parameters

-Item <Item>

The script item to be executed.

Aliases

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Path <String>

Path to the script item to be executed. Path can be absolute or Relavie to Script library root. e.g. the following two commands are equivalent:

PS master:&gt; Invoke-Script 'master:\system\Modules\PowerShell\Script Library\Examples\Script Testing\Long Running Script with Progress Demo' PS master:&gt; Invoke-Script 'Examples\Script Testing\Long Running Script with Progress Demo'

Aliases

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ArgumentList <Object[]>

Aliases

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

Inputs

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

  • Sitecore.Data.Items.Item

Outputs

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

  • System.Object

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

Invoke-Script 'Examples\Script Testing\Long Running Script with Progress Demo'

EXAMPLE 2

Run a script with arguments passed in.

$scriptItem = Get-Item -Path "master:" -ID "{35311878-54EF-4E7A-9B95-3B63F5DEE97D}"

$arguments = @{
    TemplateId = "{76036F5E-CBCE-46D1-AF0A-4143F9B557AA}"
}
$scriptItem | Invoke-Script -ArgumentList $arguments

The arguments are passed and used in the called script like below:

param($params)
$templateId = $params.templateId

Get-ItemReferrer -ID $templateId

Related Topics

PreviousInvoke-JavaScriptNextInvoke-ShellCommand

Last updated