Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Replicator 7.4 - Command Line Reference Guide

Table of Contents

Replicator System Management Lifecycle Replicator Administration

Replicator Management Shell Parameters with Quotes or Spaces

Using the Management Shell in UAC-enabled Environments

Manually Loading the Replicator Powershell Commands Repadm Commands

Installing Metalogix Replicator

Prepare SharePoint Farms Install Metalogix Replicator

Metalogix Replicator for SharePoint.exe

Examples

Configure Metalogix Replicator

ConfigWizard.exe

Offline Activation Examples Arguments

Configuring Metalogix Replicator

Enable Web Applications for Replication

Add User Mappings

AddReplicatorUserMappings XML File Example PowerShell Code Example

Returns Arguments

Configure Web Application

Set-ReplicatorWebAppConfig PowerShell Code Example

Returns Arguments

Remove Replicator User Mappings

Remove-ReplicatorUserMappings PowerShell Code Example

Returns Arguments

Write Default Replicator Data Folder

Write-ReplicatorDefaultDataFolder PowerShell Code Example

Returns Arguments

Write Replicator Data Folders

Write-ReplicatorDataFolders PowerShell Code Example

Returns Arguments

Update Default Replicator Data Folder

Update-ReplicatorDefaultDataFolder PowerShell Code Example

Returns Arguments

Connect Web Applications

Add Replication Group

Add-ReplicatorGroup PowerShell Code Example

Returns Arguments

Add Replicator Group Connection

Add-ReplicatorGroupConnection PowerShell Code Example

Returns Arguments

Remove Replicator Group

Remove-ReplicatorGroup PowerShell Code Example

Returns Arguments

Remove Replicator Group Connection

Remove-ReplicatorGroupConnection PowerShell Code Example

Returns Arguments

Set Replicator RDC Cache

Set-ReplicatorRDCCache PowerShell Code Example

Returns Arguments

Set Replicator RDC Dynamic Cache

Set-ReplicatorRDCDynamicCache PowerShell Code Example

Returns Arguments

Update Replicator Connection

Update-ReplicatorConnection PowerShell Code Example

Returns Arguments

Update Replicator Connections

Update-ReplicatorConnections PowerShell Code Example

Returns Arguments

Update Replicator Group

Update-ReplicatorGroup PowerShell Code Example

Returns Arguments

Map SharePoint Content for Replication

Add Replicator List Mappings

Add-ReplicatorListMappings XML File Example PowerShell Code Example

Returns Arguments

Add Replicator Map Family

Add-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Remove Replicator List Mappings

Remove-ReplicatorListMappings PowerShell Code Example

Returns Arguments

Remove Replicator Map Family

Remove-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Disable Replicator Alert Replication

Disable-ReplicatorAlertReplication PowerShell Code Example

Returns Arguments

Disable Replicator Map

Disable-ReplicatorMap PowerShell Code Example

Returns Arguments

Disable Replicator Map Family

Disable-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Suspend Replicator Map Family

Suspend-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Resume Replicator Map Family

Resume-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Enable Replicator Alert Replication

Enable-ReplicatorAlertReplication PowerShell Code Example

Returns Arguments

Enable Replicator Map

Enable-ReplicatorMap PowerShell Code Example

Returns Arguments

Enable Replicator Map Family

Enable-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Write Replicator Map

Write-ReplicatorMap PowerShell Code Example

Returns Arguments

Write Replicator Map Families

Write-ReplicatorMapFamilies PowerShell Code Example

Returns Arguments

Suspend Replicator Map Families

Suspend-ReplicatorMapFamilies PowerShell Code Example

Returns Arguments

Write Replicator Paused Map Families

Write-ReplicatorPausedMapFamilies PowerShell Code Example

Returns Arguments

Resume Replicator Map Families

Resume-ReplicatorMapFamilies PowerShell Code Example

Returns Arguments

Set Replicator Map Family

Set-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Write Replicator Maps

Write-ReplicatorMaps PowerShell Code Example

Returns Arguments

Set Replicator Map Inheritance

Set-ReplicatorMapInheritance PowerShell Code Example

Returns Arguments

Update Replicator Map

Update-ReplicatorMap PowerShell Code Example

Returns Arguments

Update Replicator Map Connection

Update-ReplicatorMapConnection PowerShell Code Example

Returns Arguments

Update Replicator Map Family

Update-ReplicatorMapFamily PowerShell Code Example

Returns Arguments

