Chat now with support
Chat with Support

Replicator 7.4 - Command Line Reference Guide

Introduction Installing Metalogix Replicator Configuring Metalogix Replicator
Enable Web Applications for Replication Connect Web Applications Map SharePoint Content for Replication
Add Replicator List Mappings Add Replicator Map Family Remove Replicator List Mappings Remove Replicator Map Family Disable Replicator Alert Replication Disable Replicator Map Disable Replicator Map Family Suspend Replicator Map Family Resume Replicator Map Family Enable Replicator Alert Replication Enable Replicator Map Enable Replicator Map Family Write Replicator Map Write Replicator Map Families Suspend Replicator Map Families Write Replicator Paused Map Families Resume Replicator Map Families Set Replicator Map Family Write Replicator Maps Set Replicator Map Inheritance Update Replicator Map Update Replicator Map Connection Update Replicator Map Family Update Replicator Map Lists
Get Replicator Objects Commands
Managing Metalogix Replicator
Replicate SharePoint Content Monitor Replication Networks Maintain Replication Networks
Register Offline Activation Add Replicator Supported Web Part Add Replicator Supported WSS Versions Set Replicator Alerts Remove Replicator Orphaned Config Remove Replicator Orphaned Disk Objects Clear Replicator Web Application Configuration Copy Replicator Alerts Remove Replicator Supported Web Part Export Replicator Settings Import Replicator Settings Export Replicator KPI Settings Import Replicator KPI Settings Export Replicator KPI Results Import Replicator KPI Results Clear Replicator Map Queue Move Replicator Alerts Clear Replicator Queue All Clear Replicator Queue Completed Clear Replicator Queue Completed or Error Reapply Replicator Error Queue Items Install-ReplicatorSolution Test Replicator Consistency Start Replicator Maintenance Update Replicator Account Write Replicator Features Update Replicator Settings File
Managing Administrative Farm Settings
Appendix – Repadm equivalents for PowerShell commands About

Schedule-ReplicatorMap

PowerShell

Schedule-ReplicatorMap

Purpose

Schedules Replication Map and its inheriting children for replication.

Edition

All

Comment

Schedules the map at the specified URL, including the child Web Sites. When queuing large amounts of content, we recommend separating the content into batches. For example, you can queue only site structure, then permissions, and then list items. Or you can queue one Site Collection or Web Site at a time.

 

Schedule-ReplicatorMap is not aware of any list dependencies. If you have a lookup list that is used by other lists, queue the lookup list ahead of any list that depends on it.

 

Queuing the "Add" events will queue all available entities for that event from the source. If the entity exists on the target, then the entity will be updated, if the entity does not exist on the target, then the entity will be added.

 

URL

Enter a URL to a Web Application, Site Collection, Web Site, List, or Folder.

 

JobName

Enter a name for the schedule job.

 

MapFamily

Queue using the Replication Map from specified Map Family. (optional)

IncludeChildTypes

Determines which child types are to be including when queuing a map. Child types include: 'WebApplication', 'SiteCollection', 'WebSite', 'List', and 'Folder'.
Only events at the root level will be queued for replication.
(optional)

Type 

Specify whether the URL is to a Web Application, Site Collection, Web Site, List, or Folder. If you do not specify a type, then the URL will be interpreted as a Web Site. (optional)

 

Connection

Only queue for the specified Connection. (optional)

 

OnlySiteStructure

Include only Site Collection and Web Site creation events. (optional)

 

ExcludeSiteStructure

Exclude Site Collection and Web Site creation events. (optional)

 

OnlyPermissions

Replicate only Web Site permissions. (optional)

 

OnlyMaps

Replicate only Replication Maps. (optional)

 

OnlyListItems

Replicate only list items and folders. (optional)

 

ListItemID

ID of individual list item to queue. (optional)

 

IgnoreConflicts

Ignore possible conflicts at the destination. (optional)

 

OnlyLastDays

Replicate only list items from the specified last days (excluding folders). (optional)

 

OnlyAlerts

Replicate only Alerts. (optional)

 

OnlyWFI

Replicate only Workflow associations and instances. (optional)

 

OnlyLookAndFeel

Replicate only Look and Feel events. (optional)

 

ExcludeLookAndFeel

Does not replicate Look and Feel events. (optional)

 

QueueVersions

Include All Versions. This will delete the list item or document specified, and then resend it with all the current versions on the source. (optional)

 

ClearList

Clear all items in the list. (optional)

 

QueueSetName

Tag all the events queued with the specified name. (optional)

 

Classification

Overrides the default Map Family classification.

 

EventSettingsXML

Specify the location of the XML with settings to use for the Queueing. This override settings that may be located on the Replication Map.

 

BackupMode

Uses the SharePoint site collection backup feature to create a backup of the specified site collection which is then packaged up and replicated to the target where the backup is then restored on the target, without remapping structure, domains, or users. If you do not specify a value, then backup mode is disabled. This option can only be used with Web Application and Site Collection map families. (optional)

Caution: Using this option overwrites site collections on the target farm.

 

IncludeEvents

Replicate only the specified events. You must specify the events, by number, as a semi-colon delimited list. For the list of event numbers, see "Supported Events".

 

ExcludeEvents

Replicate all events specified in the map family, except for the specified events. You must specify the events, by number, as a semi-colon delimited list. For the list of event numbers, see "Supported Events".

 

ScheduleType

Specify the type of schedule to be used for this job.

 

SpecificDateTime

Specify the specific date and time to perform replication. Use with the SpecificDateTime Schedule Type.

 

Date

Specify the date to perform the replication. Use with Monthly Schedule Type. 

 

Day

Specify the day of the week to perform the replication. Use with Weekly Schedule type. 

 

Hour

Specify the hour of the day to perform the replication. Use with the Monthly, Weekly, and Daily Schedule Type. 

 

Minute

Specify how many minutes past the hour to perform the replication. Use with the Monthly, Weekly, and Daily Schedule Types. 

PowerShell Code Example

Schedule-ReplicatorMap -URL "http://localwebapplication" -Type Website -IncludeChildTypes List,Folder -JobName "Test"

 

 

Returns

None

Arguments

[-Url] <String>

[[-JobName] <String>]

[-IncludeChildTypes <String>]

[-Connection <String>]

[[-MapFamily] <String>]

[-Type <String>]

[-OnlySiteStructure]

[-ExcludeSiteStructure]

[-OnlyPermissions]

[-OnlyListItems]

[-OnlyMaps]

[-OnlyAlerts]

[-OnlyLookAndFeel]

[-ExcludeLookAndFeel]

[-QueueVersions]

[-EventSettingsXML <String>]

[-ClearList]

[-IncludeEvents <String>]

[-ExcludeEvents <String>]

[-OnlyWFI]

[-ListItemID <Int32>]

[-QueueSetName <String>]

[-BackupMode [<Boolean>]]

[-Classification <String>]

[-IgnoreConflicts]

[-OnlyLastDays <Int32>]

[-ScheduleType [<String>]]

[-SpecificDateTime

[<string>]] [-Date [<Int32>]]

[-Day [<String>]]

[-Hour [<Int32>]]

[-Minute [<Int32>]]

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating