@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/get-scriptsession.md

@@ -0,0 +1,128 @@
+# Get-ScriptSession
+
+Returns the list of PowerShell Extensions script sessions running in the system.
+
+## Syntax
+
+Get-ScriptSession -Current \[-SessionType <String\[\]>\] \[-State <None \| Available \| AvailableForNestedCommand \| Busy \| RemoteDebug>\]
+
+Get-ScriptSession -Id <String\[\]> \[-SessionType <String\[\]>\] \[-State <None \| Available \| AvailableForNestedCommand \| Busy \| RemoteDebug>\]
+
+Get-ScriptSession -Session <ScriptSession\[\]> \[-SessionType <String\[\]>\] \[-State <None \| Available \| AvailableForNestedCommand \| Busy \| RemoteDebug>\]
+
+## Detailed Description
+
+The Get-ScriptSession command returns the list of PowerShell Extensions script sessions running in the system. To find all script sessions, running in the system type "Get-ScriptSession" without parameters.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Current  <SwitchParameter>
+
+Returns current script session if the session is run in a background job.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -SessionType  <String\[\]>
+
+Type of the script session to be retrieved. The SessionType is a string that identifies where the session has been launched. You can type one or more session types \(separated by commas\) and use wildcards to filter. To find currently running types of a script session, type "Get-ScriptSession" without parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -State  <RunspaceAvailability>
+
+Type of the script session to be retrieved. The parameter limits script sessions to be returned to only those in a specific state, the values should be "Busy" or "Available". To find states of currently running script sessions, type "Get-ScriptSession" without parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String\[\]>
+
+Gets the script session with the specified IDs. The ID is a string that uniquely identifies the script session within the server. You can type one or more IDs \(separated by commas\). To find the ID of a script session, type "Get-ScriptSession" without parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Session  <ScriptSession\[\]>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* None 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Spe.Core.Host.ScriptSession 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\>Get-ScriptSession
+
+Type         Key                                                                              Location                                 Auto Disposed
+----         ---                                                                              --------                                 -------------
+Console      $scriptSession$|zwlyrcmmzwisv22djsv0ej2a|8d5c3e63-3fed-0532-e7c5-761760567b83                                             False
+Context      $scriptSession$|zwlyrcmmzwisv22djsv0ej2a|renderingCopySession                    master:\content\Home                     False
+Context      $scriptSession$|zwlyrcmmzwisv22djsv0ej2a|packageBuilder                          master:\content\Home                     False
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\>Get-ScriptSession -Current
+
+Type         Key                                                                              Location                                 Auto Disposed
+----         ---                                                                              --------                                 -------------
+Console      $scriptSession$|zwlyrcmmzwisv22djsv0ej2a|8d5c3e63-3fed-0532-e7c5-761760567b83                                             False
+```
+
+## Related Topics
+
+* [Receive-ScriptSession](receive-scriptsession.md)
+* [Remove-ScriptSession](remove-scriptsession.md)
+* [Start-ScriptSession](start-scriptsession.md)
+* [Stop-ScriptSession](stop-scriptsession.md)
+* [Wait-ScriptSession](wait-scriptsession.md)
+* [https://git.io/spe](https://git.io/spe) 
+* [https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/](https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/) 
+

package/dist/tools/powershell/documentation/get-searchindex.md

@@ -0,0 +1,92 @@
+# Get-SearchIndex
+
+Returns the available Sitecore indexes.
+
+## Syntax
+
+Get-SearchIndex \[-Name <String>\]
+
+Get-SearchIndex \[-Name <String>\]
+
+## Detailed Description
+
+The Get-SearchIndex command returns the available Sitecore indexes. These are the same as those found in the Control Panel.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the index to return.
+
+| 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.
+
+* None or System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.ContentSearch.ISearchIndex 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+The following lists all available indexes.
+
+PS master:\>Get-SearchIndex
+
+Name                             IndexingState   IsRebuilding    IsSharded
+----                             -------------   ------------    ---------
+sitecore_analytics_index         Started         False           False
+sitecore_core_index              Started         False           False
+sitecore_master_index            Started         True            False
+sitecore_web_index               Started         False           False
+sitecore_marketing_asset_inde... Started         False           False
+sitecore_marketing_asset_inde... Started         False           False
+sitecore_testing_index           Started         False           False
+sitecore_suggested_test_index    Started         False           False
+sitecore_fxm_master_index        Started         False           False
+sitecore_fxm_web_index           Started         False           False
+sitecore_list_index              Started         False           False
+social_messages_master           Started         False           False
+social_messages_web              Started         False           False
+```
+
+### EXAMPLE 2
+
+```powershell
+The following lists only the specified index.
+
+PS master:\>Get-SearchIndex -Name sitecore_master_index
+
+Name                             IndexingState   IsRebuilding    IsSharded
+----                             -------------   ------------    ---------
+sitecore_master_index            Started         True            False
+```
+
+## Related Topics
+
+* [Initialize-SearchIndex](initialize-searchindex.md)
+* [Stop-SearchIndex](stop-searchindex.md)
+* [Resume-SearchIndex](resume-searchindex.md)
+* [Suspend-SearchIndex](suspend-searchindex.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/get-session.md

@@ -0,0 +1,107 @@
+# Get-Session
+
+Returns one or more Sitecore user sessions using the specified criteria.
+
+## Syntax
+
+Get-Session \[-Identity <AccountIdentity>\]
+
+Get-Session -InstanceId <String\[\]>
+
+## Detailed Description
+
+The Get-Session command returns one or more Sitecore user sessions using the specified criteria.
+
+The Identity parameter specifies the Sitecore user to get. You can specify a user by its local name or fully qualified name.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: admin
+Fully Qualified Name
+    Example: sitecore\admi
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InstanceId  <String\[\]>
+
+Specifies the Sitecore SessionID.
+
+| Aliases |  |
+| :--- | :--- |
+| 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.
+
+* None. 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Web.Authentication.DomainAccessGuard.Session
+
+  Returns one or more user sessions.
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-Session
+
+Created                LastRequest            SessionID                  UserName
+-------                -----------            ---------                  --------
+7/3/2014 3:30:39 PM    7/3/2014 3:44:27 PM    tekipna1lk0ccr2z1bdjsua2   sitecore\admin
+7/3/2014 4:13:55 PM    7/3/2014 4:13:55 PM    wq4bfivfm2tbgkgdccpyzczp   sitecore\michael
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Session -Identity admin
+
+Created                LastRequest            SessionID                  UserName
+-------                -----------            ---------                  --------
+7/3/2014 3:30:39 PM    7/3/2014 3:44:27 PM    tekipna1lk0ccr2z1bdjsua2   sitecore\admin
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-Session -InstanceId tekipna1lk0ccr2z1bdjsua2,wq4bfivfm2tbgkgdccpyzczp
+
+Created                LastRequest            SessionID                  UserName
+-------                -----------            ---------                  --------
+7/3/2014 3:30:39 PM    7/3/2014 3:44:27 PM    tekipna1lk0ccr2z1bdjsua2   sitecore\admin
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Remove-Session](remove-session.md)
+

