Chat now with support
Chat with Support

Metalogix Content Matrix 8.9 - File Share Edition User Guide

Introduction Entering the License Key Overview of Content Migration Content Matrix Console End User Interface Enabling Advanced Mode Enabling and Disabling Optimistic Mode Connecting to a File System Connecting to SharePoint Migrating to O365 Using the Azure Pipeline Preparing for Your Migration Initiating a Migration Configuring Copying Options Saving or Running a Migration Action Log Files Using PowerShell with Content Matrix
Configuring PowerShell for Use with Content Matrix Content Matrix PowerShell Commandlet List
Modifying Content Matrix Configuration and Settings Configuring Content Matrix for Distributed Migration Frequently Asked Questions About Us

Metalogix.File.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.

Copy-File

·IncludeFiles - Specify whether to include files. (Disabled)

·ExistingFileAction - Overwrite, rename, or skip on existing file with same name.

·DefaultContentType - Specify to migrate current content using the default target content type.

·ContentTypeID - Specify the content type id of the content type to map to.

·ContentTypeFieldMappings - Specify field mappings from source fields to the target content type.

·CorrectName - Enable/disable automatic replacement of invalid SharePoint characters in name.

·CorrectNameCharacter - Specify the replacement character for invalid SharePoint characters in name.

·RenameFiles - Enable/disable renaming of filenames using custom column.

·RenameColumn - Specify the column name of the column to use for renaming the files.

·LinkCorrectionOptions - Specify the link correction options.

·LoggingOptions - Specify the logging options.

·PermissionsOptions - Specify the permissions options.

·TargetHierarchyOptions - Specify the target hierarchy options.

·StoragePointOptions - Specify the target StoragePoint options.

·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.

Copy-FileAsHierarchy

·MigrateToDocSet

·PermissionsOptions

·TargetDocSetOptions

·MigrateToSubFolder

·TargetSubFolderOptions

·MigratePermissionsForSubFolder

·TargetDocLibOptions

·MigrateToSubSite

·TargetSubSiteOptions

·MigratePermissionsForSubSite

·TargetSubSiteTemplateOptions

·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.

·UseAzureOffice365Upload - Indicates if the copy operation to Office 365 should use the Azure SPO Migration Pipeline.

·EncryptAzureMigrationJobs - If the Azure SPO Migration Pipeline is being used, indicates if the job manifest file should be encrypted.

Copy-FileAsSiteHierarchy

This is the same as Copy-FileAsHierarchy with additional parameters.

Related Documents