Update Replicator Map Lists

Update-ReplicatorMapLists PowerShell Code Example

Returns Arguments

Get Replicator Objects Commands

Get Replicator Web Application

Get-ReplicatorWebApp PowerShell Code Example

Returns Arguments Piping Example

Get Replicator Group

Get-ReplicatorGroup PowerShell Code Example

Returns Arguments Piping Example

Get Replicator Map Family

Get-ReplicatorMapFamily PowerShell Code Example

Returns Arguments Piping Example

Get Replicator Map

Get-ReplicatorMap PowerShell Code Example

Returns Arguments Piping Example

Get Replicator Connection

Get-ReplicatorConnection PowerShell Code Example

Returns Arguments Piping Example

Disable Replicator

Disable-Replicator PowerShell Code Example

Returns Arguments

Managing Metalogix Replicator

Replicate SharePoint Content

Export Replicator Packages

Export-ReplicatorPackages PowerShell Code Example

Returns Arguments

Import Replicator Packages

Import-ReplicatorPackages PowerShell Code Example

Returns Arguments

Schedule Replicator Map

Schedule-ReplicatorMap PowerShell Code Example

Returns Arguments

Supported Events

Note

Backup Mode for Schedule Replicator Map

Schedule-ReplicatorMap –BackupMode Uses for BackupMode

Start Replicator Processing

Start-ReplicatorProcessing PowerShell Code Example

Returns Arguments

Compare Replicator Data

Compare-ReplicatorData PowerShell Code Example

Returns Arguments Detailed Examples

Monitor Replication Networks

Write Replicator Info

Write-ReplicatorInfo PowerShell Code Example

Returns Arguments

Write Replicator Counters

Write-ReplicatorCounters PowerShell Code Example

Returns Arguments

Write Replicator List Mappings

Write-ReplicatorListMappings PowerShell Code Example

Returns Arguments

Write Replicator User Mappings

Write-ReplicatorUserMappings PowerShell Code Example

Returns Arguments

Write Replicator Supported WSS Versions

Write-ReplicatorSupportedWSSVersions PowerShell Code Example

Returns Arguments

Test Replicator List Consistency

Test-ReplicatorListConsistency PowerShell Code Example

Returns Arguments

Write Replicator Supported Web Parts

Write-ReplicatorSupportedWebParts PowerShell Code Example

Returns Arguments

Save Replicator Current Counters

Save-ReplicatorCurrentCounters PowerShell Code Example

Returns Arguments

Maintain Replication Networks

Register Offline Activation

Register-ReplicatorLicenseOffline PowerShell Code Examples

Returns Arguments

Add Replicator Supported Web Part

Add-ReplicatorSupportedWebPart PowerShell Code Example

Returns Arguments

Add Replicator Supported WSS Versions

Add-ReplicatorSupportedWSSVersions PowerShell Code Example

Returns Arguments

Set Replicator Alerts

Set-ReplicatorAlerts PowerShell Code Example

Returns Arguments

Remove Replicator Orphaned Config

Remove-ReplicatorOrphanedConfig PowerShell Code Example

Returns Arguments

Remove Replicator Orphaned Disk Objects

Remove-ReplicatorOrphanedDiskObjects PowerShell Code Example

Returns Arguments

Clear Replicator Web Application Configuration

Clear-ReplicatorWebAppConfig PowerShell Code Example

Returns Arguments

Copy Replicator Alerts

Copy-ReplicatorAlerts PowerShell Code Example

Returns Arguments

Remove Replicator Supported Web Part

Remove-ReplicatorSupportedWebPart PowerShell Code Example

Returns Arguments

Export Replicator Settings

Export-ReplicatorSettings PowerShell Code Example

Returns Arguments

Import Replicator Settings

Import-ReplicatorSettings PowerShell Code Example

Returns Arguments

Export Replicator KPI Settings

Export-ReplicatorKPISettings PowerShell Code Example

Returns Arguments

Import Replicator KPI Settings

Import-ReplicatorKPISettings PowerShell Code Example

Returns Arguments

Export Replicator KPI Results

Export-ReplicatorKPIResults PowerShell Code Example

Returns Arguments

Import Replicator KPI Results

Import-ReplicatorKPIResults PowerShell Code Example

Returns Arguments

Clear Replicator Map Queue

Clear-ReplicatorMapQueue PowerShell Code Example

Returns Arguments

Move Replicator Alerts

Move-ReplicatorAlerts PowerShell Code Example