package/dist/tools/powershell/documentation/get-sitecorejob.md

@@ -0,0 +1,102 @@
+# Get-SitecoreJob
+
+Returns list of the current sitecore jobs
+
+## Syntax
+
+Get-SitecoreJob
+
+## Detailed Description
+
+The Get-SitecoreJob command returns the list of the currently running jobs of Sitecore.
+
+© 2010-2019 Implemented by Vangasewinkel Benjamin using the Adam Najmanowicz, Michael West Sitecore PowerShell Extensions. All rights reserved.
+
+## Parameters
+
+None
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Jobs.Job 
+
+## Notes
+
+Help Author: Vangansewinkel Benjamin
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-SitecoreJob
+
+Category     : PowerShell
+Handle       : b62d9129-298a-4630-bb37-d725e5ce3bbf;DCI5CG6011F3Y-sc81u3contact
+IsDone       : True
+Name         : PowerShell-ca2a0179-78c5-02a4-5970-17e4909752b0-{347EBAF8-6BE2-4ABC-91D0-36B36FCF414B}
+Options      : Sitecore.Jobs.JobOptions
+Status       : Sitecore.Jobs.JobStatus
+WaitHandle   : System.Threading.ManualResetEvent
+QueueTime    : 11/13/2017 1:03:18 PM
+MessageQueue : Sitecore.Jobs.AsyncUI.MessageQueue
+
+Category     : Indexing
+Handle       : dca83fc7-def7-4564-ac44-987e79ffc3cd;DCI5CG6011F3Y-sc81u3contact
+IsDone       : True
+Name         : Index_Update_IndexName=sitecore_analytics_index
+Options      : Sitecore.Jobs.JobOptions
+Status       : Sitecore.Jobs.JobStatus
+WaitHandle   : System.Threading.ManualResetEvent
+QueueTime    : 11/13/2017 1:03:29 PM
+MessageQueue : Sitecore.Jobs.AsyncUI.MessageQueue
+
+Category     : PowerShell
+Handle       : de0a1dce-45f7-44fb-81b5-02b402c1f614;DCI5CG6011F3Y-sc81u3contact
+IsDone       : False
+Name         : PowerShell-ca2a0179-78c5-02a4-5970-17e4909752b0-{47666A58-890B-4D13-8F15-3348643750E4}
+Options      : Sitecore.Jobs.JobOptions
+Status       : Sitecore.Jobs.JobStatus
+WaitHandle   : System.Threading.ManualResetEvent
+QueueTime    : 11/13/2017 1:03:29 PM
+MessageQueue : Sitecore.Jobs.AsyncUI.MessageQueue
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> $jobs = Get-SitecoreJob
+PS master:\> $jobs[0].Status
+
+Category     : PowerShell
+Handle       : c9215f66-ce60-49e5-9620-bf1ec51b6ef4;DCI5CG6011F3Y-sc81u3contact
+IsDone       : False
+Name         : PowerShell-ca2a0179-78c5-02a4-5970-17e4909752b0-{DF4895A6-3EBB-4A2A-9756-3A0EF4B96396}
+Options      : Sitecore.Jobs.JobOptions
+Status       : Sitecore.Jobs.JobStatus
+WaitHandle   : System.Threading.ManualResetEvent
+QueueTime    : 11/13/2017 1:05:54 PM
+MessageQueue : Sitecore.Jobs.AsyncUI.MessageQueue
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-SitecoreJob | Show-ListView -Property "Category", "IsDone", "Name", "QueueTime", `
+    @{Label="Status Expiry"; Expression={$_.Status.Expiry} },
+    @{Label="Status Failed"; Expression={$_.Status.Failed} },
+    @{Label="Status State"; Expression={$_.Status.State} },
+    @{Label="Status Processed"; Expression={$_.Status.Processed} },
+    @{Label="Status Total"; Expression={$_.Status.Total} },
+    @{Label="Status Message"; Expression={$_.Status.Messages} }
+```
+
+![Example 3](../../.gitbook/assets/get-sitecorejobs-listview.png)
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://www.youtube.com/watch?v=N3xgZcU9FqQ&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=9](https://www.youtube.com/watch?v=N3xgZcU9FqQ&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=9) 
+

