@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/show-yesnocancel.md

@@ -0,0 +1,92 @@
+# Show-YesNoCancel
+
+Shows Yes/No/Cancel dialog to the user and returns user choice.
+
+## Syntax
+
+Show-YesNoCancel \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Shows Yes/No/Cancel dialog to the user and returns user choice as a string value.
+
+Depending on the user response one of the 2 strings is returned:
+
+* yes
+* no
+* cancel 
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Title  <String>
+
+Question to ask the user in the dialog
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## 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
+
+```powershell
+PS master:\> Show-YesNoCancel "Should we delete those 2 items?"
+
+cancel
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.md)
+* [Show-ListView](show-listview.md)
+* [Show-ModalDialog](show-modaldialog.md)
+* [Show-Result](show-result.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,230 @@
+# Start-ScriptSession
+
+Starts a new Script Session and executes a script provided in it.
+
+## Syntax
+
+Start-ScriptSession -Id <String\[\]> -Item <Item> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Id <String\[\]> -ScriptBlock <ScriptBlock> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Id <String\[\]> -Path <String> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Session <ScriptSession\[\]> -Item <Item> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Session <ScriptSession\[\]> -ScriptBlock <ScriptBlock> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Session <ScriptSession\[\]> -Path <String> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Item <Item> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -Path <String> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+Start-ScriptSession -ScriptBlock <ScriptBlock> \[-JobName <String>\] \[-ArgumentList <Hashtable>\] \[-Identity <AccountIdentity>\] \[-DisableSecurity\] \[-AutoDispose\] \[-Interactive\] \[-ContextItem <Item>\]
+
+## Detailed Description
+
+Starts a new Script Session and executes a script provided in it. The session can be a background session or if the caller session is interactive providint the -Interactive switch can open a Windowd for the new sessio
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Id  <String\[\]>
+
+Id of the session to be created or retrieved. If the session with the same ID exists - it will be used, unless it's busy - in which case an error will be raised. If a session with the Id provided does not exist - it will be created. 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? | false |
+| Accept Wildcard Characters? | false |
+
+### -Session  <ScriptSession\[\]>
+
+Specifies the script session in context of which the script should be executed. Enter a variable that contains the script session or a command that gets the script session. You can also pipe a script session object to Start-ScriptSession. If the session is busy at the moment of the call - an error will be raised instead of running the script.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+Script item containing the code to be executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the script item containing the code to be executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ScriptBlock  <ScriptBlock>
+
+Script to be executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -JobName  <String>
+
+Name of the Sitecore job that will run the script session. This can be used to monitor the session progress.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ArgumentList  <Hashtable>
+
+Hashtable with the additional parameters required by the invoked script. The parameters will be instantiated in the session as variables.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Identity  <AccountIdentity>
+
+User name including domain in context of which the script will be executed. If no domain is specified - 'sitecore' will be used as the default value. If user is not specified the current user will be the impersonation context.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DisableSecurity  <SwitchParameter>
+
+Add this parameter to disable security in the Job running the script session.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -AutoDispose  <SwitchParameter>
+
+Providing this parameter will cause the session to be automatically destroyed after it has executed. Use this parameter if you're not in need of the results of the script execution.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Interactive  <SwitchParameter>
+
+If the new session is run from an interactive session \(e.g. from desktop, menu item, console or ISE\) using this parameter will cause dialog to be shown to the user to monitor the script progress.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ContextItem  <Item>
+
+Context item for the script session. The script will start in the location of the item.
+
+| 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.
+
+* Spe.Core.Host.ScriptSession
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+The following starts the progress demo script in interactive mode (showing dialogs for each script) in 3 different ways.
+
+In the first case script path is used, second case shows the script item beign retrieved and provided to the cmdlet.
+The last case shows the script to be provided as a script block (script content)
+Script finishes before the sessions that were launched from it end. 
+The sessions will be disposed when user presses the "Close" button in their dialogs as the -AutoDispose parameter was provided.
+
+$scriptPath = "master:\system\Modules\PowerShell\Script Library\Getting Started\Script Testing\Long Running Script with Progress Demo"
+$scriptItem = Get-Item $scriptPath
+$script = [scriptblock]::Create($scriptItem.Script)
+Start-ScriptSession -Path $scriptPath -Interactive -AutoDispose
+Start-ScriptSession -Item $scriptItem -Interactive -AutoDispose
+Start-ScriptSession -ScriptBlock $script -Interactive -AutoDispose
+```
+
+### EXAMPLE 2
+
+```powershell
+The following starts a script that changes its path to "master:\" and sleeps for 4 seconds. The session will persist in memory as no -AutoDispose parameter has been provided.
+
+Start-ScriptSession -ScriptBlock { cd master:\; Start-Sleep -Seconds 4 } -Id "Background Task"
+```
+
+## Related Topics
+
+* [Get-ScriptSession](get-scriptsession.md)
+* [Receive-ScriptSession](receive-scriptsession.md)
+* [Remove-ScriptSession](remove-scriptsession.md)
+* [Stop-ScriptSession](stop-scriptsession.md)
+* [Wait-ScriptSession](wait-scriptsession.md)
+* [https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/](https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/) 
+* [https://git.io/spe](https://git.io/spe) 
+

package/dist/tools/powershell/documentation/start-taskschedule.md

@@ -0,0 +1,124 @@
+# Start-TaskSchedule
+
+Executes a task schedule.
+
+## Syntax
+
+Start-TaskSchedule -Schedule <ScheduleItem>
+
+Start-TaskSchedule \[-Item\] <Item>
+
+Start-TaskSchedule \[-Path\] <String>
+
+Start-TaskSchedule -Id <String> \[-Database <String>\]
+
+## Detailed Description
+
+Executes a task schedule either passed from Get-Schedule, based on Item or Schedule path.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Schedule  <ScheduleItem>
+
+ScheduleItem most conveniently obtained from Get-Schedule command.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+Schedule item - if Item is of wrong template - an appropriate error will be written to teh host.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the schedule item - if item is of wrong template - an appropriate error will be written to teh host.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+| 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.Tasks.ScheduleItem
+
+  Sitecore.Data.Items.Item
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Tasks.ScheduleItem 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Start-TaskSchedule -Path "master:/system/Tasks/Schedules/Email Campaign/Clean Message History"
+
+Name                             Database        Active   Auto Remove  Is Due   Expired  Completed    Last Run               Next Run
+----                             --------        ------   -----------  ------   -------  ---------    --------               --------
+Clean Message History            master          True     False        False    False    False        2014-07-29 16:22:49    2014-07-30 04:52:49
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-TaskSchedule -Name "Check Bounced Messages" -Database "master" | Start-TaskSchedule
+
+Name                             Database        Active   Auto Remove  Is Due   Expired  Completed    Last Run               Next Run
+----                             --------        ------   -----------  ------   -------  ---------    --------               --------
+Check Bounced Messages           master          True     False        False    False    False        2014-07-29 16:21:33    2014-07-30 04:51:33
+```
+
+## Related Topics
+
+* [Get-TaskSchedule](get-taskschedule.md)
+* [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/stop-scriptsession.md

@@ -0,0 +1,78 @@
+# Stop-ScriptSession
+
+Stops executing script session.
+
+## Syntax
+
+Stop-ScriptSession -Id <String\[\]>
+
+Stop-ScriptSession -Session <ScriptSession\[\]>
+
+## Detailed Description
+
+Aborts the pipeline of a session that is executing. This will stop the session immediately in its next PowerShell command. Caution! If your script is running a long operation in the .net code rather than in PowerShell - the session will abort after the code has finished and the control was returned to the script.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Id  <String\[\]>
+
+Stops 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\[\]>
+
+Specifies the script session to be stopped. Enter a variable that contains the script session or a command that gets the script session. You can also pipe a script session object to Receive-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.
+
+* System.String or Spe.Core.Host.ScriptSession 
+
+## 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
+
+```powershell
+The following stops the script session with the specified Id.
+
+PS master:\> Stop-ScriptSession -Id "My Background Script Session"
+```
+
+## Related Topics
+
+* [Get-ScriptSession](get-scriptsession.md)
+* [Receive-ScriptSession](receive-scriptsession.md)
+* [Remove-ScriptSession](remove-scriptsession.md)
+* [Start-ScriptSession](start-scriptsession.md)
+* [Wait-ScriptSession](wait-scriptsession.md)
+* [https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/](https://blog.najmanowicz.com/2014/10/26/sitecore-powershell-extensions-persistent-sessions/) 
+* [https://git.io/spe](https://git.io/spe) 
+

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

@@ -0,0 +1,84 @@
+# Stop-SearchIndex
+
+Stops the Sitecore index.
+
+## Syntax
+
+Stop-SearchIndex -Index <ISearchIndex>
+
+Stop-SearchIndex \[-Name <String>\]
+
+Stop-SearchIndex \[-Name <String>\]
+
+## Detailed Description
+
+The Stop-SearchIndex command stops the Sitecore index.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Index  <ISearchIndex>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+The name of the index to stop.
+
+| 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.ContentSearch.ISearchIndex or System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+The following stops the indexing process from running.
+
+PS master:\> Stop-SearchIndex -Name sitecore_master_index
+```
+
+### EXAMPLE 2
+
+```powershell
+The following stops the indexing process from running.
+
+PS master:\> Get-SearchIndex -Name sitecore_master_index | Stop-SearchIndex
+```
+
+## Related Topics
+
+* [Initialize-SearchIndex](initialize-searchindex.md)
+* [Suspend-SearchIndex](suspend-searchindex.md)
+* [Resume-SearchIndex](resume-searchindex.md)
+* [Get-SearchIndex](get-searchindex.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,84 @@
+# Suspend-SearchIndex
+
+Suspends \(pauses\) the Sitecore index.
+
+## Syntax
+
+Suspend-SearchIndex -Index <ISearchIndex>
+
+Suspend-SearchIndex \[-Name <String>\]
+
+Suspend-SearchIndex \[-Name <String>\]
+
+## Detailed Description
+
+The Suspend-SearchIndex command suspends \(pauses\) the Sitecore index.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Index  <ISearchIndex>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+The name of the index to suspend \(pause\).
+
+| 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.ContentSearch.ISearchIndex or System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+The following suspends (pauses) the indexing process from running.
+
+PS master:\> Suspend-SearchIndex -Name sitecore_master_index
+```
+
+### EXAMPLE 2
+
+```powershell
+The following suspends (pauses) the indexing process from running.
+
+PS master:\> Get-SearchIndex -Name sitecore_master_index | Suspend-SearchIndex
+```
+
+## Related Topics
+
+* [Initialize-SearchIndex](initialize-searchindex.md)
+* [Stop-SearchIndex](stop-searchindex.md)
+* [Resume-SearchIndex](resume-searchindex.md)
+* [Get-SearchIndex](get-searchindex.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+