@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,136 @@
+# Get-TaskSchedule
+
+Returns one or more task schedule items using the specified criteria.
+
+## Syntax
+
+Get-TaskSchedule -Item <Item>
+
+Get-TaskSchedule -Path <String>
+
+Get-TaskSchedule \[\[-Database\] <Database>\] \[\[-Name\] <String>\]
+
+## Detailed Description
+
+The Get-TaskSchedule command returns one or more task schedule items, based on name/database filter, path or simply converting a Sitecore item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+Task item to be converted.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be returned as Task Schedule.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Database  <Database>
+
+Database containing the task items to be returned. If not provided all databases will be considered for filtering using the "Name" parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+Task filter - supports wildcards. Works with "Database" parameter to narrow tassk to only single database.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| 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.
+
+* Sitecore.Tasks.ScheduleItem 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-TaskSchedule
+Name                             Database        Active   Auto Remove  Is Due   Expired  Completed    Last Run               Next Run
+----                             --------        ------   -----------  ------   -------  ---------    --------               --------
+__Task Schedule                  master          True     False        True     False    False        0001-01-01 00:00:00    0001-01-01 00:00:00
+Check Bounced Messages           master          True     False        False    False    False        2014-07-29 10:18:43    2014-07-29 22:48:43
+Check DSN Messages               master          True     False        False    False    False        2014-07-29 10:19:18    2014-07-29 22:49:18
+Clean Confirmation IDs           master          True     False        False    False    False        2014-07-28 22:14:30    2014-07-31 02:14:30
+Clean Message History            master          True     False        False    False    False        2014-07-29 10:19:18    2014-07-29 22:49:18
+Close Outdated Connections       master          True     False        False    False    False        2014-07-29 12:30:22    2014-07-29 13:30:22
+Test-PowerShell                  master          True     False        False    False    False        2014-07-28 14:30:06    2014-08-01 17:32:07
+__Task Schedule                  web             True     False        True     False    False        0001-01-01 00:00:00    0001-01-01 00:00:00
+Check Bounced Messages           web             True     False        True     False    False        2013-11-04 08:36:22    2013-11-04 21:06:22
+Check DSN Messages               web             True     False        True     False    False        2013-11-04 08:36:22    2013-11-04 21:06:22
+Clean Confirmation IDs           web             True     False        False    False    False        2013-11-04 08:36:22    2013-11-04 21:36:22
+Clean Message History            web             True     False        True     False    False        2013-11-04 08:36:22    2013-11-04 21:06:22
+Close Outdated Connections       web             True     False        True     False    False        2013-11-04 09:36:23    2013-11-04 10:36:23
+Test-PowerShell                  web             True     False        True     False    False        2013-11-04 09:46:29    2013-11-04 09:46:30
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-TaskSchedule -Name "*Check*"
+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 10:18:43    2014-07-29 22:48:43
+Check DSN Messages               master          True     False        False    False    False        2014-07-29 10:19:18    2014-07-29 22:49:18
+Check Bounced Messages           web             True     False        True     False    False        2013-11-04 08:36:22    2013-11-04 21:06:22
+Check DSN Messages               web             True     False        True     False    False        2013-11-04 08:36:22    2013-11-04 21:06:22
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-TaskSchedule -Name "*Check*" -Database "master"
+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 10:18:43    2014-07-29 22:48:43
+Check DSN Messages               master          True     False        False    False    False        2014-07-29 10:19:18    2014-07-29 22:49:18
+```
+
+## Related Topics
+
+* [Start-TaskSchedule](start-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/get-updatepackagediff.md

@@ -0,0 +1,110 @@
+# Get-UpdatePackageDiff
+
+Performs a diff operation between the Source and taget path akin to Sitecore Courier. The diff is the difference that takes the content of Source folder and transforms it to Target. IMPORTANT! This functionality requires changes to web.config file on your sitecore server to work. Please consult the first Example.
+
+## Syntax
+
+Get-UpdatePackageDiff \[-SourcePath\] <String> \[\[-TargetPath\] <String>\]
+
+## Detailed Description
+
+Performs a diff operation between the Source and taget path akin to Sitecore Courier. The diff is the difference that takes the content of Source folder and transforms it to Target. IMPORTANT! This functionality requires changes to web.config file on your sitecore server to work. Please consult the first Example.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -SourcePath  <String>
+
+Path containing the current serialization items that needs to be transformed into Target.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -TargetPath  <String>
+
+Path containing the desired serialization state that the Source needs to be transformed to.
+
+| 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.Update.Interfaces.ICommand 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Required addition to web.config file for the functionality to work:
+
+```powershell
+<configuration>
+  <configSections>
+    <section name="sitecorediff" type="Sitecore.Update.Configuration.ConfigReader, Sitecore.Update"/>
+  </configSections>
+  <sitecorediff>
+    <commandfilters>
+      <filter id="changedFieldsFilter" mode="on" type="Sitecore.Update.Commands.Filters.ChangedFieldsFilter, Sitecore.Update">
+        <fields hint="list">
+          <field>__Created</field>
+          <field>{5DD74568-4D4B-44C1-B513-0AF5F4CDA34F}</field>
+          <field>__Revision</field>
+          <field>__Updated</field>
+          <field>__Updated by</field>
+        </fields>
+      </filter>
+    </commandfilters>
+    <dataproviders>
+      <dataprovider id="filesystemmain" type="Sitecore.Update.Data.Providers.FileSystemProvider, Sitecore.Update">
+        <param>$(id)</param>
+      </dataprovider>
+      <dataprovider id="snapshotprovider" type="Sitecore.Update.Data.Providers.SnapShotProvider, Sitecore.Update">
+        <param>$(id)</param>
+      </dataprovider>
+    </dataproviders>
+
+    <source type="Sitecore.Update.Data.DataManager, Sitecore.Update">
+      <param>source</param>
+    </source>
+
+    <target type="Sitecore.Update.Data.DataManager, Sitecore.Update">
+      <param>target</param>
+    </target>
+  </sitecorediff>
+</configuration>
+```
+
+### EXAMPLE 2
+
+Create an update package that transforms the serialized database state defined in C:\temp\SerializationSource into into set defined in C:\temp\SerializationTarget
+
+```powershell
+$diff = Get-UpdatePackageDiff -SourcePath C:\temp\SerializationSource -TargetPath C:\temp\SerializationTarget
+Export-UpdatePackage -Path C:\temp\SerializationDiff.update -CommandList $diff -Name name
+```
+
+## Related Topics
+
+* [Export-UpdatePackage](export-updatepackage.md)
+* [Install-UpdatePackage](install-updatepackage.md)
+* [https://sitecoresnippets.blogspot.com/2012/10/sitecore-courier-effortless-packaging.html](https://sitecoresnippets.blogspot.com/2012/10/sitecore-courier-effortless-packaging.html) 
+* [https://github.com/adoprog/Sitecore-Courier](https://github.com/adoprog/Sitecore-Courier) 
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,193 @@
+# Get-User
+
+Returns one or more Sitecore users using the specified criteria.
+
+## Syntax
+
+```
+Get-User [-Identity] <AccountIdentity> [-Authenticated]
+Get-User -Filter <String> [-Authenticated] [-ResultPageSize <Int32>]
+Get-User -Current
+```
+
+## Detailed Description
+
+The Get-User command returns a user or performs a search to retrieve multiple users from Sitecore.
+
+The Identity parameter specifies the Sitecore user to get. You can specify a user by its local name or fully qualified name. You can also specify user object variable, such as $&lt;user&gt;.
+
+To search for and retrieve more than one user, use the Filter parameter.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  &lt;AccountIdentity&gt;
+
+Specifies the Sitecore user by providing one of the following values.
+
+Local Name:
+
+```powershell
+admin
+```
+
+Fully Qualified Name:
+
+```powershell
+sitecore\admin
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Filter  &lt;String&gt;
+
+Specifies a simple pattern to match Sitecore users.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get all the users, use the asterisk wildcard:
+
+```powershell
+Get-User -Filter *
+```
+
+To get all the users in a domain use the following command:
+
+```powershell
+Get-User -Filter "sitecore\*"
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Current  &lt;SwitchParameter&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Authenticated  &lt;SwitchParameter&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ResultPageSize  &lt;Int32&gt;
+
+Specifies the number of users to retrieve per request to the user provider. Each page of users is written to the pipeline before the next request is made. Without specifying this parameter all accounts are retrieved before passing down the pipeline.
+
+| 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 identity of a user.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Security.Accounts.User
+
+  Returns one or more users.
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-User -Identity admin
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\admin           sitecore     True            False
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> "admin","michael" | Get-User
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\Admin           sitecore     True            False
+sitecore\michael         sitecore     False           False
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-User -Filter *
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+default\Anonymous        default      False           False
+extranet\Anonymous       extranet     False           False
+sitecore\Admin           sitecore     True            False
+sitecore\michael         sitecore     False           False
+```
+
+### EXAMPLE 4
+
+```powershell
+PS master:\> Get-User -Filter "michaellwest@*.com"
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\michael         sitecore     False           False
+```
+
+### EXAMPLE 5
+
+Expand the MemberOf property to see a list of roles that the specified user is a member.
+
+```powershell
+PS master:\> Get-User -Identity sitecore\michael | Select-Object -ExpandProperty MemberOf
+
+Name                                     Domain       IsEveryone
+----                                     ------       ----------
+sitecore\PowerShell Extensions Remoting  sitecore     False
+sitecore\Developer                       sitecore     False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Set-User](set-user.md)
+* [New-User](new-user.md)
+* [Remove-User](remove-user.md)
+* [Unlock-User](unlock-user.md)
+

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

@@ -0,0 +1,38 @@
+# Get-UserAgent
+
+Returns the current user's browser user agent.
+
+## Syntax
+
+## Detailed Description
+
+Returns current user's browser user agent. Works only if Console is running outside of job. \(e.g. in ISE - script needs to be run from the dropdown under the "Execute" button\)
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+## 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:\> Get-UserAgent
+
+Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/import-function.md

@@ -0,0 +1,83 @@
+# Import-Function
+
+Imports a function script from the script library's "Functions" folder.
+
+## Syntax
+
+Import-Function \[-Name\] <String> \[-Library <String>\] \[-Module <String>\]
+
+## Detailed Description
+
+The Import-Function command imports a function script from the script library's "Functions" folder.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the script in the "Functions" library or one of its sub-libraries.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Library  <String>
+
+Name of the library withing the "Functions" library. Provide this name to disambiguate a script from other scripts of the same name that might exist in multiple sub-librarties of the Functions library.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Module  <String>
+
+Name of the module "Functions" are going to be taken from. Provide this name to disambiguate a script from other scripts of the same name that might exist in multiple Modules.
+
+| 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.Object 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+The following imports a Resolve-Error function that you may later use to get a deeper understanding of a problem with script should one occur by xecuting the "Resolve-Error" command that was imported as a result of the execution of the following line
+
+```powershell
+PS master:\> Import-Function -Name Resolve-Error
+```
+
+## Related Topics
+
+* [Invoke-Script](invoke-script.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+