@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,243 @@
+# New-Rendering
+
+Creates new rendering definition that can later be added to an item.
+
+## Syntax
+
+```powershell
+New-Rendering [-Item] <Item> [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <Item>] [-Cacheable] [-VaryByData] [-VaryByDevice] [-VaryByLogin] [-VaryByParameters] [-VaryByQueryString] [-VaryByUser] [-Language <String[]>]
+
+New-Rendering [-Path] <String> [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <Item>] [-Cacheable] [-VaryByData] [-VaryByDevice] [-VaryByLogin] [-VaryByParameters] [-VaryByQueryString] [-VaryByUser] [-Language <String[]>]
+
+New-Rendering -Id <String> [-Database <String>] [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <Item>] [-Cacheable] [-VaryByData] [-VaryByDevice] [-VaryByLogin] [-VaryByParameters] [-VaryByQueryString] [-VaryByUser] [-Language <String[]>]
+```
+
+## Detailed Description
+
+Creates new rendering definition that can later be added to an item. Most parameters can later be overriden when calling Add-Rendering.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Parameter  &lt;Hashtable&gt;
+
+Rendering parameters as hashtable
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PlaceHolder  &lt;String&gt;
+
+Placeholder for the rendering to be placed into.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DataSource  &lt;Item&gt;
+
+Datasource for the rendering.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Cacheable  &lt;SwitchParameter&gt;
+
+Defined whether the rendering is cacheable.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByData  &lt;SwitchParameter&gt;
+
+Defines whether a data-specific cache version of the rendering should be kept.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByDevice  &lt;SwitchParameter&gt;
+
+Defines whether a device-specific cache version of the rendering should be kept.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByLogin  &lt;SwitchParameter&gt;
+
+Defines whether a login - specific cache version of the rendering should be kept.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByParameters  &lt;SwitchParameter&gt;
+
+Defines whether paremeter - specific cache version of the rendering should be kept.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByQueryString  &lt;SwitchParameter&gt;
+
+Defines whether query string - specific cache version of the rendering should be kept.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -VaryByUser  &lt;SwitchParameter&gt;
+
+Defines whether a user - specific cache version of the rendering should be kept.
+
+| 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 - can work with Language parameter to narrow the publication scope.
+
+| 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 - 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 |
+
+### -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 |
+
+## 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.Layouts.RenderingDefinition 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Find item defining rendering and create rendering definition.
+
+```powershell
+# Find the rendering item and convert to a rendering
+$renderingPath = "/sitecore/layout/Renderings/Feature/Experience Accelerator/Page Content/Page Content"
+$renderingItem = Get-Item -Database "master" -Path $renderingPath | New-Rendering -Placeholder "main"
+# Find the item to receive the new rendering
+$item = Get-Item -Path "master:\content\Training\Playground\play1\Home"
+# Add the rendering to the item
+Add-Rendering -Item $item -PlaceHolder "main" -Instance $renderingItem -Parameter @{ "Reset Caching Options" = "1" } -FinalLayout
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-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/new-role.md

@@ -0,0 +1,56 @@
+# New-Role
+
+Creates a new Sitecore role.
+
+## Syntax
+
+New-Role \[-Identity\] <AccountIdentity>
+
+## Detailed Description
+
+The New-Role command creates a new 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 \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Security.Accounts.Role 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> New-Role -Identity Michael
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/new-securitysource.md

@@ -0,0 +1,176 @@
+# New-SecuritySource
+
+Creates new User & Role source that can be added to a Sitecore package.
+
+## Syntax
+
+New-SecuritySource \[-Account\] <Account> \[-Name\] <String>
+
+New-SecuritySource \[-Identity\] <AccountIdentity> \[\[-AccountType\] <Unknown \| Role \| User>\] \[-Name\] <String>
+
+New-SecuritySource \[-Filter\] <String\[\]> \[\[-AccountType\] <Unknown \| Role \| User>\] \[-Name\] <String>
+
+## Detailed Description
+
+Creates new User & Role source that can be added to a Sitecore package.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Account  <Account>
+
+User or Role provided from e.g. Get-Role or Get-User Cmdlet.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Identity  <AccountIdentity>
+
+User or role name including domain for which the access rule is being created. If no domain is specified - 'sitecore' will be used as the default domain.
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: adam
+Fully Qualified Name
+    Example: sitecore\adam
+```
+
+if -AccountType parameter is specified as Role - only roles will be taken into consideration. if -AccountType parameter is specified as User - only users will be taken into consideration.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Filter  <String\[\]>
+
+Specifies a simple pattern to match Sitecore roles & users.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get security for all roles, use the asterisk wildcard: Get-ItemAcl -Filter \*
+
+To security got all roles in a domain use the following command: Get-ItemAcl -Filter "sitecore\*"
+
+if -AccountType parameter is specified as Role - only roles will be taken into consideration. if -AccountType parameter is specified as User - only users will be taken into consideration.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -AccountType  <AccountType>
+
+* Unknown - Both Roles and users will be taken into consideration when looking for accounts through either -Identity or -Filter parameters
+* Role - Only Roles will be taken into consideration when looking for accounts through either -Identity or -Filter parameters
+* User - Only Users will be taken into consideration when looking for accounts through either -Identity or -Filter parameters 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 3 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+Name of the security source.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| 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.Security.Accounts.Account 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Install.Security.SecuritySource 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Following example creates a new package, adds sitecore\admin user to it and saves it in the Sitecore Package folder+ gives you an option to download the saved package.
+
+```powershell
+# Create package
+$package = New-Package "Packing in Powerful Ways";
+
+# Set package metadata
+$package.Sources.Clear();
+
+$package.Metadata.Author = "Adam Najmanowicz, Michael West";
+$package.Metadata.Publisher = "Powerful Ways";
+$package.Metadata.Version = "1.0";
+$package.Metadata.Readme = 'This text will be visible to people installing your package'
+
+# Create security source with Sitecore Administrator only
+$source = New-SecuritySource -Identity sitecore\admin -Name "Sitecore Admin" 
+$package.Sources.Add($source);
+
+# Save package
+Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
+
+# Offer the user to download the package
+Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
+```
+
+### EXAMPLE 2
+
+Following example creates a new package, adds all roles within the "sitecore" domain to it and saves it in the Sitecore Package folder+ gives you an option to download the saved package.
+
+```powershell
+$package = New-Package "Packing in Powerful Ways";
+
+# Set package metadata
+$package.Sources.Clear();
+
+$package.Metadata.Author = "Adam Najmanowicz, Michael West";
+$package.Metadata.Publisher = "Powerful Ways";
+$package.Metadata.Version = "1.0";
+$package.Metadata.Readme = 'This text will be visible to people installing your package'
+
+# Create security source with all roles within the sitecore domain
+$source = New-SecuritySource -Filter sitecore\* -Name "Sitecore Roles" -AccountType Role
+$package.Sources.Add($source);
+
+# Save package
+Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
+
+# Offer the user to download the package
+Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,161 @@
+# New-User
+
+Creates a new Sitecore user.
+
+## Syntax
+
+New-User \[-Identity\] <AccountIdentity> \[-Password <String>\] \[-Email <String>\] \[-FullName <String>\] \[-Comment <String>\] \[-Portrait <String>\] \[-Enabled\] \[-ProfileItemId <ID>\]
+
+## Detailed Description
+
+The New-User command creates a new user in Sitecore.
+
+The Identity parameter specifies the Sitecore user to create. 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: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Password  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Email  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -FullName  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Comment  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Portrait  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Enabled  <SwitchParameter>
+
+Specifies that the account should be enabled. When enabled, the Password parameter is required.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -ProfileItemId  <ID>
+
+Specifies the profile id to use for the user.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| 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 1
+
+```powershell
+PS master:\> New-User -Identity michael
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> New-User -Identity michael -Enabled -Password b -Email michaellwest@gmail.com -FullName "Michael West"
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> New-User -Identity michael -PassThru
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\michael2        sitecore     False           False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-User](get-user.md)
+* [Set-User](set-user.md)
+* [Remove-User](remove-user.md)
+* [Unlock-User](unlock-user.md)
+