package/dist/tools/powershell/documentation/get-spemodule.md

@@ -0,0 +1,134 @@
+# 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 |  |
+| :--- | :--- |
+| 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 |  |
+| :--- | :--- |
+| 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 |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the module to be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| 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 |  |
+| :--- | :--- |
+| 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
+
+```powershell
+PS master:\> Get-SpeModule -Database (Get-Database "master")
+```
+
+### EXAMPLE 2
+
+Return all modules defined in the master database Matching the "Content\*" wildcard
+
+```powershell
+PS master:\> Get-SpeModule -Database (Get-Database "master")
+```
+
+### EXAMPLE 3
+
+Return the module the piped script belongs to
+
+```powershell
+PS master:\> Get-item "master:\system\Modules\PowerShell\Script Library\Copy Renderings\Content Editor\Context Menu\Layout\Copy Renderings" |  Get-SpeModule
+```
+
+## Related Topics
+
+* [Get-SpeModuleFeatureRoot](get-spemodulefeatureroot.md)
+* [https://blog.najmanowicz.com/2014/11/01/sitecore-powershell-extensions-3-0-modules-proposal/](https://blog.najmanowicz.com/2014/11/01/sitecore-powershell-extensions-3-0-modules-proposal/) 
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/get-spemodulefeatureroot.md

@@ -0,0 +1,113 @@
+# Get-SpeModuleFeatureRoot
+
+Returns the library item or path to the library where scripts for a particular integration point should be located for a specific module.
+
+## Syntax
+
+Get-SpeModuleFeatureRoot \[-Module <Module>\] \[-ReturnPath\] \[-Feature\] <String>
+
+## Detailed Description
+
+The Get-SpeModuleFeatureRoot command returns library item or path to the library where scripts for a particular integration point should be located for a specific module.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Module  <Module>
+
+Module for which the feature root library should be returned. If not provided the feature root will be returned for all modules.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -ReturnPath  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Feature  <String>
+
+Feature for which the root library should be provided. If root item does not exist and -ReturnPath parameter is not specified - nothing will be returned, If -ReturnPath parameter is provided the path in which the feature root should be located will be returned
+
+Valid features:
+
+* contentEditorContextMenu 
+* contentEditorGutters
+* contentEditorRibbon
+* controlPanel
+* functions
+* listViewExport
+* listViewRibbon
+* pipelineLoggedIn
+* pipelineLoggingIn
+* pipelineLogout
+* toolbox
+* startMenuReports
+* eventHandlers
+* webAPI
+* pageEditorNotification
+* isePlugi 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| 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.
+
+* Sitecore.Data.Items.Item
+
+  System.String
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Return the library item for "Content Editor Context Menu"
+
+```powershell
+$module = Get-SpeModule -Name "Copy Renderings"
+Get-SpeModuleFeatureRoot -Feature contentEditorContextMenu -Module $module
+```
+
+### EXAMPLE 2
+
+Return the Path to where "List View Export" scripts would be located if this feature was defined
+
+```powershell
+$module = Get-SpeModule -Name "Copy Renderings"
+Get-SpeModuleFeatureRoot -Module $module -Feature listViewExport -ReturnPath
+```
+
+## Related Topics
+
+* [Get-SpeModule](get-spemodule.md)
+* [https://blog.najmanowicz.com/2014/11/01/sitecore-powershell-extensions-3-0-modules-proposal/](https://blog.najmanowicz.com/2014/11/01/sitecore-powershell-extensions-3-0-modules-proposal/) 
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+