Returns Arguments

Clear Replicator Queue All

Clear-ReplicatorQueueAll PowerShell Code Example

Returns Arguments

Clear Replicator Queue Completed

Clear-ReplicatorQueueCompleted PowerShell Code Example

Returns Arguments

Clear Replicator Queue Completed or Error

Clear-ReplicatorQueueCompletedOrError PowerShell Code Example

Returns Arguments

Reapply Replicator Error Queue Items

Reapply-ReplicatorErrorQueueItems PowerShell Code Example

Returns Arguments

Install-ReplicatorSolution

Install-ReplicatorSolution PowerShell Code Example

Returns Arguments

Test Replicator Consistency

Test-ReplicatorConsistency PowerShell Code Example

Returns Arguments

Start Replicator Maintenance

Start-ReplicatorMaintenance PowerShell Code Example

Returns Arguments

Update Replicator Account

Update-ReplicatorAccount PowerShell Code Example

Returns Arguments

Write Replicator Features

Write-ReplicatorFeatures PowerShell Code Example

Returns Arguments

Update Replicator Settings File

Update-ReplicatorSettingsFile PowerShell Code Example

Returns Arguments

Managing Administrative Farm Settings

Set Replicator Farm Name

Set-ReplicatorFarmName: Set the Replicator Farm Name PowerShell Code Example

Returns Arguments

Write Replicator Farm Name

Write-ReplicatorFarmName: Write the Replicator Farm Name. PowerShell Code Example

Returns Arguments

Remove Replicator Farm From Network Health

Remove-ReplicatorFarmFromNetworkHealth PowerShell Code Example

Returns Arguments

Set Replicator Administrative Farm Settings

Set-ReplicatorAdministrativeFarmSettings PowerShell Code Example

Returns Arguments

Clear Replicator Administrative Farm Settings

Clear-ReplicatorAdministrativeFarmSettings PowerShell Code Example

Returns Arguments

Write Replicator Administrative Farm Settings

Write-ReplicatorAdministrativeFarmSettings PowerShell Code Example

Returns Arguments

Queue Replicator Administrative Farm Settings

Queue-ReplicatorAdministrativeFarmSettings PowerShell Code Example

Returns Arguments

Add Replicator Administrative Alerts

Add-ReplicatorAdministrativeAlerts PowerShell Code Example

Returns Arguments

Remove Replicator Administrative Alerts

Remove-ReplicatorAdministrativeAlerts PowerShell Code Example

Returns Arguments

Write Replicator Administrative Alerts

Write-ReplicatorAdministrativeAlerts PowerShell Code Example

Returns Arguments

Appendix – Repadm equivalents for PowerShell commands

Repadm Commands

Running Repadm Commands from PowerShell

Contact Quest Technical Support Resources

Introduction

This guide will provide an overview and list of all the available PowerShell commands for the configuration and management of Metalogix Replicator.

Replicator System Management Lifecycle

The Metalogix Replicator System Management Lifecycle describes our recommendation for deploying Replicator and then performing ongoing administration. The framework consists of several brief phases, which are explained in the following diagram:

METALO~4_img2

This document describes the Metalogix Replicator command-line interface using the phases of the framework.

Replicator Administration

Replicator can be administered the Replicator Management Shell, which runs PowerShell cmdlets. This tool is used to:

·Complete many common administrative tasks that are available in the Replicator user interface.

·Script repetitive tasks.

·Perform long running tasks that may time out when triggered from within a web browser.

·Complete commands that are not available in the SharePoint interface.

Replicator Management Shell

The Replicator Management Shell provides Powershell commands for managing Replicator. To start the management shell, Start >Metalogix > Replicator > Replicator Management Shell. (Note, if you are running anything earlier than Windows Server 2012, you access the Replicator Management Shell by doing the following: Start> All Programs> Metalogix> Replicator> Replicator Management Shell).

The following code example shows how to enable a web application from the Replicator Management Shell:

Set-ReplicatorWebAppConfig -URL http://corporateoffice -Enabled 1

Refer to Replication Administration for the cmdlet syntax of supported administration functions.

info

NOTE: Specific argument tags such as -URL are not required in the management shell, but you must specify all required arguments in the order specified in this document.

Self Service Tools: Knowledge Base; Notifications & Alerts; Product Support; Software Downloads; Technical Documentation; User Forums; Video Tutorials; RSS Feed

Contact Us: Licensing Assistance; Technical Support; View All

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center