@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,73 @@
+# Get-Archive
+
+Returns Sitecore database archives.
+
+## Syntax
+
+Get-Archive \[\[-Database\] <Database>\] \[\[-Name\] <String>\]
+
+## Detailed Description
+
+The Get-Archive command returns Sitecore archives in context of the specified database.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the archive to retrieve.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <Database>
+
+Database for which the archives should be retrieved.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| 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.Database 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Archiving.Archive 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Get-Archive -Database "master"
+
+Name                                        Items
+----                                        -----
+archive                                         0
+recyclebin                                   1950
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,138 @@
+# Get-ArchiveItem
+
+Retrieves a list of items found in the specified archive.
+
+## Syntax
+
+```powershell
+Get-ArchiveItem -Archive <Archive>
+Get-ArchiveItem -Archive <Archive> [-ItemId <ID>]
+Get-ArchiveItem -Archive <Archive> [-Identity <AccountIdentity>]
+```
+
+## Detailed Description
+
+The Get-ArchiveItem command returns items found in the "archive" and "recyclebin" archives.
+
+© 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? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+None.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Archiving.ArchiveEntry 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following returns all items found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Get-ArchiveItem -Archive $archive
+```
+
+### EXAMPLE 2
+
+The following returns items matching the ItemId found in the specified archive.
+
+```powershell
+$database = Get-Database -Name "master"
+$archiveName = "recyclebin"
+$archive = Get-Archive -Database $database -Name $archiveName
+Get-ArchiveItem -Archive $archive -ItemId "{1BB32980-66B4-4ADA-9170-10A9D3336613}"
+```
+
+### EXAMPLE 3
+
+The following returns items moved to 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
+Get-ArchiveItem -Archive $archive -Identity "sitecore\admin"
+```
+
+### EXAMPLE 4
+
+The following demonstrates changing the archive date on an item followed by retrieving the archived item.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{1BB32980-66B4-4ADA-9170-10A9D3336613}"
+$date = $item[[Sitecore.FieldIDs]::ArchiveDate]
+$serverTime = [Sitecore.DateUtil]::IsoDateToServerTimeIsoDate($date)
+$serverTimeDateTime = [Sitecore.DateUtil]::IsoDateToDateTime($serverTime, [datetime]::MinValue)
+
+# Here you could add more time to the $serverTimeDateTime
+
+$utcTimeDateTime = [Sitecore.DateUtil]::ToUniversalTime($serverTimeDateTime)
+$isoTime = [Sitecore.DateUtil]::ToIsoDate($utcTimeDateTime)
+
+$item.Editing.BeginEdit()
+$item[[Sitecore.FieldIDs]::ArchiveDate] = $isoTime
+$item.Editing.EndEdit()
+
+# Some time after the date has passed
+$database = Get-Database -Name "master"
+$archiveName = "archive"
+$archive = Get-Archive -Database $database -Name $archiveName
+Get-ArchiveItem -Archive $archive -ItemId "{1BB32980-66B4-4ADA-9170-10A9D3336613}"
+```
+
+## Related Topics
+
+* Remove-ArchiveItem
+* Restore-ArchiveItem
+* Remove-Item
+* Remove-ItemVersion
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 

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

@@ -0,0 +1,62 @@
+# Get-Cache
+
+Retrieves a Sitecore cache.
+
+## Syntax
+
+Get-Cache \[\[-Name\] <String>\]
+
+## Detailed Description
+
+The Get-Cache command retrieves a Sitecore cache.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the cache to retrieve. Supports wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Caching.Cache 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Get-Cache -Name master*
+
+Name                                     Enabled       Count       Size   Max Size Default  Scavengable
+                                                                                   Priority
+----                                     -------       -----       ----   -------- -------- -----------
+master[blobIDs]                          True              0          0     512000   Normal       False
+master[blobIDs]                          True              0          0     512000   Normal       False
+master[blobIDs]                          True              0          0     512000   Normal       False
+master[itempaths]                        True            292     108228   10485760   Normal       False
+master[standardValues]                   True             57      38610     512000   Normal       False
+master[paths]                            True            108      13608     512000   Normal       False
+master[items]                            True           1010    5080300   10485760   Normal       False
+master[data]                             True           3427    7420654   20971520   Normal       False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,96 @@
+# Get-Database
+
+Retrieves a Sitecore Database.
+
+## Syntax
+
+Get-Database \[\[-Name\] <String>\] \[-Item <Item>\]
+
+## Detailed Description
+
+The Get-Database command retrieves one or more Sitecore Database objects based on name or item passed to it.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the database to be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+Database returned will be taken from the item passed to the command.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| 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
+
+  System.String
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Database 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-Database
+Name                 Languages                      Protected  Read Only
+----                 ---------                      ---------  ---------
+core                 {da, pl-PL, ja-JP, en...}      False      False
+master               {en, de-DE, es-ES, pt-BR...}   False      False
+web                  {es-ES, de-DE, pt-BR, pl-PL... False      False
+filesystem           {en, en-US}                    False      True
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Database -Name "master"
+
+Name                 Languages                      Protected  Read Only
+----                 ---------                      ---------  ---------
+master               {en, de-DE, es-ES, pt-BR...}   False      False
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-Item . | Get-Database
+
+Name                 Languages                      Protected  Read Only
+----                 ---------                      ---------  ---------
+master               {en, de-DE, es-ES, pt-BR...}   False      False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,75 @@
+# Get-Domain
+
+Gets all available domains or the specified domain.
+
+## Syntax
+
+Get-Domain \[-Name <String>\]
+
+## Detailed Description
+
+The Get-Domain command returns all the domains or the specified domain.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+The name of the domai
+
+| 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.
+
+* Sitecore.Security.Domains.Domai 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-Domain -Name sitecore
+Name            AccountPrefix   EnsureAnonymousUser    LocallyManaged
+----            -------------   -------------------    --------------
+sitecore        sitecore\       False                  False
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Domain
+
+Name            AccountPrefix   EnsureAnonymousUser    LocallyManaged
+----            -------------   -------------------    --------------
+sitecore        sitecore\       False                  False
+extranet        extranet\       True                   False
+default         default\        True                   False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Remove-Domain](remove-domain.md)
+* [New-Domain](new-domain.md)
+

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

@@ -0,0 +1,186 @@
+# Get-Item
+
+Gets Sitecore items from the specified drive.
+
+## Syntax
+
+```
+Get-Item [-Path] <String[]> [-ID <ID>] [-Language <String[]>] [-Version <String>] [<CommonParameters>]
+
+Get-Item [-Path] <String[]> [-Query <String>] [-Language <String[]>] [-Version <String>] [-AmbiguousPaths] [<CommonParameters>]
+
+Get-Item [-Path] <String[]> [-Uri <String>] [-Language <String[]>] [-Version <String>] [<CommonParameters>]
+
+Get-Item [-Path] <String[]> [-Database <String>] [-Language <String[]>] [-Version <String>]  [<CommonParameters>]
+```
+
+## Detailed Description
+
+The Get-Item command unlocks the item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Path &lt;String&gt;
+
+The path to the item. If the Database parameter is not provided, the path should include the database. For example, `"master:\content\home"`.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ID &lt;ID&gt;
+
+The unique identifier for the item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Query &lt;String&gt;
+
+The Sitecore query or fast query to retrieve the item.
+
+| 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 - can work with Language parameter to specify the language other than current session language.
+
+| 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 fetched with Id parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language &lt;Language[]&gt;
+
+Language(s) to use for filtering items.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Version &lt;String&gt;
+
+Version number to use for filtering items.
+
+| 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. Should be the path to an item.
+
+* System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following gets the item using the path.
+
+```powershell
+Get-Item -Path "master:\content\home"
+```
+
+### EXAMPLE 2
+
+The following gets all items in the master database, located under Content, which are based on the template **Sample Item** using a Sitecore query.
+
+```powershell
+Get-Item -Path "master:" -Query "/sitecore/content//*[@@templatename='Sample Item']"
+```
+
+### EXAMPLE 3
+
+The following gets the item in the master database with the specified `ID`.
+
+```powershell
+Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+```
+
+### EXAMPLE 4
+
+The following gets the item in the master database using the Uri.
+
+```powershell
+Get-Item -Path "master:" -Uri "sitecore://master/{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}?lang=en&ver=1"
+```
+
+## Related Topics
+
+* Get-ChildItem
+