@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,108 @@
+# Receive-ScriptSession
+
+Gets the results of a script session execution.
+
+## Syntax
+
+Receive-ScriptSession -Id <String\[\]> \[-KeepResult\] \[-KeepSession\] \[-HostOutput\]
+
+Receive-ScriptSession -Session <ScriptSession\[\]> \[-KeepResult\] \[-KeepSession\] \[-HostOutput\]
+
+## Detailed Description
+
+The Receive-ScriptSession cmdlet gets the results of Windows PowerShell script sessions, such as those started by using the Start-ScriptSession. You can get the results of all script sessions by their ID or by submitting a script session objects. When you start a new script session, the session starts, but the results do not appear immediately. Instead, the command returns an object that represents the script session. The script session object contains useful information about the script session, but it does not contain the results. This method allows you to continue working in the current session while the script session runs. For more information about script sessions in Windows PowerShell, see about\_script sessions. The Receive-ScriptSession cmdlet gets the results that have been generated by the time that the Receive-ScriptSession command is submitted. If the session is not yet complete an error is raised. You can run additional Receive-ScriptSession commands to get the execution results. By default, script session results and the session itself \(unless it is a persistent session\) are deleted from the system when you receive them, but you can use the KeepResult and KeepSession parameters to save the results so that you can receive them again. To delete the script session results, run the Receive-ScriptSession command again \(without the KeepResult parameter\), close the session, or use the Remove-ScriptSession cmdlet to delete the script session from the server.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -KeepResult  <SwitchParameter>
+
+Saves the script session results in the system, even after you have received them. By default, the script session results and the session itself are deleted when they are retrieved. -KeepResult parameter has the -KeepSession parameter implied in its usage.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -KeepSession  <SwitchParameter>
+
+Causes the receiving of the session results to not destroy the session after the cmdlet has executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -HostOutput  <SwitchParameter>
+
+Add this parameter to receive the host output content. The result of the command execution will basically be what the session would print if it was interactive.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String\[\]>
+
+Gets the results of 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 for which results are being retrieved. 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.
+
+* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None or System.Object 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+The following will return the output from all available script sessions.
+
+PS master:\> Get-ScriptSession | Receive-ScriptSession
+```
+
+## Related Topics
+
+* [https://git.io/spe](https://git.io/spe) 
+

package/dist/tools/powershell/documentation/remove-archiveitem.md

@@ -0,0 +1,125 @@
+# Remove-ArchiveItem
+
+Removes items permanently from the specified archive.
+
+## Syntax
+
+```powershell
+Remove-ArchiveItem -Archive <Archive> [-ItemId <ID>]
+Remove-ArchiveItem -Archive <Archive> [-Identity <AccountIdentity>]
+Remove-ArchiveItem -Archive <Archive> [-ArchiveItem <ArchiveEntry[]>]
+```
+
+## Detailed Description
+
+The Remove-ArchiveItem command permanently removes entries from specified archive.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Archive  &lt;Archive&gt;
+
+Specifies the archive to use when determining which ArchiveEntry items to remove. Use Get-Archive to find the appropriate archive.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false|
+| Accept Wildcard Characters? | false |
+
+### -ItemId  &lt;ID&gt;
+
+Specifies the ID for the original item that should be processed. This is NOT the ArchivalId.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Identity  &lt;AccountIdentity&gt;
+
+Specifies the user responsible for moving the item to the archive.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -ArchiveItem  &lt;ArchiveEntry\[\]&gt;
+
+Specific items from the archive may be deleted when using this parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+* AccountIdentity
+* Sitecore.Data.Archiving.ArchiveEntry
+
+## 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
+
+The following removes items matching the ItemId found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Remove-ArchiveItem -Archive $archive -ItemId "{1BB32980-66B4-4ADA-9170-10A9D3336613}"
+```
+
+### EXAMPLE 2
+
+The following removes items from the recycle bin by the user found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Remove-ArchiveItem -Archive $archive -Identity "sitecore\admin"
+```
+
+### EXAMPLE 3
+
+The following removes all items from the recycle bin found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Get-ArchiveItem -Archive $archive | Remove-ArchiveItem
+```
+
+## Related Topics
+
+* Get-ArchiveItem
+* Restore-ArchiveItem
+* Remove-Item
+* Remove-ItemVersion
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 

package/dist/tools/powershell/documentation/remove-basetemplate.md

