Get-SpeModule
Returns the object that describes a Sitecore PowerShell Extensions Module

Syntax

Get-SpeModule -Item <Item>
Get-SpeModule -Path <String>
Get-SpeModule -Id <String> -Database <String>
Get-SpeModule -Database <String>
Get-SpeModule [-Database <String>] -Name <String>

Detailed Description

The Get-SpeModule command returns the object that describes a Sitecore PowerShell Extensions Module.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Item <Item>

A script or library item that is defined within the module to be returned.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false

-Path <String>

Path to a script or library item that is defined within the module to be returned.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Id <String>

Id of a script or library item that is defined within the module to be returned.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Database <String>

Database containing the module to be returned.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false

-Name <String>

Name fo the module to return. Supports wildcards.
Aliases
Text
Required?
true
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
    System.String

Outputs

The output type is the type of the objects that the cmdlet emits.
  • Spe.Core.Modules.Module

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

Return all modules defined in the provided database
1
PS master:\> Get-SpeModule -Database (Get-Database "master")
Copied!

EXAMPLE 2

Return all modules defined in the master database Matching the "Content*" wildcard
1
PS master:\> Get-SpeModule -Database (Get-Database "master")
Copied!

EXAMPLE 3

Return the module the piped script belongs to
1
PS master:\> Get-item "master:\system\Modules\PowerShell\Script Library\Copy Renderings\Content Editor\Context Menu\Layout\Copy Renderings" | Get-SpeModule
Copied!

Related Topics