Chat now with support
Chat mit Support

Metalogix Essentials for Office 365 2.11 - User Guide

Connecting to SharePoint Site or Site Collections Copyright Tool Overview
General Tool Configuration Profile Manager Proxy Mode Azure Turbo and CSOM Creating User Mapping Creating User and Template Reports Support and Troubleshooting Activation Modes of Migration
Home Tab Migration Analysis Tab Migrator Tab
Interface Connect to Resources Copy Sites Live Compare Hyper Mode Classic Mode Copy Alerts Orphaned Users Copy In-Place Tagging of SharePoint Items Incremental/Delta Copy Forms Migration Workflow Migration Save Site to XML
File Manager Tab Drives Tab
Interface Overview Migration Job Structure Connecting to Resources Copy Google Drive Copy File Share Copy My Sites to OneDrive for Business Copy Tenant Copy Box Copy Dropbox Nintex Deployment
Security Manager Tab Term Store Manager Tab Administrator Tab Backup Tab
Interface Overview Backup Job Structure Advanced Search Retention Policies Storage for Backup Import/Export Backup Archives Connecting to SharePoint and OneDrive for Business Connecting to Cloud Storage Hyper vs Classic Backup Setup Hyper SharePoint Online Backup Hyper OneDrive Backup Hyper Office 365 Groups Backup Smart Backup Classic SharePoint Online Backup Classic OneDrive Backup Classic Office365 Groups Backup Classic Mailbox Backup Change Properties for Backup Admin Management Scheduling Backup Jobs Backup Project Conversion
Help Tab View Tab Architect Tab Public Folders for SharePoint Tab Scripts Appendix About


This section provides an overview of the ways in which Scripts can be used to manage certain product functionality for Essentials.

Using Scripts and Integration with Windows Task Scheduler

As with many of Metalogix Essentials operations, users may generate a command line script (refer to Scripting Reference Guide for additional information).  For repetitive operations like backups, the application has been integrated with Windows Task Scheduler (WTS).  WTS allows users to run jobs on a schedule, in the background, even if no user is currently logged into the computer.  

Once a script is run, the history will be available in the log viewer.  Unless specified in the script all history files will have auto-generated file names as a unique string of numbers. The path to all log files is: C:\Users\[UserName]\Essentials\.metscheadata\appLog.

To create a new script and load it into Windows Task Scheduler:

1.Press the Schedule button within any of the Essentials wizards.
Schedule button 2

2.The Schedule Task window will open, it will contain a command line script. Press Copy to Clipboard.
scripting 1

3.Open Windows Task Scheduler and select the Create Basic Task option in the Actions panel.
using scripts3

4.Give your task a name and a description, click Next.
using scripts4

5.Select when you would like the task to start, click Next.
using scripts5

6.Set a start date and time, and how many days you would like the task to continue for. Click Next.
using scripts6

7.Leave the Action selection as "start program" and click Next.
using scripts7

8.In the Program/Script field, paste the script you copied to the clipboard in step 2. Click Next.
using scripts8

9.On the summary page, click Finish.

Scripting Reference Guide

Much of the application's functionality is accessible through a scripting interface.  Scripts can be developed using the list of commands provided below, or by running most wizards and then selecting the Schedule option in the end. This will open the Schedule Task screen where a script is available for copy.  Scripts can be run in Scheduler (located in the View tab of the ribbon), PowerShell scripts, within Windows Task Scheduler or simply fired from the command line.
Schedule button 2

Please note that new scripting options and features are added to the product often.  To get the latest listing, please run the following command in command prompt:

For 64bit: "c:\Program Files\Quest\Essentials\Essentials.exe" -help -log help.txt

For 32bit:  "c:\Program Files (x86)\Quest\Essentials\Essentials.exe" -help -log help.txt

This will create a "help.txt" file in your current user directory (ie: C:\Users\ in the folder of the username which you used to run the above script)


Command Line Parameters


prints this help screen

-cmd [command]

runs a command


collect statistics for site or OneDrive


collect credentials for site or OneDrive


connects to site or OneDrive


copies a list


copies a site


copies items/documents


copies workflows


saves  custom actions


generates Inheritance report


generates Inventory report


imports alerts from csv file to target site


imports files from csv file to target site


generates Site Users report


generates Site Templates report


bulk uploads networked file system drives into a OneDrive for Business Document library


generates Full Site Compare Content report


creates 'Permissions given to User/Group' Report


copies files and documents from Google to Sharepoint


exports contents of users google account


copies content of multiple Google Drives to OneDrive for Business


creates backup project in local system (save structure and data)


exports backup project to a zip archive


copies items using CSV file


copies the Documents library content from the OneDrive for Business sites to another OneDrive for Business site.


performs a remove operation


generates Site Content report


tags items using CSV file


performs permissions transfer


creates SharePoint Pre-migration Analysis Report


creates File Share Pre-migration Analysis Report


allows you to use Policy Group with resource


generates 'Users with permissions to Object' report


checks source credentials

-encrypt [password]

prints encrypted password

Common Parameters

-srcsite [url]

source site url

-srclist [name]

source list name

-trgtsite [url]

target site url

-trgtlist [name]

target list name

-log [file]

output file that captures results of all activities


suppresses splash screen


content will be uploaded/copied even if required fields are left empty

-proxy [host:port]

set proxy configuration: user:pass@host:port or host:port

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen