@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/export-updatepackage.md

@@ -0,0 +1,111 @@
+# Export-UpdatePackage
+
+Exports a Sitecore update package containing a serialization diff list.
+
+## Syntax
+
+Export-UpdatePackage \[-CommandList\] <List\`1> \[\[-Name\] <String>\] \[\[-Path\] <String>\] \[-Readme <String>\] \[-LicenseFileName <String>\] \[-Tag <String>\]
+
+## Detailed Description
+
+The Export-UpdatePackage command generates a Sitecore update package containing a serialization diff list.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -CommandList  <List\`1>
+
+List of changes to be included in the package.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+Name of the package.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path the update package should be saved under.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 3 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Readme  <String>
+
+Contents of the "read me" instruction for the package
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -LicenseFileName  <String>
+
+file name of the license to be included with the package.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Tag  <String>
+
+Package tag.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+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
+
+* [Get-UpdatePackageDiff](get-updatepackagediff.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/export-user.md

@@ -0,0 +1,147 @@
+# Export-User
+
+Export \(serialize\) a Sitecore user to the filesystem on the server.
+
+## Syntax
+
+Export-User \[-Identity\] <AccountIdentity> \[-Root <String>\]
+
+Export-User \[-Identity\] <AccountIdentity> -Path <String>
+
+Export-User -Filter <String> \[-Root <String>\]
+
+Export-User \[-User\] <User> \[-Root <String>\]
+
+Export-User \[-User\] <User> -Path <String>
+
+Export-User -Current \[-Root <String>\]
+
+Export-User -Current -Path <String>
+
+## Detailed Description
+
+The Export-User command serializes a Sitecore user to the filesystem on the server.
+
+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 $<user>.
+
+To search for and retrieve more than one user, use the Filter parameter.
+
+You can also pipe a user from the Get-user command.
+
+© 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 |
+
+### -Filter  <String>
+
+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: Export-User -Filter \*
+
+To get all the users in a domain use the following command: Export-User -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -User  <User>
+
+User object retrieved from the Sitecore API or using the Get-User command.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Current  <SwitchParameter>
+
+Specifies that the current user should be serialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the file the user should be saved to.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+Overrides Sitecore Serialization root directory
+
+| 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.Security.Accounts.User 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Export-User -Identify sitecore\admin
+```
+
+## Related Topics
+
+* [Export-Role](export-role.md)
+* [Import-User](import-user.md)
+* [Export-Item](../packaging/export-item.md)
+* [Import-Role](import-role.md)
+* [Import-Item](export-user.md)
+* [Get-User](get-user.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+