@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,97 @@
+# Remove-User
+
+Removes the Sitecore user.
+
+## Syntax
+
+Remove-User \[-Identity\] <AccountIdentity>
+
+Remove-User -Instance <User>
+
+## Detailed Description
+
+The Remove-User command removes a user from Sitecore.
+
+The Identity parameter specifies the Sitecore user to remove. 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? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Instance  <User>
+
+| 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
+
+  Represents the identity of a user.
+
+Sitecore.Security.Accounts.User Represents the instance of a user.
+
+## 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-User -Identity michael
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> "michael","adam","mike" | Remove-User
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-User -Filter sitecore\m* | Remove-User
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-User](get-user.md)
+* [New-User](new-user.md)
+* [Set-User](set-user.md)
+* [Unlock-User](unlock-user.md)
+

package/dist/tools/powershell/documentation/reset-itemfield.md

@@ -0,0 +1,149 @@
+# Reset-ItemField
+
+Resets item fields, specified as either names, fields or template fields.
+
+## Syntax
+
+```powershell
+Reset-ItemField [-Item] <Item> [-IncludeStandardFields] [-Name <String[]>]
+Reset-ItemField [-Path] <String> [-IncludeStandardFields] [-Name <String[]>]
+Reset-ItemField -Id <String> [-Database <String>] [-IncludeStandardFields] [-Name <String[]>]
+```
+
+## Detailed Description
+
+Resets item fields, specified as either names, fields or template fields.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -IncludeStandardFields  &lt;SwitchParameter&gt;
+
+Includes fields that are defined on "Standard template"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String\[\]&gt;
+
+Array of field names to include - supports wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+The item to be analysed.
+
+| 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 analysed.
+
+| 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 analysed.
+
+| 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 reset - 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 |
+
+## 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West, Alex Washtell
+
+## Examples
+
+### EXAMPLE 1
+
+Reset all item fields, excluding standard fields.
+
+```powershell
+PS master:\> Reset-ItemField -Path master:\content\home
+```
+
+### EXAMPLE 2
+
+Reset all item fields, including standard fields.
+
+```powershell
+PS master:\> Reset-ItemField -Path master:\content\home -IncludeStandardFields
+```
+
+### EXAMPLE 3
+
+Reset all item fields with names beginning with "a", excluding standard fields.
+
+```powershell
+PS master:\> Get-Item master:\content\home | Reset-ItemField -Name "a*"
+```
+
+### EXAMPLE 4
+
+The following resets one of the Standard Values fields for all versions and languages.
+
+```powershell
+Get-ChildItem -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}" -Version * -Language * -Recurse |
+    Reset-ItemField -Name "__Workflow State" -IncludeStandardFields
+```
+
+## Related Topics
+
+* [Get-ItemTemplate](get-itemtemplate.md)
+* [Get-ItemField](get-itemfield.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/reset-layout.md

@@ -0,0 +1,130 @@
+# Reset-Layout
+
+Resets the SharedLayout or FinalLayout field for the specified item.
+
+## Syntax
+
+```powershell
+Reset-Layout [-Item] <Item> [-FinalLayout] [-Language <String[]>]
+
+Reset-Layout [-Path] <String> [-FinalLayout] [-Language <String[]>]
+
+Reset-Layout -Id <String> [-Database <String>] [-FinalLayout] [-Language <String[]>]
+```
+
+## Detailed Description
+
+The Reset-Layout command resets the layout for the specified item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -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 |
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| 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.
+
+| 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.
+
+| 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.
+
+| 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.
+
+* None. 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West, Alex Washtell
+
+## Examples
+
+### EXAMPLE 1
+
+The following resets the layout information on the SharedLayout.
+
+```powershell
+Reset-Layout -Path master:\content\home
+```
+
+## 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)
+* [Remove-Rendering](remove-rendering.md)
+* [Set-Layout](set-layout.md)
+* [Get-Layout](get-layout.md)
+

package/dist/tools/powershell/documentation/restart-application.md

@@ -0,0 +1,30 @@
+# Restart-Application
+
+Restarts the Sitecore Application pool.
+
+## Syntax
+
+## Detailed Description
+
+Restarts the Sitecore Application pool.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Restart-Application
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,126 @@
+# Remove-ArchiveItem
+
+Restores items to the original database from the specified archive.
+
+## Syntax
+
+```powershell
+Restore-ArchiveItem -Archive <Archive> [-WhatIf] [-Confirm]  [<CommonParameters>]
+Restore-ArchiveItem -Archive <Archive> [-ItemId <ID>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+Restore-ArchiveItem -Archive <Archive> [-Identity <AccountIdentity>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+Restore-ArchiveItem -ArchiveItem <ArchiveEntry[]> [-WhatIf] [-Confirm]  [<CommonParameters>]
+```
+
+## Detailed Description
+
+The Restore-ArchiveItem command restores entries from specified archive back to the original database.
+
+© 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 process. 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 restored 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 restores items matching the ItemId found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Restore-ArchiveItem -Archive $archive -ItemId "{1BB32980-66B4-4ADA-9170-10A9D3336613}"
+```
+
+### EXAMPLE 2
+
+The following restores 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
+Restore-ArchiveItem -Archive $archive -Identity "sitecore\admin"
+```
+
+### EXAMPLE 3
+
+The following restores 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 | Restore-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/resume-searchindex.md

@@ -0,0 +1,84 @@
+# Resume-SearchIndex
+
+Resumes the suspended \(paused\) Sitecore index.
+
+## Syntax
+
+Resume-SearchIndex -Index <ISearchIndex>
+
+Resume-SearchIndex \[-Name <String>\]
+
+Resume-SearchIndex \[-Name <String>\]
+
+## Detailed Description
+
+The Resume-SearchIndex command resumes the suspended \(paused\) 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 resume.
+
+| 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:\> Resume-SearchIndex -Name sitecore_master_index
+```
+
+### EXAMPLE 2
+
+```powershell
+The following stops the indexing process from running.
+
+PS master:\> Get-SearchIndex -Name sitecore_master_index | Resume-SearchIndex
+```
+
+## Related Topics
+
+* [Initialize-SearchIndex](initialize-searchindex.md)
+* [Suspend-SearchIndex](suspend-searchindex.md)
+* [Stop-SearchIndex](stop-searchindex.md)
+* [Get-SearchIndex](get-searchindex.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+