Chat now with support
Chat with Support

Metalogix Content Matrix 8.9 - Public Folder Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Connecting to Public Folders Connecting to SharePoint Preparing for Your Migration Configuring Copying Options Saving or Running a Migration Action Log Files Using PowerShell with Content Matrix Modifying Content Matrix Configuration and Settings Configuring Content Matrix for Distributed Migration Frequently Asked Questions About Us

Metalogix.SharePoint.Commands

Metalogix Content Matrix can generate PowerShell script for you, for any migration action that is available through it. The below cmdlets are used in the generated PowerShell script, but can also be used to write your own script, should you desire to do so. For more information on each cmdlet, simply type get-help [cmdlet]. For example, if you want more information on Copy-MLSharePointList cmdlet you would enter get-help Copy-MLSharePointList, followed by the Enter (return) key.

Below is a list of the available cmdlets (and their parameters), broken up into the available commands for each snap-in.

Add-MLSharePointSiteCollection

·WebApplicationName - Name of the Web Application to Create the Site Collection in. Web Application must exist in the specified Target. (Mandatory)

·WebTemplateName - Web (Site) Template to use for the Site Collection. Web (Site) Template must exist. The value must be in the form name#configuration. E.g., STS#1 for Blank Site (Mandatory)

·Language - Language to use for the Site Collection. Can be Language Code (LCID) or Language Name. Language must exist in the specified Target. (Mandatory)

·ExperienceVersion - The experience version to use when creating the site. This setting is only used for SharePoint 2013. Use 15 for the 2013 UI and 14 for the 2010 UI.

·Title - The Title for the Site Collection. (Mandatory)

·Description - Description for the Site Collection.

·Path - Managed Path for the Site Collection. Include forward-slash characters where required. E.g., "/sites/" or "/sites/". (Mandatory)

·URL - Server Relative portion of URL solely used to identify the Site Collection itself. E.g., "TestSiteCollection" (Mandatory)

·

·OwnerLogin - Domain and username to be used as the Primary Administrator for the Site Collection. E.g., "sampledomain\sample.user" (Mandatory)

·SecondaryOwnerLogin - Domain and username to be used as the Secondary Administrator for the Site Collection. E.g., "sampledomain\another.user"

·ContentDatabaseName - Content Database Name to use. Not specifying this value will use the default content database (auto detect).

·SelfServiceCreateMode - Allow users without Farm Administrator privileges to add the Site Collection.

·SetSiteQuota - Set Quota for the Site Collection.

·QuotaMaximum - Limit site storage to maximum size (Mb). SetSiteQuota must be set to true and SelfServiceCreateMode should be false. Mutually exclusive with QuotaID.

·QuotaWarning - Send a warning email when the site storage reaches this size (Mb). SetSiteQuota must be set to true and SelfServiceCreateMode should be false. Mutually exclusive with QuotaID.

·QuotaID - Use Quota Template. Can be the integer ID or the string name of the Quota. SetSiteQuota must be set to true and SelfServiceCreateMode should be false.

·EmailServer - An email server to use for sending job completion emails.

·EmailUserName - A user name to use when connecting to the specified email server. If not set, default credentials will be used.

·EmailPassword - A password to use for the specified user when connecting to the specified email server. If no user name is set, default credentials will be used.

·ToEmailAddress - A semicolon delimited list of email addresses to which the job completion email will be sent.

·FromEmailAddress - The email address of the mailbox from which the job completion emails will be sent.

·CCEmailAddress - A semicolon delimited list of email addresses to CC on the job completion email.

·BCCEmailAddress - A semicolon delimited list of email addresses to BCC on the job completion email.

·EmailSuccessTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job is successful.

·EmailFailureTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job fails.

·EmailSubject - A custom subject for the job completion email.

·Transformers - The collection of data transformers which the action needs to run. Note that if the passed-in value for this parameter does not include transformers which are considered mandatory, they will be added automatically.

·Quiet - If set, the operation will not report progress to the PowerShell console.

·JobFile - The name of a job file to use for logging. If the file does not exist it will be created.

·Source - The source node for the actions.

·Target - The target node for the actions.

·JobDatabase - The connection string of a jobs database to use for logging. If the connection string is invalid, an exception is thrown. If both 'JobFile' and 'JobDatabase' parameters are specified, then the 'JobDatabase' parameter will take precedence and the job will only be written to the job database.

Add-Permissions

·Name - The name of the user or group you wish to assign a permission level to. (Mandatory)

·PermissionLevel - The name of the permission level you want to grant the specified user or group. (Mandatory)

·Recurse - A flag that indicates the given permissions level should be granted to the given user for each item below the target which has unique permissions.

·EmailServer - An email server to use for sending job completion emails.

·EmailUserName - A user name to use when connecting to the specified email server. If not set, default credentials will be used.

·EmailPassword - A password to use for the specified user when connecting to the specified email server. If no user name is set, default credentials will be used.

·ToEmailAddress - A semicolon delimited list of email addresses to which the job completion email will be sent.

·FromEmailAddress - The email address of the mailbox from which the job completion emails will be sent.

·CCEmailAddress - A semicolon delimited list of email addresses to CC on the job completion email.

·BCCEmailAddress - A semicolon delimited list of email addresses to BCC on the job completion email.

·EmailSuccessTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job is successful.

·EmailFailureTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job fails.

·EmailSubject - A custom subject for the job completion email.

·Transformers - The collection of data transformers which the action needs to run. Note that if the passed-in value for this parameter does not include transformers which are considered mandatory, they will be added automatically.

·Quiet - If set, the operation will not report progress to the PowerShell console.

·JobFile - The name of a job file to use for logging. If the file does not exist it will be created.

·Source - The source node for the actions.

·Target - The target node for the actions.

·JobDatabase - The connection string of a jobs database to use for logging. If the connection string is invalid, an exception is thrown. If both 'JobFile' and 'JobDatabase' parameters are specified, then the 'JobDatabase' parameter will take precedence and the job will only be written to the job database.

Add-SharePointFolder

·Name - The name of the folder to be created. (Mandatory)

·EmailServer - An email server to use for sending job completion emails.

·EmailUserName - A user name to use when connecting to the specified email server. If not set, default credentials will be used.

·EmailPassword - A password to use for the specified user when connecting to the specified email server. If no user name is set, default credentials will be used.

·ToEmailAddress - A semicolon delimited list of email addresses to which the job completion email will be sent.

·FromEmailAddress - The email address of the mailbox from which the job completion emails will be sent.

·CCEmailAddress - A semicolon delimited list of email addresses to CC on the job completion email.

·BCCEmailAddress - A semicolon delimited list of email addresses to BCC on the job completion email.

·EmailSuccessTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job is successful.

·EmailFailureTemplateFilePath - The absolute file path of the html template to use for the job completion email when the job fails.

·EmailSubject - A custom subject for the job completion email.

·Transformers - The collection of data transformers which the action needs to run. Note that if the passed-in value for this parameter does not include transformers which are considered mandatory, they will be added automatically.

·Quiet - If set, the operation will not report progress to the PowerShell console.

·JobFile - The name of a job file to use for logging. If the file does not exist it will be created.

·Source - The source node for the actions.

·Target - The target node for the actions.

·JobDatabase - The connection string of a jobs database to use for logging. If the connection string is invalid, an exception is thrown. If both 'JobFile' and 'JobDatabase' parameters are specified, then the 'JobDatabase' parameter will take precedence and the job will only be written to the job database.

Related Documents