@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,253 @@
+# Remove-Rendering
+
+Removes renderings from an item.
+
+## Syntax
+
+```powershell
+Remove-Rendering -Item <Item> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering -Item <Item> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering -Item <Item> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering -Path <String> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering -Path <String> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering -Path <String> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering [-Id <String>] [-Database <String>] [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering [-Id <String>] [-Database <String>] -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Remove-Rendering [-Id <String>] [-Database <String>] -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+```
+
+## Detailed Description
+
+Removes renderings from an item based on a number of qualifying criteria. The search criteria are cumulative and narrowing the search in an "AND" manner.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| 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? | named |
+| 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? | false |
+| 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 |
+
+### -DataSource  &lt;String&gt;
+
+Data source filter - supports wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Rendering  &lt;Item&gt;
+
+Item representing the sublayout/rendering. If matching the rendering will be removed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Index  &lt;Int32&gt;
+
+Index at which the rendering exists in the layout. The rendering at that index will be removed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PlaceHolder  &lt;String&gt;
+
+Place holder at which the rendering exists in the layout. Rendering at that placeholder will be removed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  &lt;Hashtable&gt;
+
+Additional rendering parameter values. If both name and value match - the rendering will be removed. Values support wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Specific instance of rendering that should be removed. The instance coule earlier be obtained through e.g. use of Get-Rendering.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UniqueId  &lt;String&gt;
+
+UniqueID of the rendering to be removed. The instance coule earlier be obtained through e.g. use of OD of rendering retrieved with Get-Rendering.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Device  &lt;DeviceItem&gt;
+
+Device for which the rendering should be removed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| 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.Void 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+remove all renderings for "Default" device
+
+```powershell
+Remove-Rendering -Path master:\content\home -Device (Get-LayoutDevice "Default")
+```
+
+### EXAMPLE 2
+
+remove all renderings from the "main" placeholder and all of its embedded placeholders.
+
+```powershell
+Remove-Rendering -Path master:\content\home -PlaceHolder "main*"
+```
+
+### EXAMPLE 3
+
+remove all renderings from the "main" placeholder and all of its embedded placeholders, but only in the "Default" device
+
+```powershell
+Remove-Rendering -Path master:\content\home -PlaceHolder "main*" -Device (Get-LayoutDevice "Default")
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-rendering.md)
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

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

@@ -0,0 +1,83 @@
+# Remove-RenderingParameter
+
+Removes the specified rendering parameter from the rendering.
+
+## Syntax
+
+```powershell
+Remove-RenderingParameter -Instance <RenderingDefinition> [-Name <String[]>]
+```
+
+## Detailed Description
+
+Removes the specified rendering parameter from the rendering.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Rendering definition containing the rendering parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String\[\]&gt;
+
+The names (or keys) identifying specific rendering parameters.
+
+| 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.Layouts.RenderingDefinition
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Layouts.RenderingDefinition
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+The following removes the specified rendering parameter and updates the item.
+
+```powershell
+$item = Get-Item -Path "master" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+
+Get-Rendering -Item $item -FinalLayout | 
+    Remove-RenderingParameter -Name"SampleKey2" | 
+    Set-Rendering -Item $item -FinalLayout
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

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

@@ -0,0 +1,70 @@
+# Remove-Role
+
+Removes a Sitecore role.
+
+## Syntax
+
+Remove-Role \[-Identity\] <AccountIdentity>
+
+Remove-Role -Instance <Role>
+
+## Detailed Description
+
+The Remove-Role command removes a Sitecore role.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Role name including domain. If no domain is specified - 'sitecore' will be used as the default value
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Instance  <Role>
+
+Role instance like that returned by the Get-Role command.
+
+| 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.Security.Accounts.Role 
+
+## 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-Role -Identity Michael
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,79 @@
+# Remove-RoleMember
+
+Removes one or more Sitecore users from the specified role.
+
+## Syntax
+
+Remove-RoleMember \[-Identity\] <AccountIdentity> -Members <AccountIdentity\[\]>
+
+## Detailed Description
+
+The Remove-RoleMember command gets a role and removes members of the Sitecore role.
+
+The Identity parameter specifies the Sitecore role to get. You can specify a role 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 role by providing one of the following values.
+
+```powershell
+Local Name
+    Example: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Members  <AccountIdentity\[\]>
+
+| 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.
+
+* System.String
+
+  Represents the identity of a role.
+
+## 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-RoleMember -Identity developer -Members "michael","adam","mike"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-RoleMember](add-rolemember.md)
+* [Get-RoleMember](get-rolemember.md)
+

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

@@ -0,0 +1,72 @@
+# Remove-ScriptSession
+
+Removes a persistent Script Session from memory.
+
+## Syntax
+
+Remove-ScriptSession -Id <String\[\]>
+
+Remove-ScriptSession -Session <ScriptSession\[\]>
+
+## Detailed Description
+
+Removes a persistent Script Session from memory.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Id  <String\[\]>
+
+Id of the PowerShell session to be removed from memory.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Session  <ScriptSession\[\]>
+
+Session to be removed.
+
+| 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
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+The following removes the script session using the specified Id.
+
+PS master:\> Remove-ScriptSession -Id "Long running script"
+```
+
+## Related Topics
+
+* [Get-ScriptSession](get-scriptsession.md)
+* [Receive-ScriptSession](receive-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/remove-searchindexitem.md

@@ -0,0 +1,79 @@
+# Remove-SearchIndexItem
+
+## Syntax
+
+```powershell
+Remove-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
+Remove-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
+Remove-SearchIndexItem -SearchResultItem <SearchResultItem> [-AsJob]
+```
+
+## Detailed Description
+
+Removes an indexed item from the specified index. Supports wildcard filtering for the index name.
+
+© 2010-2020 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -SearchResultItem  &lt;SearchResultItem&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -AsJob  &lt;SwitchParameter&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Examples
+
+### EXAMPLE 1
+
+The following removes the indexed item from the specified search index.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$indexName = "sitecore_master_index"
+Remove-SearchIndexItem -Item $item -Name $indexName
+```
+
+### EXAMPLE 2
+
+The following removes the indexed item from the indexes matching the wildcard pattern.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$indexName = "sitecore_*_index"
+Remove-SearchIndexItem -Item $item -Name $indexName
+```

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

@@ -0,0 +1,77 @@
+# Remove-Session
+
+Removes one or more Sitecore user sessions.
+
+## Syntax
+
+Remove-Session -InstanceId <String\[\]>
+
+Remove-Session \[-Instance\] <Session>
+
+## Detailed Description
+
+The Remove-Session command removes user sessions in Sitecore.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -InstanceId  <String\[\]>
+
+Specifies the Sitecore SessionID.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Instance  <Session>
+
+Specifies the Sitecore user sessions.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| 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.
+
+* Accepts a user session.\* Sitecore.Web.Authentication.DomainAccessGuard.Sessio 
+
+## 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
+PS master:\> Remove-Session -InstanceId tekipna1lk0ccr2z1bdjsua2,wq4bfivfm2tbgkgdccpyzczp
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Session -Identity michael | Remove-Session
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-Session](get-session.md)
+