@@ -0,0 +1,137 @@
+# Remove-BaseTemplate
+
+Remove one or more base templates from a template item.
+
+## Syntax
+
+Remove-BaseTemplate -Item <Item> -TemplateItem <TemplateItem\[\]>
+
+Remove-BaseTemplate -Item <Item> -Template <String\[\]>
+
+Remove-BaseTemplate -Path <String> -TemplateItem <TemplateItem\[\]>
+
+Remove-BaseTemplate -Path <String> -Template <String\[\]>
+
+Remove-BaseTemplate -Id <String> -TemplateItem <TemplateItem\[\]>
+
+Remove-BaseTemplate -Id <String> -Template <String\[\]>
+
+Remove-BaseTemplate \[-Database <String>\]
+
+## Detailed Description
+
+The Remove-BaseTemplate command removes one or more base templates from a template item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to remove the base template from.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to remove the base template from.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to remove the base template from.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -TemplateItem  <TemplateItem\[\]>
+
+Sitecore item or list of items of base templates to remove.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Template  <String\[\]>
+
+Path representing the template item to remove as a base template. This must be of the same database as the item to be altered. Note that this parameter only supports a single template.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to remove the base template from - required if item is specified with Id.
+
+| 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West, Alex Washtell
+
+## Examples
+
+### EXAMPLE 1
+
+Remove base template of /sitecore/templates/User Defined/BaseTemplate from a template, using a path.
+
+```powershell
+PS master:\> Remove-BaseTemplate -Path "master:/sitecore/content/User Defined/Page" -Template "/sitecore/templates/User Defined/BaseTemplate"
+```
+
+### EXAMPLE 2
+
+Remove multiple base templates from a template, using items.
+
+```powershell
+PS master:\> $baseA = Get-Item -Path master:/sitecore/content/User Defined/BaseTemplateA
+       PS master:\> $baseB = Get-Item -Path master:/sitecore/content/User Defined/BaseTemplateB
+       PS master:\> Remove-BaseTemplate -Path "master:/sitecore/content/User Defined/Page" -TemplateItem @($baseA, $baseB)
+```
+
+## Related Topics
+
+* [Add-BaseTemplate](add-basetemplate.md)
+* [Get-ItemTemplate](get-itemtemplate.md)
+* [Set-ItemTemplate](set-itemtemplate.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/remove-domain.md

@@ -0,0 +1,70 @@
+# Remove-Domain
+
+Removes the specified domain.
+
+## Syntax
+
+Remove-Domain \[-Name\] <String> \[-Force\]
+
+## Detailed Description
+
+The Remove-Domain command removes the specified domain.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+The name of the domain.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Force  <SwitchParameter>
+
+Indicates that the domain should be removed although it contains users in that domain.
+
+| 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.
+
+* System.String
+
+  Represents the name of a domain.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None. 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Remove-Domain -Name "domainName"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/remove-itemversion.md

@@ -0,0 +1,209 @@
+# Remove-ItemVersion
+
+Removes Language/Version from a single item or a branch of items
+
+## Syntax
+
+```powershell
+Remove-ItemVersion -Language <String[]> [-Version <String[]>] [-ExcludeLanguage <String[]>] [-Path] <String> [-Recurse] [-MaxRecentVersions <Int32>]
+
+Remove-ItemVersion -Language <String[]> [-Version <String[]>] [-ExcludeLanguage <String[]>] -Id <String> [-Database <String>] [-Recurse] [-MaxRecentVersions <Int32>]
+
+Remove-ItemVersion [-Language <String[]>] [-Version <String[]>] [-ExcludeLanguage <String[]>] [-Item] <Item> [-Recurse] [-MaxRecentVersions <Int32>]
+```
+
+## Detailed Description
+
+Removes Language/Version from a an Item either sent from pipeline or defined with Path or ID. A single language or a list of languages can be defined using the Language parameter. Language parameter supports globbing so you can delete whole language groups using wildcards.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Remove-ItemLanguage 
+
+## Parameters
+
+### -Recurse  &lt;SwitchParameter&gt;
+
+Deleted language versions from the item and all of its children.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+Language\(s\) that should be deleted form the provided item\(s\). A single language or a list of languages can be defined using the parameter. Language parameter supports globbing so you can delete whole language groups using wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Version  &lt;String\[\]&gt;
+
+Version\(s\) that should be deleted form the provided item\(s\). A single version or a list of versions can be defined using the parameter. Version parameter supports globbing so you can delete whole version groups using wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ExcludeLanguage  &lt;String\[\]&gt;
+
+Language\(s\) that should NOT be deleted form the provided item\(s\). A single language or a list of languages can be defined using the parameter. Language parameter supports globbing so you can delete whole language groups using wildcards.
+
+If Language parameter is not is not specified but ExcludeLanguage is provided, the default value of "\*" is assumed for Language parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -MaxRecentVersions  &lt;Int32&gt;
+
+If provided - trims the selected language to value specified by this parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+The item/version to be processed. You can pipe a specific version of the item for it to be removed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Archive  &lt;SwitchParameter&gt;
+
+Specifying this switch will move the items to the archive rather than recycle bin.
+
+| 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Remove Polish and Spanish language from /sitecore/content/home item in the master database
+
+```powershell
+Remove-ItemVersion -Path master:\content\home -Language "pl-pl", "es-es"
+```
+
+### EXAMPLE 2
+
+Remove all english based languages defined in /sitecore/content/home item and all of its children in the master database
+
+```powershell
+Remove-ItemVersion -Path master:\content\home -Language "en-*" -Recurse
+```
+
+### EXAMPLE 3
+
+Remove all languages except those that are "en" based defined in /sitecore/content/home item and all of its children in the master database
+
+```powershell
+Remove-ItemVersion -Path master:\content\home -ExcludeLanguage "en*" -Recurse
+```
+
+### EXAMPLE 4
+
+Trim all languages to 3 latest versions for /sitecore/content/home item and all of its children in the master database
+
+```powershell
+Remove-ItemVersion -Path master:\content\home -Language * -MaxRecentVersions 3 -Recurse
+```
+
+### EXAMPLE 5
+
+The following moves the specified item version to the archive.
+
+```powershell
+$itemId = "{72EB19F8-E62A-4B99-80A3-63E03F4FD036}"
+Get-Item -Path "master:" -ID $itemId -Version 2 | Remove-ItemVersion -Archive
+```
+
+## Related Topics
+
+* [Add-ItemVersion](add-itemversion.md)
+* Remove-Item
+* [https://gist.github.com/AdamNaj/b36ea095e3668c22c07e](https://gist.github.com/AdamNaj/b36ea095e3668c22c07e) 
+