Chat now with support
Chat with Support

Metalogix Essentials for Office 365 2.3 - User Guide

Metalogix Essentials for Office 365 User Guide
Administrator Architect Backup
Interface Overview Common Functions
Connecting to SharePoint and OneDrive for Business Connecting to Cloud Storage Global and SharePoint Administrators Hyper Backup Creating a Full Backup Creating an Update Backup Creating an Exchange Online Mailbox Backup Creating an Office 365 Group Backup Creating a OneDrive for Business Backup Backup Resume Backup Search Restore from Backup Scheduling Backup Jobs Retention Policies Import/Export Backup Archives Moving the Backup Location Backup Project Conversion
Drives
Interface Overview Common Functions
Connecting to Drives Copy Google Drive Copy File Share Copy My Sites to OneDrive for Business Copy Tenant Copy Box Copy Dropbox OneDrive Management Progress Tab Hyper Migration Path Length Overflow
File Manager Informant Migrator
Interface Common Functions
Connect to SharePoint and OneDrive for Business Global and SharePoint Administrators Copy Sites Live Compare Copy Lists and Libraries Copy, Move, and Tag SharePoint Content Copy Alerts Pre-Migration Report Azure Turbo Mode In-Place Tagging of SharePoint Items Incremental Copy Nintex Workflow Migration Orphaned Users Copy Preserving Content Authorship and Approve/Reject Statuses Save Site to XML Using Scripts and Integration With Windows Task Scheduler
Profile and Global Variables Public Folders for SharePoint Reporting and Re-Mapping Users and Templates Security Manager Term Store Manager Scripts Wizards Appendix

Using Scripts and Integration with Windows Task Scheduler

As with many of Metalogix Essentials operations, users may generate a command line script by pressing the Generate Script button (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 executed, 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\.metadata\appLog.

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

1.Press the Generate Script button within any of the Essentials wizards.
Using scripts1

2.The Command Line Script window will open, displaying the script for that wizard action. Press Copy to Clipboard.
using scripts2

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 Generate Script option in the end.  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.
Using scripts1

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

-help

prints this help screen

-cmd [command]

executes a command

collectStatistics

collect statistics for site or OneDrive

credentials

collect credentials for site or OneDrive

connect

connects to site or OneDrive

copylist

copies a list

copysite

copies a site

copyitems

copies items/documents

copyworkflows

copies workflows

customAction

saves  custom actions

inheritanceReport

generates Inheritance report

inventory

generates Inventory report

importAlerts

imports alerts from csv file to target site

importfiles

imports files from csv file to target site

exportSiteUsersReport

generates Site Users report

exportSiteTemplatesReport

generates Site Templates report

fileSharesToOneDrive

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

fullcompare

generates Full Site Compare Content report

given

creates 'Permissions given to User/Group' Report

googleImport

copies files and documents from Google to Sharepoint

googleExport

exports contents of users google account

googleToOneDrive

copies content of multiple Google Drives to OneDrive for Business

newbackup

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

zipBackup

exports backup project to a zip archive

copyItemsUsingCSV

copies items using CSV file

oneDriveToOneDrive

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

remove

performs a remove operation

spContentReport

generates Site Content report

tagItemsUsingCSV

tags items using CSV file

transfer

performs permissions transfer

spPreMigration

creates SharePoint Pre-migration Analysis Report

fsPreMigration

creates File Share Pre-migration Analysis Report

usePolicyGroup

allows you to use Policy Group with resource

userstoobject

generates 'Users with permissions to Object' report

checkcreds

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

-noSplash

suppresses splash screen

-deferRequired

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

Credentials Parameters

The following are parameters for the -cmd Credentials command

-srcuser [user]

source site user name

-srcpass [password]

source site password

-srcepass [password]

source site encrypted password

-srcdomain [domain]

source site domain

-srchost [host]

source site host

-srcport [port]

source site port

-srcuseproxy

use proxy to source site

-trgtuser [name]

target site user name

-trgtpass [password]

target site password

-trgtepass [password]

target site encrypted password

-trgtdomain [domain]

target site domain

-trgthost [host]

target site host

-trgtport [port]

target site port

-trguseproxy

use proxy to target site

Related Documents