DocAve® 6 SDK and Management Shell...6 DocAve 6: SDK and Management Shell Getting Started Refer to the sections below for important information on getting started with SDK and Management

1

DocAve 6: SDK and Management Shell

User Guide

DocAve® 6 SDK and Management Shell

Service Pack 3, Cumulative Update 3

Revision H Issued December 2013

2


Table of Contents

About SDK and Management Shell ............................................................................................................... 5

Configuration ............................................................................................................................................ 5

Agents ....................................................................................................................................................... 5

Getting Started .............................................................................................................................................. 6

Environment Requirement ....................................................................................................................... 6

DocAve 6 SDK ................................................................................................................................................ 6

Supported Features in DocAve SDK .......................................................................................................... 6

Breaking Changes in DocAve SDK ........................................................................................................... 11

Implementing DocAve API for Granular Backup Functions ........................................................................ 12

Logging into DocAve ............................................................................................................................... 12

Invoking the Granular Backup Service .................................................................................................... 12

Creating a New Plan ................................................................................................................................ 13

Getting Plans ........................................................................................................................................... 14

Getting all of the Granular Backup plans ............................................................................................ 14

Getting a Granular Backup Plan with Specified Plan Name ................................................................ 14

Updating an Existing Granular Backup Plan ............................................................................................ 14

Running a Granular Backup Plan ............................................................................................................. 15

Getting Job Information .......................................................................................................................... 15

Downloading Job Report ......................................................................................................................... 15

Completing a Granular Backup Process .................................................................................................. 16

DocAve 6 Management Shell ...................................................................................................................... 19

Installation .............................................................................................................................................. 19

Access DocAve 6 Management Shell ...................................................................................................... 20

Upgrading DocAve SDK and Management Shell ......................................................................................... 21

DocAve Management Shell Cmdlet Reference ........................................................................................... 22

Log Into DocAve Manager ....................................................................................................................... 22

Log Out of DocAve Manager ................................................................................................................... 23

Control Panel........................................................................................................................................... 23

Obtain a Date Object........................................................................................................................... 23

3


Obtain a Time Object .......................................................................................................................... 23

Agent Monitor ..................................................................................................................................... 24

Account Manager ................................................................................................................................ 25

Security Information Manager ............................................................................................................ 29

Physical Device .................................................................................................................................... 32

Logical Device ...................................................................................................................................... 35

Storage Policy ...................................................................................................................................... 37

Update Manager ................................................................................................................................. 39

Administration ........................................................................................................................................ 42

Administrator ...................................................................................................................................... 42

Content Manager ................................................................................................................................ 49

Deployment Manager ......................................................................................................................... 53

Replicator ............................................................................................................................................ 54

Storage Optimization .............................................................................................................................. 56

BLOB Provider ..................................................................................................................................... 56

Archiver ............................................................................................................................................... 59

Real-Time Storage Manager ............................................................................................................... 62

Job Monitor ............................................................................................................................................. 65

Obtain a Specified Module’s Job ......................................................................................................... 65

Obtain a Job’s Detailed Information ................................................................................................... 67

Obtain a Job’s Summary Information ................................................................................................. 67

Download a Job Report ....................................................................................................................... 68

Migration ................................................................................................................................................ 68

General SharePoint Migration Commands ......................................................................................... 68

File System Migration ......................................................................................................................... 70

SharePoint 2007 to 2010 Migration .................................................................................................... 76



Lotus Notes Migration ........................................................................................................................ 92

eRoom Migration ................................................................................................................................ 98

Livelink Migration.............................................................................................................................. 104

Exchange Public Folder Migration .................................................................................................... 111

4


Data Protection ..................................................................................................................................... 117

Granular Backup and Restore ........................................................................................................... 117

Platform Backup and Restore ........................................................................................................... 119

Notices and Copyright Information .......................................................................................................... 121

5


About SDK and Management Shell Refer to the sections below for system and farm requirements that must be in place prior to installing and using DocAve SDK and Management Shell.

Configuration In order to use DocAve SDK and Management Shell, the DocAve 6 SP3 platform must be installed and configured properly on your farm. DocAve SDK and Management Shell will not function without DocAve 6 SP3.

Agents DocAve Agents are responsible for running DocAve jobs and interacting with the SharePoint object model. DocAve Agents enable DocAve Manager to communicate with the respective servers, allowing for DocAve products to function properly. At the minimum, DocAve must have one agent installed on the SharePoint farm. The server that the agent is installed on must have Microsoft SharePoint Foundation Web Application service enabled as well. Otherwise, the Agent of the corresponding DocAve product cannot be loaded during agent installation and, consequently, the DocAve product functions cannot be used. Additional DocAve agents should be installed on other SharePoint Web front ends (WFEs) in order to provide redundancy in the event that a DocAve Agent goes down.

*Note: The use of system resources on a server increases when the installed agent is performing actions. This may affect server performance. However, if the agent installed on a server is not being used, the use of system resources is very low and, therefore, the effect on server performance is negligible.

For instructions on installing DocAve Platform, the DocAve Manager, and DocAve module Agents, see the DocAve 6 Installation Guide.

http://www.avepoint.com/assets/pdf/docave-v6-user-guides/DocAve_6_Installation_Guide.pdf

6


Getting Started Refer to the sections below for important information on getting started with SDK and Management Shell.

Environment Requirement For DocAve 6 SDK, the .NET Framework version must be v3.5 SP1 or later.

For DocAve 6 Management Shell, the .NET Framework version must be 3.5 SP1 or later and the PowerShell version must be v2.0 or later.

DocAve 6 SDK Build your customizable, extendable, and programmable usage of DocAve functions by invoking the program interfaces provided by DocAve 6 SDK.

To access detailed information on the commands available in the DocAve 6 SDK:

On the server with DocAve Manager/Agent installed, navigate to Start > All Programs > AvePoint DocAve 6 > DocAve 6 SDK.

Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\DocAveModule\DocAveSDK.chm.

Supported Features in DocAve SDK DocAve Version Module/Area Supported Features DocAve 6.0 Content Manager Run a plan

Deployment Manager Run a plan Replicator Run a plan Granular Backup and Restore

• Create a new plan • Update the settings of an existing plan • Delete a plan • Get all of the existing plans • Run a plan

Platform Backup and Restore

Run a plan

7


DocAve Version Module/Area Supported Features Archiver • Get all of the existing Archiver rules

• Get the rules that have been applied rules on a SharePoint object

• Reuse an existing rule on a SharePoint object • Apply an existing rule on a SharePoint object • Run an Archiver job

Job Monitor • Get the desired jobs • Get the summary information of a job • Get the detailed information of a job • Download the report of a job

DocAve 6 SP1 Administrator • Clone user/group’s permission • Scan dead account • Delete dead accounts • Search for users or groups with specific permissions

Content manager • Create/update /delete an online mode plan; • Get online mode plans

Deployment manager • Get an existing plan • Update the destination of a design element

mapping of an existing plan • Create a new plan

Archiver • Check and change a SharePoint object’s inheriting status

• Get all of the existing Archiver profiles • Get the profiles that have been applied rules on a

SharePoint object • Apply a profile on a SharePoint object • Retract an already applied profile

Storage Optimization BLOB Provider Settings

• Get the configurations of a stub database • Configure the stub database settings • Get the RBS settings • Configure the RBS settings • Get the EBS settings • Configure the EBS settings

Real-time Storage Manager

• Create a real-time storage manager rule • Update the settings of an existing real-time storage

manager rule • Delete an existing real-time storage manager rule • Get all of the real-time storage manager rule • Reuse a real-time storage manager rule on a

SharePoint object • Get the real-time storage manager rules that have

been applied on a SharePoint object • Retract a real-time storage manager rule

8


DocAve Version Module/Area Supported Features Scheduled Storage Manager

• Get all of the existing storage manager profiles • Reuse a storage manager profile on a SharePoint

site collection • Retract a storage manager profile from a SharePoint

site collection SharePoint 2007 to 2010 migration (online mode)

• Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan

Update Manager • Get all of the available update • Upload an update • Test an update • Install an update

Storage Configuration • Get all of the existing physical devices • Create a physical device of the CIFS Share type • Get all of the existing logical devices

Account Manager • Add a local user • Update the settings of an existing local system user • Delete a local system user • Add an active directory user • Update the settings of an existing active directory

user • Delete an active directory user • Get all of the existing local users • Get all of the active directory users/groups

Vault • Get all of the existing profiles • Get the profiles that have been applied on a

SharePoint object • Apply a profile on a SharePoint object • Check and change a SharePoint object’s inheriting

status DocAve 6 SP2 SharePoint 2007 to 2010

Migration • Download a profile • Upload a profile

SharePoint 2007 to 2013 Migration

• Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan • Download profile • Upload profile

SharePoint 2010 to 2013 Migration

• Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan

9


DocAve Version Module/Area Supported Features • Run a plan • Download profile • Upload profile

File System Migration • Generate the metadata file(s) for the migrated contents

• Get a blank plan • Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan • Update a plan

eRoom Migration • Get a blank plan • Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan

Lotus Notes Migration • Get a blank plan • Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan

DocAve 6 SP3 File System Migration • Upload/download a migration options profile • Upload/download a mapping options profile

Lotus Notes Migration • Upload/download a migration options profile • Upload/download a mapping options profile

eRoom Migration • Upload/download a migration options profile • Upload/download a mapping options profile

Livelink Migration • Get a blank plan • Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan • Upload/download a migration options profile • Upload/download a mapping options profile

Exchange Public Folder Migration

• Get a blank plan • Get all of the existing plans • Create a new plan • Update the settings of an existing plan • Delete a plan • Run a plan

10


DocAve Version Module/Area Supported Features • Upload/download a migration options profile • Upload/download a mapping options profile

Physical Device • Get a blank net share physical device • Get all of the existing net share physical devices • Create a new net share physical device • Update the settings of an existing net share physical

device • Delete a net share physical device

Logical Device • Get a blank logical device • Get all of the existing logical devices • Create a new logical device • Update the settings of an existing logical device • Delete a logical device

Storage Policy • Get a blank storage policy • Get all of the existing storage policies • Create a new storage policy • Update the settings of an existing storage policy • Delete a storage policy

Agent Monitor • Get all of the Agent services • Update the Agent service’s credentials

Update Manager Update Governance Automation Administrator • Check whether or not the SharePoint object is

inheriting permissions from its parent. • Stop the permission inheritance of SharePoint

object DocAve Manager • Log out of DocAve Manager

DocAve 6 SP3 CU1

Administrator Policy Enforcer

• Reuse/retract a Policy Enforcer profile • Get a list of Policy Enforcer profiles • Generate a Policy Enforcer report • Fix the issue in the Policy Enforcer report

Administrator Grant Temporary Permissions

Grant users/groups the temporary permissions to the specified SharePoint objects

SharePoint Sites Management

• Create/update/delete a SharePoint sites group • Get a list of SharePoint sites groups • Add/update/delete a SharePoint site collection in a

SharePoint sites group • Get a list of SharePoint site collections in a

SharePoint sites group SharePoint Online The following products or features support SharePoint

Online: • Content Manager • Granular Backup • Administrator

o Clone User Permission o Security Search

11


*Note: DocAve command lines and APIs support to work on the SharePoint folder level and SharePoint item level in DocAve 6 SP3.

Breaking Changes in DocAve SDK Breaking Changes are changes in the DocAve SDK that make certain operations and features behave or name differently from the DocAve 6.0 to DocAve 6 SP1.

The breaking changes in DocAve SDK from DocAve 6 to DocAve 6 SP1 are:

• One more library file is required (Storage.dll), which resides in the DocAveInstallDir\Shell\DocAveModules\DocAveModule directory.

• The namespace is rearranged in this service pack.

• For some methods of job monitor service, the type of integer parameters is changed from long to int.

• To avoid ambiguity and confusion with the native SharePoint API types, rename type names under AvePoint.DocAve.API.Objects as the table displays.

Original Object Name Change To SPList SharePointList SPObject SharePointObject SPSite SharePointSite SPTree SharePointTree SPWeb SharePointWeb SPWebApplication SharePointWebApplication

• To make it clear, the ContentManagerService is divided into ContentManagerOnlineService and ContentManagerOfflineService two services.

• The type GranularBackupAndRestoreService is renamed to GranularBackupService, and the property name of DataProtectionService is changed accordingly.

• The type PlatformBackupAndRestoreService is renamed to PlatformBackupService, and the property name of DataProtectionService is changed accordingly.

The breaking changes in DocAve SDK from DocAve 6 SP2 to DocAve 6 SP3 are:

• Remove the Groups property from the DocAve.API.ControlPanel.AccountManger.UserBase class. Add the SystemGroups property and the TenantGroup property to the DocAve.API.ControlPanel.AccountManger.UserBase class.

12


Implementing DocAve API for Granular Backup Functions Refer to the following examples to implement Granular Backup functions through the DocAve 6 API.

The examples provided below are based on the information listed in DocAve SDK Documentation, which can be found in DocAveSDK.chm.

DocAve API libraries are installed during the DocAve Manager and/or Agent installation. You can find them in the [DocAveInstallDir]\Shell\DocAveModules\DocAveModule directory. You must add the DocAve API libraries in your project references. The required library files are:

• DocAveAPI.dll

• CommonContract.dll

• CommonMicroKernel.dll

• CommonUtility.dll

• log4net.dll

• Storage.dll

Logging into DocAve To log into DocAve, refer to the following example:

string docaveHost = "10.2.92.13";

int docavePort = 14000;

string docaveUsername = "admin";

SecureString docavePassword = new SecureString();

foreach (char c in "admin") docavePassword.AppendChar(c);

DocAve.API.DocAve docave = new DocAve.API.DocAve(docaveHost, docavePort);

docave.Login(docaveUsername, docavePassword);

Invoking the Granular Backup Service To invoke the Granular Backup service, refer to the following example:

GranularBackupService granularBackupService = docave.DataProtectionService.GranularBackupService;

13


Creating a New Plan DocAve API does not support configuring Notification and Schedule for Granular Backup plan.

To create a new plan, refer to the following example:

1. Get a blank plan, and then configure the plan settings.

GranularBackupPlan granularBackupPlan = granularBackupService.GetBlankPlan();

granularBackupPlan.Name = "Plan1";

granularBackupPlan.Description = "The plan is for demo";

granularBackupPlan.StoragePolicyName = "Storage Policy 1";

granularBackupPlan.RestoreLevel = GranularBackupRestoreLevel.ItemLevel;

granularBackupPlan.IncludeUserProfile = true;

granularBackupPlan.IncludeWorkflowDefinition = true;

granularBackupPlan.IncludeWorkflowInstance = true;

granularBackupPlan.EnableDataCompression(GranularBackupCompressionType.Level5, GranularBackupCompressionMethod.MediaService);

granularBackupPlan.EnableDataEncryption(GranularBackupDataEncryptionType.MediaService, "Default Security Profile");

granularBackupPlan.AgentGroupName = "DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)";

2. Define a SharePoint object.

SharePointSite site1 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", "http://SharePoint2010:10001/sites/GranularBackup");

3. Add the object to the tree.

granularBackupPlan.Tree.IncludeSPObject(site1);

4. Use the CreatePlan Method to create a plan.

granularBackupService.CreatePlan(granularBackupPlan);

14


Getting Plans Refer to the following examples for information on getting all of the granular backup plans, or getting a granular backup plan with the specified name.

Getting all of the Granular Backup plans To get all of the granular backup plans, refer to the following example:

List<GranularBackupPlan> allPlans = granularBackupService.GetPlans();

Getting a Granular Backup Plan with Specified Plan Name To get the granular backup plan with the specified plan name, refer to the following example:

GranularBackupPlan plan = granularBackupService.GetPlan("Plan1");

Updating an Existing Granular Backup Plan To update an existing granular backup plan, refer to the following steps:

1. Configure plan settings.

plan.Name = "Plan2";

plan.Description = "new description";

plan.StoragePolicyName = "new Storage Policy";

plan.RestoreLevel = GranularBackupRestoreLevel.SiteLevel;

plan.IncludeUserProfile = false;

plan.IncludeWorkflowDefinition = false;

plan.IncludeWorkflowInstance = false;

plan.EnableDataCompression(GranularBackupCompressionType.Level1, GranularBackupCompressionMethod.SharePointAgent);

plan.EnableDataEncryption(GranularBackupDataEncryptionType.SharePointAgent, "new Security Profile");

plan.AgentGroupName = "new Agent Group";

15


2. Define a SharePoint object.

SharePointSite site2 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", "http://SharePoint2010:10001/sites/new GranularBackup");

3. Add the new object to the tree.


4. Use the UpdatePlan Method to update the plan.

granularBackupService.UpdatePlan(plan);

Running a Granular Backup Plan To run a Granular Backup job, refer to the following example:

string jobID = granularBackupService.RunJob("Plan2", RunGranularBackupPlanType.Full, true);

Getting Job Information To get the job information of a desired job, refer to the following example:

Job job = null;

do

{

job = docave.JobMonitorService.GetJob(jobID);

Console.WriteLine("Status: " + job.Status);

Console.WriteLine("Progress: " + job.Progress);

}

while (job.Status == JobStatus.InProgress || job.Status == JobStatus.Pausing);

Downloading Job Report To download the job report to a local location, refer to the following example:

docave.JobMonitorService.DownloadJobReport(jobID, JobReportFormat.CSV, @"D:\JobReport.zip", false);

16


Completing a Granular Backup Process Refer to the following examples to implement DocAve API to complete a Granular Backup Process.

using System;

using System.Collections.Generic;

using System.Security;

using DocAve.API.DataProtection.GranularBackupAndRestore;

using DocAve.API.JobMonitor;

using DocAve.API.Objects;

namespace DocAve63SDKExample

{

class Program

{

static void Main(string[] args)

{

string docaveHost = "10.2.92.13";

int docavePort = 14000;

string docaveUsername = "admin";

SecureString docavePassword = new SecureString();

foreach (char c in "admin") docavePassword.AppendChar(c);

DocAve.API.DocAve docave = new DocAve.API.DocAve(docaveHost, docavePort);

docave.Login(docaveUsername, docavePassword);

GranularBackupService granularBackupService = docave.DataProtectionService.GranularBackupService;

#region

GranularBackupPlan granularBackupPlan = granularBackupService.GetBlankPlan();

granularBackupPlan.Name = "Plan1";

17


granularBackupPlan.Description = "The plan is for demo";

granularBackupPlan.StoragePolicyName = "Storage Policy 1";

granularBackupPlan.RestoreLevel = GranularBackupRestoreLevel.ItemLevel;

granularBackupPlan.IncludeUserProfile = true;

granularBackupPlan.IncludeWorkflowDefinition = true;

granularBackupPlan.IncludeWorkflowInstance = true;

granularBackupPlan.EnableDataCompression(GranularBackupCompressionType.Level5, GranularBackupCompressionMethod.MediaService);

granularBackupPlan.EnableDataEncryption(GranularBackupDataEncryptionType.MediaService, "Default Security Profile");

granularBackupPlan.AgentGroupName = "DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)";

SharePointSite site1 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", "http://SharePoint2010:10001/sites/GranularBackup");


granularBackupService.CreatePlan(granularBackupPlan);

#endregion

#region

List<GranularBackupPlan> allPlans = granularBackupService.GetPlans();

GranularBackupPlan plan = granularBackupService.GetPlan("Plan1");

#endregion

#region

plan.Name = "Plan2";

plan.Description = "new description";

plan.StoragePolicyName = "new Storage Policy";

plan.RestoreLevel = GranularBackupRestoreLevel.SiteLevel;

plan.IncludeUserProfile = false;

18


plan.IncludeWorkflowDefinition = false;

plan.IncludeWorkflowInstance = false;

plan.EnableDataCompression(GranularBackupCompressionType.Level1, GranularBackupCompressionMethod.SharePointAgent);

plan.EnableDataEncryption(GranularBackupDataEncryptionType.SharePointAgent, "new Security Profile");

plan.AgentGroupName = "new Agent Group";

SharePointSite site2 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", "http://SharePoint2010:10001/sites/new GranularBackup");


granularBackupService.UpdatePlan(plan);

#endregion

#region

string jobID = granularBackupService.RunJob("Plan2", RunGranularBackupPlanType.Full, true);

Job job = null;

do

{

job = docave.JobMonitorService.GetJob(jobID);

Console.WriteLine("Status: " + job.Status);

Console.WriteLine("Progress: " + job.Progress);

}

while (job.Status == JobStatus.InProgress || job.Status == JobStatus.Pausing);

docave.JobMonitorService.DownloadJobReport(jobID, JobReportFormat.CSV, @"D:\JobReport.zip", false);

#endregion

}

}

19


DocAve 6 Management Shell DocAve 6 provides a command line management interface based on Windows PowerShell. You can perform the DocAve operations using the provided cmdlet.

Installation By default, DocAve 6 Management Shell is installed together with DocAve Manager/Agent. You can find it in Start > All Programs > AvePoint DocAve 6 > DocAve 6 Management Shell.

You can also install DocAve 6 Management Shell on the server that does not have DocAve Manager/Agent installed. To install DocAve 6 Management Shell separately, see the following steps.

1. In the DocAve installation path (…\ AvePoint\DocAve6), copy the folder named Shell to the server where you want to install DocAve Management Shell.

2. Right-click ShellInstallation.exe under …\Shell\Setup and select Run as administrator.

3. Specify a local installation path or press Enter to use the default location, which is C:\Program File\AvePoint.

Figure 1: Specify the installation location.

4. Press any key to exit when the installation completes.

Figure 2: Exit the tool.

20


Access DocAve 6 Management Shell After installing DocAve 6 Management Shell, refer to the following two methods to access it.

• Go to Start > All Programs > AvePoint DocAve 6 >DocAve6 Management Shell and click DocAve 6 Management Shell to open the interface.

• Use Windows PowerShell. Click the Windows PowerShell icon on the left of Windows taskbar to open it. Then, import the DocAve 6 PowerShell module by executing the command: Import-Module -Name DocAveModule -DisableNameChecking

*Note: Before using any DocAve cmdlet, you must log into DocAve using Login-DAManager cmdlet first. You can get the detailed information on using this cmdlet entering Get-Help Login-DAManager.

To get the overview of all of the commands available for DocAve 6, execute the command:

Get-Command -Module DocAveModule

To search all of the commands related to a module, use a “fuzzy” query. For example, execute the following command to retrieve all of the commands about the Granular Backup modules:

Get-Command -Name *GranularBackup*

21


Upgrading DocAve SDK and Management Shell The DocAve SDK and Management Shell must be upgraded together with the DocAve platform. The upgraded DocAve SDK and Management Shell support more functions and contain optimizations and improvements.

For detailed steps regarding how to upgrade the DocAve 6 SDK, refer to DocAve SDK Documentation, which is available in the following path by default: …\AvePoint\DocAve6\Shell\DocAveModules\DocAveModule\DocAveSDK.chm

For detailed steps regarding how to upgrade the DocAve 6 Management Shell, refer to the conceptual topic Get-Help about_DAUpdate cmdlet in the DocAve 6 Management Shell:

1. Open the DocAve 6 Management Shell.

2. Enter Get-Help about_DAUpdate, and then press Enter.

Figure 3: Get-Help about_DAUpdate in DocAve 6 Management Shell.

22


DocAve Management Shell Cmdlet Reference DocAve Management Shell provides a rich set of commands based on the DocAve platform. These commands allow you to perform various operations including run a plan, delete a plan, delete dead account etc. The section below lists all of the DocAve Management Shell cmdlets, a corresponding example of each cmdlet, as well as the descriptions of the parameters in each cmdlet.

*Note: DocAve 6 SP3 SDK provides a Connector API welcome page and a Policy Enforcer page to allow users to get the functional summary of Connector API and Policy Enforcer (a feature supported in Administrator) API, and provides the directory of the Connector SDK and Policy Enforcer SDK in DocAve Agent server.

Log Into DocAve Manager *Note: The Login-DAManager cmdlet only supports the local user to log in to DocAve.

To log into DocAve manager, run the following command:

Login-DAManager -ControlHost <String> -ControlPort <Int32> -Credential <PSCredential> [<CommonParameters>]

The examples of the command are:

C:\PS>$Credential = Get-Credential C:\PS>Login-DAManager -ControlHost localhost -ControlPort 14000 -Credential $credential

Or C:\PS>$SecurePassword = Read-Host -AsSecureString C:\PS>Login-DAManager -ControlHost localhost -ControlPort 14000 -Username admin -Password $SecurePassword

Or C:\PS>Login-DAManager -ControlHost localhost -ControlPort 14000 -Username admin -PlainTextPassWord admin

To configure the command parameters, refer to the following table:

Parameter Type Comment -ControlHost Required Specifies the address of control host. -ControlPort Required Specifies the control port. -Credential Required Specifies the credential. -Username Required Specifies the username. -Password Required Specifies the password in the form of secure string. -PlainTextPassword Required Specifies the password in the form of plain text string.

23


Log Out of DocAve Manager To log out DocAve Manager, run the command below:

Logout-DAManager [<CommonParameters>]

An example of the command is:

C:\PS>Logout-DAManager

Control Panel Refer to the section below for more information on the cmdlets’ usage in Control Panel.

Obtain a Date Object To obtain a date object used for defining a specific date in a scheduled plan, run the command below:

Get-DADate [-Year] <Int32> [-Month] <Int32> [-Day] <Int32> [-TimeZoneId] <SupportedTimeZoneId> [<CommonParameters>]


C:\PS>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime C:\PS>Get-DADate -Year 2012 -Month 03 -Day 20 –TimeZoneId $TimeZoneId


Parameter Type Comment -Year Required Specifies the year that is displayed. Valid value is between 1 and

9999. -Month Required Specifies the month that is displayed. Valid value is between 1 and

12. -Day Required Specifies the day that is displayed. Valid value is between 1 and 31. -TimeZoneId Required Specifies the time zone ID.

Obtain a Time Object To get a time object used for defining a specific time in a scheduled plan, run the command below:

Get-DADateTime [-Year] <Int32> [-Month] <Int32> [-Day] <Int32> [-Hour] <Int32> [-Minute] <Int32> [-TimeZoneId] <SupportedTimeZoneId> [<CommonParameters>]


C:\PS>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime C:\PS>Get-DADateTime -Year 2012 -Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID

24



Parameter Type Comment -Year Required Specifies the year that is displayed. Valid value is between 1 and

9999. -Month Required Specifies the month that is displayed. Valid value is between 1

and 12. -Day Required Specifies the day that is displayed. Valid value is between 1 and

31. -Hour Required Specifies the hour that is displayed. Valid value is between 0 and

23. -Minute Required Specifies the minute that is displayed. Valid value is between 0

and 59. -TimeZoneId Required Specifies the time zone ID.

Agent Monitor Refer to the section below for more information on getting and updating DocAve Agent service.

Get DocAve Agent Service

To get the Agent service of DocAve, run the command below:

Get-DAAgentService [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAAgentService


Parameter Type Comment -Name Optional Specifies the names of the existing Agent services you want to get.

Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, all of the existing Agent services will be obtained.

Update DocAve Agent Service

To update the Agent service of DocAve, run the command below:

Update-DAAgentService [-AgentService] <AgentService> [<CommonParameters>]


C:\PS>$agent = Get-DAAgentService -Name 'agent1' C:\PS>$pwd = Read-Host –AsSecureString *****

25


C:\PS>$agent.SetAccount('mydomain\user1', $pwd) C:\PS>Update-DAAgentService -AgentService $agent


Parameter Type Comment -AgentService Required Specifies an Agent service for updating.

Account Manager Refer to the section below for more information on the cmdlets’ usage in Account Manager.

Get the Information of an Active Directory Group

To get the information of a specified active directory group, run the command below:

Get-DAActiveDirectoryGroup [[-Name] <String[]>] [<CommonParameters>]


C:\PS>$user = Get-DAActiveDirectoryGroup


Parameter Type Comment -Name Optional Specifies the name(s) of the active directory group(s) you want to

obtain. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all existing active directory groups will be obtained.

Get the Information of an Active Directory

To get the information of an active directory user, run the command below:

Get-DAActiveDirectoryUser [[-Name] <String[]>] [<CommonParameters>]


C:\PS>$user = Get-DAActiveDirectoryUser


Parameter Type Comment -Name Optional Specifies the name(s) of the active directory user(s) you want to

obtain. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all existing active directory users will be obtained.

26


Get the Information of a Local User

To get the information of a local user, run the command below:

Get-DALocalUser [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DALocalUser -Name user1


Parameter Type Comment -Name Optional Specifies the name(s) of the local user(s) you want to obtain.

Wildcards and multiple values are supported, which should be separated by commas. If no values are entered, all existing local users will be obtained.

Get the Blank Active Directory Group

To get the blank active directory group, run the command below:

Get-DABlankActiveDirectoryGroup [<CommonParameters>]


C:\PS>$user = Get-DABlankActiveDirectoryGroup

Get a Blank Active Directory User

To get the blank active directory user, run the command below:

Get-DABlankActiveDirectoryUser [<CommonParameters>]


C:\PS>Get-DABlankActiveDirectoryUser

Get a Blank Local User

To get a blank local user, run the command below:

Get-DABlankLocalUser [<CommonParameters>]


C:\PS>Get-DABlankLocalUser

27


Create a New User

To create a new user, run the command below:

New-DAUser [-User] <UserBase> [<CommonParameters>]


C:\PS>$user = Get-DABlankLocalUser C:\PS>$user.Name = 'user1' C:\PS>$user.Email = '[email protected]' C:\PS>$user.Password = Read-Host -AsSecureString ******** C:\PS>$user.Description = 'This is a Local User' C:\PS> C:\PS>$groups = New-Object System.Collections.Generic.List[string] C:\PS>$groups.Add('system group 01') C:\PS>$user.SetSystemGroups($groups) C:\PS> C:\PS>$user.SetSecuritySettingsType('Customized') C:\PS>$user.SecuritySettings.AccountIsInactive = $false C:\PS>$user.SecuritySettings.UserMustChangePasswordAtNextLogon = $true C:\PS>New-DAUser –User $user

Or C:\PS>$user = Get-DABlankActiveDirectoryUser C:\PS>$user.Name = 'example.com\user1 C:\PS>$user.SetTenantGroup('tenant group 01') C:\PS>New-DAUser –User $user


Parameter Type Comment -User Required Specifies a user object to create a new user. For more information about

the structure and attributes of user, refer to the DocAve SDK Documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\DocAveModule\DocAveSDK.chm

28


Delete an Active Directory Group

To delete an active directory group, run the command below:

Remove-DAActiveDirectoryGroup [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAActiveDirectoryGroup -Name 'example.com\group1'


Parameter Type Comment -Name Required Specifies the name of an active directory group that you want

to delete. -WhatIf Optional Describes what would happen if you executed the command

without actually executing the command. -Confirm Optional Prompts you for confirmation before executing the

command.

Delete an Active Directory User

To delete an active directory user, run the command below:

Remove-DAActiveDirectoryUser [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAActiveDirectoryUser -Name 'example.com\user1'


Parameter Type Comment -Name Required Specifies the name of an active directory user that you want

to delete. -WhatIf Optional Describes what would happen if you executed the command. -Confirm Optional Prompts you for confirmation before executing the

command.

Delete a Local User

To delete a local user, run the command below:

Remove-DALocalUser [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DALocalUser -Name 'user1'

29



Parameter Type Comment -Name Required Specifies the name of a local user that you want to delete. -WhatIf Optional Describes what would happen if you executed the command. -Confirm Optional Prompts you for confirmation before executing the

command.

Update the Information of a User in Account Manager

To update the information of an existing user, run the command below:

Update-DAUser [-User] <UserBase> [<CommonParameters>]


C:\PS>$user = Get-DALocalUser -Name 'user1' C:\PS>$user.Email = '[email protected]' C:\PS>Update-DAUser $user


Parameter Type Comment -User Required Specifies a user object where you want to edit the user.

Security Information Manager Refer to the section below for more information on the cmdlets’ usage in Security Profile Manager.

Back Up a Database Encryption Key

To back up a database encryption key, run the command below:

Backup-DADatabaseEncryptionKey [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Backup-DADatabaseEncryptionKey -Path 'C:\backup.zip'


Parameter Type Comment -Path Required Specifies a path to store the backup file. -Overwrite Optional Overwrites the backup file if it already exists in the specified

path.

30


Back Up the Data Encryption Profile

To back up the data encryption profile, run the command below:

Backup-DADataEncryptionProfile [-Path] <String> [-Overwrite] [<CommonParameters>]

*Note: Data encryption profile is renamed to security profile since DocAve 6 SP1.


C:\PS>Backup-DADataEncryptionProfile -Path 'C:\backup.zip'


Parameter Type Comment -Path Required Specifies a path to store the backup file. -Overwrite Optional Overwrites the backup file if it already exists in the specified path.

Restore a Database Encryption Key

To restore a database encryption key, run the command below:

Restore-DADatabaseEncryptionKey [-Path] <String> [-OutPut] <String> [-Overwrite] [[-Passphrase] <String>] [<CommonParameters>]


C:\PS>Restore-DADatabaseEncryptionKey -Path 'C:\backupfile' -OutPut 'C:\sql' C:\PS>Restore-DADatabaseEncryptionKey -Path 'C:\backupfile' -OutPut 'C:\sql' -Passphrase passphrase


Parameter Type Comment -Path Required Specifies a path to load the backup file. -OutPut Required Specifies a path to store the output file. -Overwrite Optional Overwrites the output file if it already exists in the specified path. -Passphrase Optional Specifies a passphrase value to encrypt DocAve database encryption

key. If this parameter is not used, the cmdlet will read the passphrase from the local machine. Ensure that the passphrases are matched between the local machine and the DocAve database; otherwise, the DocAve system will not work.

Restore a Data Encryption Profile

To restore a data encryption profile, run the command below:

Restore-DADataEncryptionProfile [-Path] <String> [<CommonParameters>]*Note: Data encryption profile is renamed to security profile since DocAve 6 SP1.

31


The example of the command:

C:\PS>Backup-DADataEncryptionProfile -Path 'C:\backup.zip'


Parameter Type Comment -Path Required Specifies a path to load the backup file.

Set Up the Status of a FipsAlgorithmPolicy

To set up the status of a specified FipsAlogrithmPolicy, run the command below:

Set-DAFipsAlgorithmPolicy [[-Disabled]] [<CommonParameters>]

Set-DAFipsAlgorithmPolicy [[-Enabled]] [<CommonParameters>]


C:\PS>Set-DAFipsAlgorithmPolicy -Enabled C:\PS>Set-DAFipsAlgorithmPolicy -Disabled


Parameter Type Comment -Disabled Optional Disables the FipsAlogrithmPolicy. -Enabled Optional Enables the FipsAlogrithmPolicy.

Set Up the Passphrase

To set up a new value for the passphrase, run the command below:

Set-DAPassPhrase [-PassPhrase] <SecureString> [-ConfirmPassPhrase] <SecureString> [<CommonParameters>]

Set-DAPassPhrase [-PassPhrase] <SecureString> [-LocalServerOnly] [<CommonParameters>]


C:\PS>$passphrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText -Force C:\PS>$ConfirmPassPhrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText -Force C:\PS>Set-DAPassPhrase -PassPhrase $passphrase -ConfirmPassPhrase $ConfirmPassPhrase

Or C:\PS>$passphrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText -Force C:\PS>Set-DAPassPhrase -PassPhrase $passphrase -LocalServerOnly

32



Parameter Type Comment -PassPhrase Required Specifies a new passphrase value. -ConfirmPassPhrase Required Confirms the new passphrase value. -LocalServerOnly Optional This parameter will only change the passphrase of this

local server. If this parameter is not used, the passphrase change will be performed on all the servers in the DocAve system.

Physical Device Refer to the section below for more information on the cmdlets’ usage for physical device.

Get a Blank Physical Device for Creating a New Physical Device

To get a blank physical device for creating a new physical device, run the following command:

Get-DABlankPhysicalDevice [-Type] <String> [<CommonParameters>]


C:\PS>Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare


Parameter Type Comment -Type Required Specifies a storage type for the physical device. Valid

values are "DataONTAPCIFSShare" and "NetShare".

Create a New Physical Device

To create a new physical device, run the following command:

New-DAPhysicalDevice [-PhysicalDevice] <PhysicalDeviceBase> [<CommonParameters>]


C:\PS>$device = Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare C:\PS>$device.Name = 'physical device1' C:\PS>$device.StorageSystemProfile = 'storage system profile1' C:\PS>$device.ShareName = 'sharename1' C:\PS>$device.Username = 'example.com\user1' C:\PS>$device.Password = Read-Host –AsSecureString ********* C:\PS>$device.SpaceThreshold = '1300MB' C:\PS>$device.ExtendedParameters = 'SnapLockEnabled = True' C:\PS>$device.Farms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

33


C:\PS>New-DAPhysicalDevice -PhysicalDevice $device C:\PS>

Or C:\PS>$device = Get-DABlankPhysicalDevice -Type NetShare C:\PS>$device.Name = 'physical device1' C:\PS>$device.Description = 'Description' C:\PS>$device.SpaceThreshold = '1024MB' C:\PS>$device.ExtendedParameters.Add("AuthMethod=NetUse") C:\PS>$device.ExtendedParameters.Add("IsRetry=true") C:\PS>$device.UNCPath = '\\admin-PC\c$\data' C:\PS>$device.Username = 'example.com\user1' C:\PS>$device.Password = Read-Host –AsSecureString ********* C:\PS>New-DAPhysicalDevice -PhysicalDevice $device C:\PS>


Parameter Type Comment -PhysicalDevice

Required Specifies a physical device object. For information about the structure and attributes of the physical device, refer to the DocAve SDK Documentation file at the following path: \AvePoint\DocAve6\Shell\DocAveModules\DocAveModule\DocAveSDK.chm

Get the Configuration Details of a Physical Device

To get the configuration details of a physical device, run the command below:

Get-DAPhysicalDevice [[-Name] <String[]>] [<CommonParameters>]

Get-DAPhysicalDevice [-Type] <StorageType> [<CommonParameters>]


C:\PS>Get-DAPhysicalDevice -Name 'physical device1'


Parameter Type Comment -Name Optional Specifies one or more physical device names. Multiple

physical device names must be separated by commas. Wildcards are supported. If you do not type a value, the information of all physical devices will be returned.

34


Parameter Type Comment -Type Required Specifies the physical device type. Valid values are

"NetShare", "FTP", "TSM", "EMCCentera", "CloudStorage", "DELLDXStorage", "CaringoStorage", and "HDSHitachiContentPlatform"

Update a Physical Device

To update an existing physical device, run the following command line:

Update-DAPhysicalDevice [-PhysicalDevice] <PhysicalDeviceBase> [<CommonParameters>]


C:\PS>$device = Get-DAPhysicalDevice -Name 'physical device1' C:\PS>$device.Name = 'physical device2' C:\PS>$device.Description = 'Description' C:\PS>Update-DAPhysicalDevice -PhysicalDevice $device C:\PS>


Parameter Type Comment -PhysicalDevice Required Specifies an existing physical device object to be updated.

Delete a Physical Device

To delete an existing physical device, run the following command line:

Remove-DAPhysicalDevice [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAPhysicalDevice -Name 'physical device1'


Parameter Type Comment -Name Required Specifies the name of an existing physical device that you

want to delete. -WhatIf Optional Describes what would happen if you executed the

command without actually executing the command. -Confirm Optional Prompts you for confirmation before executing the

command.

35


Logical Device Refer to the section below for more information on the cmdlets’ usage for logical device.

Get a Blank Logical Device for Creating a New Logical Device

To get a blank logical device for creating a new logical device, run the following command line:

Get-DABlankLogicalDevice [<CommonParameters>]


C:\PS>Get-DALogicalDevice

Create a New Logical Device

To create a new logical device, run the following command line:

New-DALogicalDevice [-LogicalDevice] <LogicalDevice> [<CommonParameters>]


C:\PS>$device = Get-DABlankLogicalDevice C:\PS>$device.name = 'Logical Device' C:\PS>$device.Description = 'Description' C:\PS>$device.StorageType = 'NetShare' C:\PS>$entity1 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 1') C:\PS>$entity2 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 2') C:\PS>$entity3 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 3') C:\PS>$entity1.StorageData = $true C:\PS>$entity1.StorageIndex = $false C:\PS>$entity2.StorageData = $false C:\PS>$entity2.StorageIndex =$true C:\PS>$entity3.StorageData =$true C:\PS>$entity3.StorageIndex =$true C:\PS>$device.AddPhysicalDevice($entity1) C:\PS>$device.AddPhysicalDevice($entity2) C:\PS>$device.AddPhysicalDevice($entity3) C:\PS>New-DALogicalDevice -LogicalDevice $device C:\PS

36



Parameter Type Comment -LogicalDevice Required Specifies a logical device object. About the

structure and attribute of Logical Device, please refer to the DocAve SDK documentation available at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

Get the Configuration Details of a Logical Device

To get the configuration details of a logical device, run the following command:

Get-DALogicalDevice [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DALogicalDevice -Name 'logical device1'


Parameter Type Comment -Name Optional Specifies one or more logical device names. Multiple

logical device names must be separated by commas. Wildcards are supported. If you do not specify any value for the parameter, the information of all the logical devices will be returned.

Update a Logical Device

To update an existing logical device, run the following command:

Update-DALogicalDevice [-LogicalDevice] <LogicalDevice> [<CommonParameters>]


C:\PS>$device = Get-DALogicalDevice -Name 'logical device1' C:\PS>$device | fl

C:\PS>$device.RemovePhysicalDevice('physical device1') C:\PS>$entity = New-Object

37


Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 2') C:\PS>$entity.StorageIndex =$true C:\PS>$entity.StorageData =$true C:\PS>$device.AddPhysicalDevice($entity) C:\PS>$device.PhysicalDeviceList | fl

C:\PS>Update-DALogicalDevice -LogicalDevice $device C:\PS>


Parameter Type Comment -LogicalDevice Required Specifies a logical device object to be updated.

Delete a Logical Device

To delete an existing logical device, run the following command:

Remove-DALogicalDevice [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DALogicalDevice -Name 'physical device1'


Parameter Type Comment -Name Required Specifies the name of the logical device that you want to

delete. -WhatIf Optional Describes what would happen if you executed the


command.

Storage Policy Refer to the section below for more information on the cmdlets’ usage for storage policy.

Get a Blank Storage Policy for Creating a New Storage Policy

To get a blank storage policy for creating a new storage policy, run the following command:

Get-DABlankStoragePolicy [<CommonParameters>]


C:\PS>Get-DABlankStoragePolicy

38


Create a New Storage Policy

To create a new storage policy, run the following command:

New-DAStoragePolicy [-StoragePolicy] <StoragePolicy> [<CommonParameters>]


C:\PS>$policy = Get-DABlankStoragePolicy C:\PS>$policy.Name = 'storage policy 01' C:\PS>$policy.Description = 'This is a new storage policy' C:\PS>$policy.PrimaryStorage = 'logical device 01' C:\PS>$policy.MediaServiceUseStrategy = 'CustomPriority' C:\PS>$policy.MediaServiceNames.Add('service1') C:\PS>$policy.MediaServiceNames.Add('service2') C:\PS>New-DAStoragePolicy -StoragePolicy $policy C:\PS>


Parameter Type Comment -StoragePolicy Required Specifies a storage policy object. For more information about the structure

and attribute of storage policy, refer to the DocAve SDK documentation at the following path: \AvePoint\DocAve6\Shell\DocAveModules\DocAveModule\DocAveSDK.chm

Get the Configuration Details of a Storage Policy

To get the configuration details of a storage policy, run the following command:

Get-DAStoragePolicy [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAStoragePolicy -Name 'storage policy'


Parameter Type Comment -Name Optional Specifies one or more storage policy names. Multiple

storage policy names must be separated by commas. Wildcards are supported. If you do not type any value for the parameter, the information of all the storage policies will be returned.

39


Update a Storage Policy

To update an existing storage policy, run the following command:

Update-DAStoragePolicy [-StoragePolicy] <StoragePolicy> [<CommonParameters>]


C:\PS>$policy = Get-DAStoragePolicy -Name 'storage policy 1' C:\PS>$policy.Name = 'storage policy 2' C:\PS>$policy.Description = 'updates the storage policy' C:\PS>$policy. MediaServiceUseStrategy ='DefaultPriority' C:\PS>Update-DAStoragePolicy -StoragePolicy $policy C:\PS>


Parameter Type Comment -StoragePolicy Required Specifies an existing storage policy for editing.

Delete a Storage Policy

To delete an existing storage policy according to the storage policy's name, run the following command:

Remove-DAStoragePolicy [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAStoragePolicy -Name 'storage policy'


Parameter Type Comment -Name Required Specifies the name of a storage policy that you want to

delete. -WhatIf Optional Describes what would happen if you executed the


command.

Update Manager Refer to the section below for more information on the cmdlets’ usage in Update Manager.

Upload an Update in Update Manager

To upload a specified update, run the following command:

Upload-DAUpdate [-Path] <String> [-Overwrite] [<CommonParameters>]

40



C:\PS>Upload-DAUpdate -Path 'C:\Hotfix_6.0.0.51008601.zip' -Overwrite


Parameter Type Comment -Path Required Specifies the path of the update file. -Overwrite Optional Allows the cmdlet to overwrite an existing update.

Get an Update

To get all available updates for DocAve Manager, run the following command:

Get-DAUpdate [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAUpdate -Name 'HotFix_6.0.0.51008601'


Parameter Type Comment -Name Optional Specifies one or more updates' names. You can type

multiple update names (separated by commas). Wildcards are supported.

Obtain Update Configuration Information

To obtain general configuration information of an update, run the following command:

Get-DAUpdateConfiguration [-UpdateName] <String[]> [<CommonParameters>]


C:\PS>Get-DAUpdateConfiguration -UpdateName Hotfix_6.0.0.51008601


Parameter Type Comment -UpdateName Required Specifies one or more updates' names. You can type

multiple update names (separated by commas).

Test an Update

To test whether a specified update is valid before updating, run the following command:

Test-DAUpdate [-Configuration] <UpdateConfiguration> [<CommonParameters>]

41



C:\PS>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_6.0.0.51008601' C:\PS>$config.UpdateManager = $true C:\PS>$config.ViewServiceForUpdate() Category: 127.0.0.1 WillUpdate: True Name: Control Service Status: ACTIVE Version: 6.0.0.51008601 Type: Control Message: Ready for installing. C:\PS>$config.UpdateNonFarmRelatedAgent = $true C:\PS>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$config.UpdateSQLAgents.Add('SQL Agent') C:\PS>Test-DAUpdate -Configuration $config True


Parameter Type Comment -Configuration Required Specifies an update configuration object.

Install an Update

To install an update, run the following command:

Install-DAUpdate [-Configuration] <UpdateConfiguration> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_6.0.0.51008601' C:\PS>$config.UpdateManager = $true C:\PS>$config.ViewServiceForUpdate() Category : 127.0.0.1 WillUpdate : True Name : Control Service Status : Up Version : 6.0.0.51008601 Type : Control Message : Ready for installing. ...... C:\PS>$config.UpdateNonFarmRelatedAgent = $true C:\PS>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)') C:\PS>$config.UpdateSQLAgents.Add('SQL Agent') C:\PS>$config.RestartIIS = $true

42


C:\PS>$config.UpdateGovernanceAutomations.Add("Governance Automation Host"); C:\PS>Install-DAUpdate -Configuration $config


Parameter Type Comment -Configuration Required Specifies an update configuration object. -WhatIf Optional Describes what would happen if user executes the

command without actually executing the command. -Confirm Optional Prompts user for confirmation before executing the

command.

Administration Refer to the section below for more information on the cmdlets’ usage in Administration.

Administrator Refer to the section below for more information on the cmdlets’ usage in Administrator.

Clone the SharePoint Group Permission

To clone the SharePoint Group Permission, run the following command:

Clone-DASPGroupPermission [-Scope] <SharePointObject> [-SourceGroup] <String> [-Destination] <String> [-Setting] <CloneGroupPermissionSetting> [<CommonParameters>]

Clone-DASPGroupPermission [-FarmName] <String> [-SourceGroup] <String> [-Destination] <String> [-Setting] <CloneGroupPermissionSetting> [<CommonParameters>]


C:\PS>$setting = Get-DASPBlankCloneGroupPermissionSetting

C:\PS>$setting.PermissionOption = 'Append'

C:\PS>$setting.IncludeDetailedReport = $true

C:\PS>

C:\PS>$webapplication1= New-Object DocAve.API.Objects.SharePointWebApplication ('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2010:10001/')

C:\PS>Clone-DASPGroupPermission -Scope $webapplication1 -SourceGroup 'group1' -Destination 'user1' -Setting $setting

43



Parameter Type Comment -Scope Required Specifies the node(s) as a scope where you wish to search for the

source group. You can specify the node(s) from web application level to list level. And they must be at the same level.

-SourceGroup Required Specifies a group as the source whose permissions will be cloned. -Destination Required Specifies the username(s) or group name(s) as the destination that

you can clone permissions to. -Setting Required Configures the settings for cloning group permissions. -FarmName Required Specifies the farm where you wish search for the source group.

Obtain a SharePoint Blank Security Search Setting Object

To get a SharePoint blank security search setting object, run the following command:

Get-DASPBlankSecuritySearchSetting [<CommonParameters>]


C:\PS>$setting = Get-DASPBlankSecuritySearchSetting

Delete a SharePoint Dead Account

To delete the SharePoint dead account(s), run the following command:

Remove-DASPDeadAccount [-DeadAccount] <DeadAccount[]> [-DeleteMySite] [-DeleteUserProfiles] [<CommonParameters>]


C:\PS>$result = Scan-DASPDeadAccount -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$result | fl

C:\PS>$deadAccountForRemoving = $result[0],$result[2] C:\PS>Remove-DASPDeadAccount -DeadAccount $deadAccountForRemoving -DeleteMySite -DeleteUserProfiles


Parameter Type Comment -DeadAccount Required Specifies the dead accounts to remove. -DeleteMySite Optional Specifies whether or not to delete the My Site. -DeleteUserProfiles Optional Specifies whether or not to delete user profiles.

44


Check Permission Inheriting Information

To check whether a specified SharePoint object inherits permissions from a higher level, run the following command:

Check-DASPInheritingPermissions [-SharePointWeb] <SharePointWeb> [<CommonParameters>]

Check-DASPInheritingPermissions [-SharePointList] <SharePointList> [<CommonParameters>]

Check-DASPInheritingPermissions [-SharePointFolder] <SharePointFolder> [<CommonParameters>]

Check-DASPInheritingPermissions [-SharePointItem] <SharePointItem> [<CommonParameters>]


C:\PS>$web1 = New-Object DocAve.API.Objects.SharePointWeb ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint:1 0001/sites/site1','/sites/site1') C:\PS>Check-DASPInheritingPermissions -SharePointWeb $web1

Or

C:\PS>$list1 = New-Object DocAve.API.Objects.SharePointList ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1')

C:\PS>Check-DASPInheritingPermissions -SharePointList $list1

Or

C:\PS>$folder1 = New-Object DocAve.API.Objects.SharePointFolder('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/ site1/web1','list1','folder1')

C:\PS>Check-DASPInheritingPermissions -SharePointFolder $folder1

Or

C:\PS>$itemGuid = New-Object System.Guid('ea8d9fe2-5475-40c2-9850-eca0c117ccb4')

C:\PS>$item1 = New-Object DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1','folder1',$itemGuid)

C:\PS>Check-DASPInheritingPermissions -SharePointItem $item1

45



Parameter Type Comment -SharePointWeb Required Specifies a SharePoint site object. -SharePointList Required Specifies a SharePoint list object. SharePointFolder Required Specifies a SharePoint folder object to check whether or

not it is inheriting permissions from its parent. SharePointItem Required Specifies a SharePoint item object to check whether or

not it is inheriting permissions from its parent.

Get a Blank Clone SharePoint User Permission Setting Object

To get a blank clone SharePoint user permission setting object, run the following command:

Get-DASPBlankCloneUserPermissionSetting [<CommonParameters>]


C:\PS>Get-DASPBlankCloneUserPermissionSetting

Get a Blank Clone SharePoint Group Permission Setting Object

To get a blank clone SharePoint group permission setting object, run the following command:

Get-DASPBlankCloneGroupPermissionSetting [<CommonParameters>]

An example of the command is: C:\PS>Get-DASPBlankCloneGroupPermissionSetting

Clone SharePoint User Permission

To clone a specified SharePoint user’s permissions to a group or a user, run the following command:

Clone-DASPUserPermission [-Scope] <SharePointObject> [-SourceUser] <String> [-Destination] <String> [-Setting] <CloneUserPermissionSetting> [<CommonParameters>]

Clone-DASPUserPermission [-FarmName] <String> [-SourceUser] <String> [-Destination] <String> [-Setting] <CloneUserPermissionSetting> [<CommonParameters>]


C:\PS>$setting = Get-DASPBlankCloneUserPermissionSetting C:\PS>$setting.PermissionOption = 'Append' C:\PS>$setting.IncludeDetailedReport = $true C:\PS>Clone-DASPUserPermission -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -SourceUser 'user1' -Destination 'user2' -Setting $setting

46



Parameter Type Comment -FarmName Required Specifies the farm where you wish to search for the source

user. -Scope Required Specifies the node(s) as a scope where you wish to search for

the source user. You can specify the node(s) from Web application level to list level, but all objects must be at the same level.

-SourceUser Required Specifies a username as the source account whose permissions will be cloned.

-Destination Required Specifies the username(s) or group name(s) as the destination account(s) that you can clone permissions to.

-Setting Required Configures the settings for cloning user permissions.

Scan for Dead Accounts

To scan for dead accounts within a specified scope, run the following command:

Scan-DASPDeadAccount [-Scope] <SharePointObject[]> [<CommonParameters>]

Scan-DASPDeadAccount [-FarmName] <String> [<CommonParameters>]


C:\PS>$site1 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1') C:\PS>$site2 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site2') C:\PS>$result = Scan-DASPDeadAccount -Scope $site1,$site2 C:\PS>$result | fl C:\PS>$result = Scan-DASPDeadAccount -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$result | fl


Parameter Type Comment -Scope Required Specifies Web application(s), site collection(s), or site(s) as the

object(s) where you want to scan the dead accounts. The objects you specify must be at the same level.

-FarmName Required Specifies a farm name.

Search Users or Groups with Specific Permissions

To search SharePoint users or groups who have specific permissions, run the following command:

47


Search-DASPPermission [-Scope] <SharePointObject[]> [-Setting] <SecuritySearchSetting> [-PlanName <String>] [<CommonParameters>]

Search-DASPPermission [-FarmName] <String> [-Setting] <SecuritySearchSetting> [-PlanName <String>] [<CommonParameters>]


C:\PS>$setting = Get-DASPBlankSecuritySearchSetting C:\PS>$setting.UserAndGroup.Add('example.com/user1') C:\PS>$setting.IncludeSharePointGroupMembers = $true C:\PS>$setting.IncludeADGroupMembersOrFBARoleMembers = $true C:\PS> C:\PS>$rule01 = New-Object DocAve.API.Administration.Administrator.Security.ListOrLibraryUrlFilterRule C:\PS>$rule01.EqualsCondition = 'http://SharePoint2010:10001/Shared Documents' C:\PS>$rule01.CombineMode = 'Or' C:\PS> C:\PS>$rule02 = New-Object DocAve.API.Administration.Administrator.Security.ListOrLibraryUrlFilterRule C:\PS>$rule02.MatchesCondition = '*Link*' C:\PS> C:\PS>$setting.SearchFilterRules.Add($rule01) C:\PS>$setting.SearchFilterRules.Add($rule02) C:\PS> C:\PS>$webapplication1 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/') C:\PS>$webapplication2 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10002') C:\PS>Search-DASPPermission -Scope $webapplication1,$webapplication2 -Setting $setting

Or

C:\PS>$setting = Get-DASPBlankSecuritySearchSetting C:\PS>$setting.IncludeSharePointUsersAndGroupsWithNoPermissions = $true C:\PS>$setting.LimitedPermissions = 'FullControl' C:\PS>$setting.OnlySearchForExplicitPermissions = $true C:\PS>$setting.PermissionPolicy = 'ExactPermissionOrBetter' C:\PS>$setting.IncludeSharePointGroupMembers = $true C:\PS>$setting.IncludeADGroupMembersOrFBARoleMembers = $true C:\PS>Search-DASPPermission -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -Setting $setting -PlanName 'plan1'

48



Parameter Type Comment -Scope Required Specifies the scope with the node(s) you want to search. -Setting Required Specifies a security search settings. -PlanName Optional Specifies a plan name. -FarmName Required Specifies a farm name.

Stop Inheriting Permissions from the Upper Level

To stop the permission inheritance relationship for a specified object from an upper level, run the following command:

Stop-DASPInheritingPermissions [-SharePointWeb] <SharePointWeb[]> [<CommonParameters>]

Stop-DASPInheritingPermissions [-SharePointList] <SharePointList[]> [<CommonParameters>]

Stop-DASPInheritingPermissions [-SharePointFolder] <SharePointFolder[]> [<CommonParameters>]

Stop-DASPInheritingPermissions [-SharePointItem] <SharePointItem[]> [<CommonParameters>]


C:\PS>$web = New-Object DocAve.API.Objects.SharePointWeb ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/site1') C:\PS>Stop-DASPInheritingPermissions -SharePointWeb $web

Or C:\PS>$list = New-Object DocAve.API.Objects.SharePointList ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','sites/site1','list1') C:\PS>Stop-DASPInheritingPermissions -SharePointList $list

Or

C:\PS>$folder1 = New-Object DocAve.API.Objects.SharePointFolder('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/ site1/web1','list1','folder1')

C:\PS>Stop-DASPInheritingPermissions -SharePointFolder $folder1

C:\PS>$itemGuid = New-Object System.Guid('ea8d9fe2-5475-40c2-9850-eca0c117c cb4')

Or

C:\PS>$item1 = New-Object DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1','folder1',$itemGuid)

49


C:\PS>Stop-DASPInheritingPermissions -SharePointItem $item1


Parameter Type Comment -SharePointWeb Required Specifies the sites as the objects where you want to

break the permission inheritance. -SharePointList Required Specifies the lists as the objects where you want to break

the permission inheritance. -SharePointFolder Required Specifies the SharePoint folder objects to stop its

permission inheritance. -SharePointItem Required Specifies the SharePoint item object(s) to stop its

permission inheritance.

Content Manager Refer to the section below for more information on the cmdlets’ usage in Content Manager.

Get a Blank Content Manager Online Plan

To get a blank Content Manager online plan, run the following command:

Get-DAContentManagerBlankOnlinePlan [<CommonParameters>]


C:\PS>Get-DAContentManagerBlankOnlinePlan

Get an Online Content Manager Plan’s Configuration Details

To get the configuration details of an online Content Manager plan, run the following command:

Get-DAContentManagerOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAContentManagerOnlinePlan plan1


Parameter Type Comment -Name Optional Specifies the name(s) of the existing online Content Manager

plan(s) you want to obtain. Wildcards and multiple values are allowed, which should be separated by commas. If no values are entered here, the plan settings of all existing online Content Manager plan(s) will be obtained.

50


Create an Online Content Manager Plan

To create an online Content Manager plan, run the following command:

New-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAContentManagerBlankOnlinePlan C:\PS>$plan.SourceFarmName = 'Farm(SP2010_DB1:SHAREPOINT_CONFIG)' C:\PS>$plan.DestinationSPSitesGroupName = 'Default_SharePoint Sites_ Group' C:\PS>$plan.Name = 'plan1' C:\PS>$sitecollection01 = New-Object DocAve.API.Objects.SharePointSite($plan.SourceFarmName, 'http://SharePoint2010:10001') C:\PS>$sitecollection02 = New-Object DocAve.API.Objects.SharePointOnlineSite($plan.DestinationSPSitesGroupName,'http://10.1.1.1:10020') C:\PS>$plan.SourceTree.IncludeSPObject($sitecollection01) C:\PS>$plan.DestinationTree.SelectSPOnlineObject($sitecollection02) C:\PS>$plan.Action = 'Merge' C:\PS>$plan.SetPlanType('Move') C:\PS>$plan.MethodSettings.DeleteSourceCheckedOutDocuments = $true C:\PS>$plan.MethodSettings.SourceDocumentsAndItemsDeletedMethod = 'Manually' C:\PS>$plan.MethodSettings.EnableBackupEnvironment('SourceEnvironment','storage policy1') C:\PS>$plan.FilterPolicy = 'filter policy 01' C:\PS>$plan.UserMapping = 'user mapping 01' C:\PS>$plan.ConflictResolution = 'ConflictResolutionOption7' C:\PS>$plan.DataCompression = 'Level7' C:\PS> C:\PS>New-DAContentManagerOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies an online Content Manager plan object. For

more information about the structure and attributes of ContentManagerOnlinePlan, refer to the DocAve 6 SDK documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

51


Run a Content Manager Export Plan

To run an existing Content Manager export plan, run the following command:

Run-DAContentManagerExportJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAContentManagerExportJob -PlanName 'plan1' -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Content Manager export

plan that you want to run. -WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If

so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

Run a Content Manager Import Plan

To run an existing Content Manager import plan, run the following command:

Run-DAContentManagerImportJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAContentManagerImportJob -PlanName 'plan1' -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Content Manager

import plan that you want to run. -WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If


Run a Content Manager Copy Plan

To run an existing Content Manager copy plan, run the following command:

Run-DAContentManagerCopyJob [-PlanName] <String> [-TestRun] [-WaitForJobComplete] [<CommonParameters>]

52



C:\PS>Run-DAContentManagerCopyJob -PlanName 'plan1' -TestRun -WaitForJobComplete



copy plan that you want to run. -TestRun Optional Specifies whether to simulate the execution of the

selected plan. -WaitForJobComplete Optional Specifies whether to wait for the completion of the

job. If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

Run a Content Manager Move Plan

To run an existing Content Manager move plan, run the following command:

Run-DAContentManagerMoveJob [-PlanName] <String> [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAContentManagerMoveJob -PlanName 'plan1' -TestRun -WaitForJobComplete



move plan that you want to run. -TestRun Optional Specifies whether to simulate the execution of the

selected plan. -WaitForJobComplete Optional Specifies whether to wait for the completion of the


Delete a Content Manager Online Plan

To delete a content manager online plan, run the following command:

Remove-DAContentManagerOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

53



C:\PS>Remove-DAContentManagerOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of the online Content Manager plan that

you want to delete. -WhatIf Optional Describes what would happen without actually executing the

command. -Confirm Optional Prompts you for confirmation before executing the

command.

Update the Configurations of a Content Manager Plan

To update the configurations of an existing Content Manager plan, run the following command:

Update-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAContentManagerOnlinePlan -Name 'plan1' C:\PS>$plan.Name = 'plan2' C:\PS>Update-DAContentManagerOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a Content Manager online plan object for updating.

Deployment Manager Refer to the section below for more information on the cmdlet usage in Deployment Manager.

Run a Deployment Manager Plan

To run an existing Deployment Manager plan, run the following command:

Run-DADeploymentManagerJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DADeploymentManagerJob -PlanName 'plan1' -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Deployment

54


Parameter Type Comment Manager plan that you want to run.

-WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

Replicator Refer to the section below for more information on the cmdlets’ usage in Replicator.

Run a Replicator Export Plan

To run an existing Replicator export plan, run the following command:

Run-DAReplicatorExportJob [-PlanName] <String> -ReplicatorRunLevel <ReplicatorRunLevel> [-ReplicateModifications] [-ReplicateDeletions] [-SpecialReferenceTime <String>] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAReplicatorExportJob -PlanName 'plan1' -ReplicatorRunLevel Full -WaitForJobComplete C:\PS>Run-DAReplicatorExportJob -PlanName 'plan2' -ReplicatorRunLevel Incremental -ReplicateModifications -ReplicateDeletions -SpecialReferenceTime 11m


Parameter Type Comment -PlanName Required Specifies the name of an existing Replicator export plan

that you want to run. -ReplicatorRunLevel Required Specifies the job level. Valid values are “Full” and

“Incremental”. -ReplicateModifications Optional Specifies whether to replicate the modifications.

You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental.'

-ReplicateDeletions Optional Specifies whether to replicate the deletions. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental.'

-SpecialReferenceTime Optional Specifies the reference time. The job will replicate the contents which were created or modified during the specified period just before the job start time.

55


Parameter Type Comment -WaitForJobComplete Optional Specifies whether to wait for the completion of the job.

If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

Run a Replicator Import Plan

To run an existing Replicator import plan, run the following command:

Run-DAReplicatorImportJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAReplicatorImportJob -PlanName 'plan1' -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Replicator import plan

that you want to run. -WaitForJobComplete Optional Specifies whether to wait for the completion of the job.

If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

Run an Online Replicator Plan Using Management Shell

To run an existing online Replicator plan, run the following command:

Run-DAReplicatorOnlineJob [-PlanName] <String> -ReplicatorRunLevel <ReplicatorRunLevel> [-ReplicateModifications] [-ReplicateDeletions] [-SpecialReferenceTime <String>] [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAReplicatorOnlineJob -PlanName 'plan1' -ReplicatorRunLevel Full -WaitForJobComplete -TestRun C:\PS>Run-DAReplicatorOnlineJob -PlanName 'plan2' -ReplicatorRunLevel Incremental -ReplicateModifications -ReplicateDeletions -TestRun


Parameter Type Comment -PlanName Required Specifies the name of an existing Replicator plan that

you want to run.

56


Parameter Type Comment -ReplicatorRunLevel Required Specifies the job level. Valid values are “Full” and

“Incremental”. -ReplicateModifications Optional Specifies whether to replicate the modifications.

You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'.

-ReplicateDeletions Optional Specifies whether to replicate the deletions. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'.

-SpecialReferenceTime Optional Specifies the reference time. The job will replicate the contents which were created or modified during the specified period just before the job start time.

-TestRun Optional Specifies whether to simulate the execution of the selected plan.


Storage Optimization Refer to the section below for more information on the cmdlets’ usage in Storage Optimization.

BLOB Provider Refer to the section below for more information on the cmdlets’ usage for BLOB Provider.

Obtain a Stub Database’s Configuration

To get configuration details of a stub database, run the following command:

Get-DAStubDBConfiguration [-FarmName] <String> [<CommonParameters>]


C:\PS>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$StubDBConfig.WebApplicationStubDBConfigurations


Parameter Type Comment -FarmName Required Specifies a farm name.

57


Configure a Stub Database

To configure a stub database for a farm, Web application, or content database, run the following command:

Configure-DAStubDB [-Configuration] <StubDBConfiguration> [<CommonParameters>]


C:\PS>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$ContentDBs = $StubDBConfig.GetContentDBLevelStubDBConfigurationByName('WSS_Content_10001') C:\PS>$ContentDB1 = $ContentDBs[0] C:\PS>$ContentDB1.ConfigureAsWindowsAuthentication ('DBServer','StubDB1') C:\PS>$ContentDB1.FailoverDatabaseServer = 'FailoverDBServer' C:\PS>Configure-DAStubDB -Configuration $ContentDB1 C:\PS>$ContentDB2 = $StubDBConfig.GetContentDBLevelStubDBConfigurationById ("f17d7594-d09a-49a8-b41a-479a877a51d0") C:\PS>$password = Read-Host -AsSecureString ****** C:\PS>$ContentDB2.ConfigureAsSQLAuthentication ('DBServer','StubDB2','Username',$password) C:\PS>$ContentDB2.FailoverDatabaseServer = 'FailoverDBServer' C:\PS>Configure-DAStubDB -Configuration $ContentDB2

Or

C:\PS>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/') C:\PS>$password = Read-Host -AsSecureString

********* C:\PS>$WebAppConfig.ConfigureAsSQLAuthentication('DBServer','StubDB1','Username',$password) C:\PS>Configure-DAStubDB -Configuration $WebAppConfig

Or

C:\PS>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/') C:\PS>$WebAppConfig.ConfigureByConnectionString('DataSource=myServerAddress;Failover

58


Partner=myMirrorServerAddress;Initial Catalog=myDataBase;Integrated Security=true;') C:\PS>Configure-DAStubDB -Configuration $WebAppConfig


Parameter Type Comment -Configuration Required Specifies the stub database configuration. You can

specify the farm level stub database configuration, Web application stub database configuration and content database stub database configuration.

Get Information About All BLOB Provider Binaries

To get information about all BLOB Provider binaries, run the following command:

Get-DABLOBProviderBinariesInfo [[-FarmName] <String>] [<CommonParameters>]


C:\PS>Get-DABLOBProviderBinariesInfo -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)'


Parameter Type Comment -FarmName Optional Specifies a farm name. If you do not set any value for

the parameter, all of the farms' BLOB Provider binaries’ information will be returned.

Get the BLOB Provider Configuration Details

To get the configuration details of the BLOB Provider, run the following command:

Get-DABLOBProviderConfiguration [-FarmName] <String> [<CommonParameters>]


C:\PS>$BLOB = Get-DABLOBProviderConfiguration -FarmName'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$BLOB.WebApplicationLevelRBSConfigurations C:\PS> $BLOB.ContentDBLevelRBSConfigurations


Parameter Type Comment -FarmName Required Specifies a farm name.

59


Update BLOB Provider Settings

To update the BLOB Provider settings, run the following command:

Save-DABLOBProviderConfiguration [-Configuration] <BLOBProviderConfiguration> [-RunNow] [<CommonParameters>]


C:\PS>$BLOB = Get-DABLOBProviderConfiguration -FarmName ' 'Farm(SP2010_DB:SHAREPOINT_CONFIG)'

C:\PS>$ContentDB1 = $BLOB.GetContentDBLevelRBSConfigurationByName ('WSS_Content_10001') C:\PS>$ContentDB1 = $ContentDBs[0] C:\PS>$ContentDB1.RBSEnabled = $true C:\PS>$ContentDB2 = $BLOB.GetContentDBLevelRBSConfigurationById ('f17d7594-d09a-49a8-b41a-479a877a51d0')

C:\PS>$ContentDB2.RBSEnabled = $true C:\PS>$ContentDB1 C:\PS>$ContentDB2 C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB


Parameter Type Comment -Configuration Required Specifies the BLOB Provider configuration instance. -RunNow Optional Determines whether to run now after saving the

configuration.

Archiver Refer to the section below for more information on the cmdlets’ usage in Archiver.

Get Archiver Index Data Information

To get information on the Archiver Data that has not been successfully indexed, run the following command:

Get-DAArchiverIndexDataInfo [-FarmName] <String> [-OutPut] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Get-DAArchiverIndexDataInfo -FarmName FarmA -OutPut C:\IndexInfo.xls

60



Parameter Type Comment -FarmName Required Specifies the name of a farm where the Archiver Data’s

index information will be retrieved from. -OutPut Required Specifies a path to store the output file. -Overwrite Optional Overwrites the file if it already exists at the specified path.

Get an Archiver Job’s Detailed Information for Backup

To get detailed information on an Archiver job for backup, run the following command:

Get-DAArchiverJobDetailForBackup [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DAArchiverJobDetailForBackup -ID AR20120710135406923230S C:\PS>Get-DAArchiverJobDetailForBackup -ID AR20120710135406923230S -JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1


Parameter Type Comment -ID Required Specifies the job ID. -JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid

values are “Success”, “Failed”, and “Skipped”. -StartIndex Optional Specifies the start number of the details that you

want to get. -Length Optional Specifies the total number of details in the result.

Get an Archiver Job’s Detailed Information for Deletion

To get detailed information on an Archiver job for deletion, run the following command:

Get-DAArchiverJobDetailForDeletion [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DAArchiverJobDetailForDeletion -ID AR20120710135855645356A0

Or C:\PS>Get-DAArchiverJobDetailForDeletion -ID AR20120710135855645356A0 -JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1

61



Parameter Type Comment -ID Required Specifies the job ID. -JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid

values are “Success”, “Failed”, and “Skipped”. -StartIndex Optional Specifies the start number of the details that you

want to get. -Length Optional Specifies the total number of details in the result.

Run Full Text Index Job

To run a full text index job, run the following command:

Run-DAArchiverIndexJob -JobId <String> [<CommonParameters>]


C:\PS>Run-DAArchiverIndexJob -JobId AI20120710135406923230


Parameter Type Comment -JobId Required Specifies an Archiver index job ID.

Run an Archiver Job

To run an Archiver job, run the following command:

Run-DAArchiverJob [-SPObject] <SharePointObject> [-WaitForJobComplete] [<CommonParameters>]

The example of the command is:

C:\PS>$site1 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1') C:\PS>Run-DAArchiverJob -SPObject $site1


Parameter Type Comment -SPObject Required The SharePoint object to be archived. -WaitForJobComplete Optional Specifies whether to wait for the completion of the


62


Set the Archiver Data Index Information

To set the index information of Archiver data that has not been successfully indexed, run the following command:

Set-DAArchiverIndexDataInfo [-Path] <String> [-OutPut] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Set-DAArchiverIndexDataInfo -Path C:\IndexInfo.xls -OutPut C:\Result .xls


Parameter Type Comment -Path Required Specifies a path to load the file storing the Archiver

data’s index information. -OutPut Required Specifies a path to store the output file. -Overwrite Optional Overwrites the file if it already exists at the specified

path.

Real-Time Storage Manager Refer to the section below for more information on the cmdlets’ usage in Real-Time Storage Manager.

Get a Blank Real-Time Storage Manager Rule

To get a blank Real-Time Storage Manager rule, run the following command:

Get-DARealtimeStorageManagerBlankRule [<CommonParameters>]


C:\PS>$rule = Get-DARealtimeStorageManagerBlankRule

Get a Real-Time Storage Manager Rule

To get the configurations of a Real-Time Storage Manager rule, run the following command:

Get-DARealtimeStorageManagerRule [-Name <String>] [<CommonParameters>]

Get-DARealtimeStorageManagerRule [-SPContentDB <SharePointContentDB>] [<CommonParameters>]


C:\PS>Get-DARealtimeStorageManagerRule

Or C:\PS>Get-DARealtimeStorageManagerRule -Name 'rule2'

63


Or C:\PS>$db = New-Object DocAve.API.Objects.SharePointContentDB 'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001' C:\PS>Get-DARealtimeStorageManagerRule -SPContentDB $db


Parameter Type Comment -Name Optional Specifies the name of the Real-Time Storage Manager

rule whose configurations will be obtained. -SPContentDB Optional Specifies a SharePoint content database. All Real-Time

Storage Manager rules that have been applied to this specified database will be obtained.

-SPWebApplication Optional Specifies a SharePoint Web application. All Real-Time Storage Manager rules that have been applied to this specified Web application will be obtained.

-SPSite Optional Specifies a SharePoint site collection. All Real-Time Storage Manager rules that have been applied to this specified site collection will be obtained.

Create a Real-Time Storage Manager Rule

To create a Real-Time Storage Manager rule, run the following command:

New-DARealtimeStorageManagerRule [-Rule] <RealtimeStorageManagerRule> [<CommonParameters>]


C:\PS>$rule = Get-DARealtimeStorageManagerBlankRule C:\PS>$rule. Name = ‘rule1’ C:\PS>$rule.SizeThreshold = '768kb' C:\PS>$rule.LogicalDeviceName = 'logical device1' C:\PS>$rule.CompressionLevel = 'level3' C:\PS>$rule.EnableDataEncryption('MyProfile') C:\PS>New-DARealtimeStorageManagerRule $rule


Parameter Type Comment -Rule (or $rule) Required Specifies a real-time storage manager rule object where

you can create a new real-time storage manager rule.

Retract a Real-Time Storage Manager Rule

To retract an existing Real-Time Storage Manager rule from the specified SharePoint content database, Web application, or site collection, run the following command:

64


Retract-DARealtimeStorageManagerRule [-RuleName] <String> [-SPContentDB] <SharePointContentDB> [<CommonParameters>]


C:\PS>$db = New-Object DocAve.API.Objects.SharePointContentDB 'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001' C:\PS>Retract-DARealtimeStorageManagerRule -RuleName 'rule1' -SPContentDB $db


Parameter Type Comment -RuleName Required Specifies the name of the Real-Time Storage Manager

rule that you want to retract from the specified SharePoint content database.

-SPContentDB Optional Specifies a SharePoint content database where the specified Real-Time Storage Manager rule will be retracted.

-SPWebApplication Optional Specifies a SharePoint Web application where the specified Real-Time Storage Manager rule will be retracted.

-SPSite Optional Specifies a SharePoint site collection where the specified Real-Time Storage Manager rule will be retracted.

Reuse a Real-Time Storage Manager Rule

To reuse an existing Real-Time Storage Manager rule, run the following command:

Reuse-DARealtimeStorageManagerRule [-RuleName] <String> [-SPContentDB] <SharePointContentDB> [<CommonParameters>]


C:\PS>$db = New-Object DocAve.API.Objects.SharePointContentDB 'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001' C:\PS>Reuse-DARealtimeStorageManagerRule -RuleName 'rule1' -SPContentDB $db


Parameter Type Comment -RuleName Required Specifies the name of the Real-Time Storage Manager

rule that you want to reuse. -SPContentDB Optional Specifies a SharePoint content database where the

specified Real-Time Storage Manager rule will be applied. -SPWebApplication Optional Specifies a SharePoint Web application where the

specified Real-Time Storage Manager rule will be applied. -SPSite Optional Specifies a SharePoint site collection where the specified

Real-Time Storage Manager rule will be applied.

65


Delete a Real-Time Storage Manager Rule

To delete a Real-Time Storage Manager rule, run the following command:

Remove-DARealtimeStorageManagerRule [-Name] <String> [<CommonParameters>]


C:\PS>Remove-DARealtimeStorageManagerRule -Name 'rule1'


Parameter Type Comment -Name Required Specifies the name of a Real-Time Storage Manager rule

that you want to delete.

Update the Configurations of a Real-Time Storage Manager Rule

To update the configurations of an existing Real-time Storage Manager rule, run the following command:

Update-DARealtimeStorageManagerRule [-Rule] <RealtimeStorageManagerRule> [< CommonParameters>]


C:\PS>$rule = Get-DARealtimeStorageManagerRule -Name 'rule1' C:\PS>$rule.Name = 'rule2' C:\PS>$rule.CompressionLevel = 'level7' C:\PS>Update-DARealtimeStorageManagerRule $rule


Parameter Type Comment -Rule (or $rule) Required Specifies a Real-Time Storage Manager rule object whose

configurations will be updated.

Job Monitor Refer to the section below for more information on the cmdlets’ usage in Job Monitor.

Obtain a Specified Module’s Job To get a job of a specified module, run the following command:

Get-DAJob [-ID] <String> [<CommonParameters>]

Get-DAJob [-Module] <Module> [-StartTimeRangeBeginning <DateTime>] [-StartTimeRangeEnding <DateTime>] [<CommonParameters>]

66



C:\PS>Get-DAJob -Id CA20120710105416471063 Or C:\PS>Get-DAJob -Module Administrator Or C:\PS>Get-DAJob -Module Administrator -StartTimeRangeBeginning "7/10/2012 10:10" -StartTimeRangeEnding "7/10/2012 10:58"


Parameter Type Comment -ID Required Specifies the job ID. -Module Required Specifies the job's module. Valid values are

“GranularBackup”, “GranularRestore”, "PlatformBackup", "PlatformRestore", "PlatformMaintenanceManager", "Retention", "FarmRebuild", "PlatformIndexMigration", "Administrator", "ContentManager", "DeploymentManager", "Replicator", "Archiver", "ArchiverFullTextIndex", "ArchiverRestore", "ArchiverRetention", "ConvertStubToContent", "ScheduledStorageManager", "Connector", "OrphanBLOBRetention", "ReportCenter", "LogManager", "JobPruning", "FileSystemMigration", "SharePointMigration", "ERoomMigration", "LivelinkMigration", "ExchangePublicFolderMigraton", "LotusNotesMigration", "EndUserArchiver", "EndUserRestore", "DataManager", "eDiscovery", "Vault", "EndUserGranularRestore", "StorageReport", "QuickrMigration", "EMCDocumentumMigration", "AnalyzeSQLBackup", "RestoreFromSQLBackup", "HighAvailabilityFailover", "HighAvailabilitySync", "HighAvailabilityFallback", "HighAvailabilityPreScan", "ReportCollector" and "DataSync".

-StartTimeRangeBeginning Optional Specifies the beginning of job start time range. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2010 12:15:12 for English-US. If you do not specify the time range, the job information will not be filtered according to job start time.

-StartTimeRangeEnding Optional Specifies the end of job start time range. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2010 12:15:12 for English-US. If you do not specify the time range, it will not filter the job information according to job start time.

67


Obtain a Job’s Detailed Information To get detailed information on the items included in a job (such as item type, source URL, destination URL, etc.), run the following command:

Get-DAJobDetail [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DAJobDetail -ID CM20111011115232293242

Or C:\PS>Get-DAJobDetail -ID CM20111011115233293432 -JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1


Parameter Type Comment -ID Required Specifies the job ID. -JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid values

are “Success”, “Failed”, and “Skipped”. If the job is a Deployment Manager job, this parameter is ignored.

-StartIndex Optional Specifies the start number of the details. If the job is a Deployment Manager job, this parameter is ignored.

-Length Optional Specifies the total number of details in the result. If the job is a Deployment Manager job, this parameter is ignored.

*Notes: The Get-DAJobDetail cmdlet cannot get the following jobs' details: Deployment Manager queue job, Replicator mapping job, Archiver job, and SharePoint migration job. If the job is a Deployment Manager job, this cmdlet will return the queue information.

An error may occur if the job detail has a very large amount of data. Please use the parameters StartIndex and Length and set the suitable values to limit the data size of job detail got at a time.

Obtain a Job’s Summary Information To get a job summary, run the following command:

Get-DAJobSummary [-ID] <String> [<CommonParameters>]


C:\PS>Get-DAJobSummary -ID CA20120710105416471063

68



Parameter Type Comment -ID Required Specifies the job ID.

Download a Job Report To download a job report, run the following command:

Download-DAJobReport [-ID] <String> [-Format <JobReportFormat>] -Path <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAJobReport -ID FB20120627174730343482 -Path 'C:\Report.zip'-Format txt -Overwrite


Parameter Type Comment -ID Required Specifies the job ID. -Format Optional Specifies the format of the report. Valid values are “XLS”,

“CSV”, and “TXT”. If the job is a Log Manager job, this parameter is ignored.

-Path Required Specifies the path of the report file.

-Overwrite Optional Allows the cmdlet to overwrite an existing file.

Migration Refer to the section below for more information on the cmdlets’ usage in Migration.

General SharePoint Migration Commands Refer to the section below for more information on the cmdlets’ usage for SharePoint Migration jobs.

Get the Configuration Details of a SharePoint Migration Job

To get the configuration details of the specified SharePoint online migration job, run the following command:

Get-DASPMigrationJobConfigurationDetail [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DASPMigrationJobConfigurationDetail -ID MD20120601151648823941

69


C:\PS>Get-DASPMigrationJobConfigurationDetail -ID MD20120601151648823941 -JobReportDetailStatus Success -StartIndex0 -Length 1


Parameter Type Comment -ID Required Specifies a Job ID to get the detailed job configurations. -JobReportDetailStatus Optional Specifies a status filter to only display the configuration

details of the specified status. The valid values are "Success", "Failed", "Skipped", and "Filtered".

-StartIndex Optional Specifies a number to be used when displaying the configuration details of the specified status. After the detailed information is filtered according to the status specified in the "JobReportDetailStatus" parameter, the configuration details will be displayed starting from the detailed information ranked with this number.

-Length Optional Specifies the number of the configuration details to be displayed.

Get the Permission Details of a SharePoint Migration Job

To get the detailed information of the objects in a SharePoint online migration job, run the following command:

Get-DASPMigrationJobPermissionDetail [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DASPMigrationJobPermissionDetail -ID MD20120601151648823941

C:\PS>Get-DASPMigrationJobPermissionDetail -ID MD20120601151648823941-JobReportDetailStatus Success -StartIndex 0 -Length 1


Parameter Type Comment -ID Required Specifies a Job ID to get the detailed permission

configurations. -JobReportDetailStatus Optional Specifies a status filter to only display the permission details

of the specified status. The valid values are "Success", "Failed", "Skipped" and "Filtered".

-StartIndex Optional Specifies a number to be used when displaying the permission details of the specified status. After the detailed information is filtered according to the status specified in the "JobReportDetailStatus" parameter, the configuration details will be displayed starting from the detailed information ranked with this number.

70


Parameter Type Comment -Length Optional Specifies the number of the permission details to be

displayed.

Get the Object Details of a SharePoint Migration Job

To get the detailed information of the objects in a SharePoint online migration job, run the following command:

Get-DASPMigrationJobObjectsDetail [-ID] <String> [-JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>]


C:\PS>Get-DASPMigrationJobObjectsDetail -ID MD20120601151648823941

C:\PS>Get-DASPMigrationJobObjectsDetail -ID MD20120601151648823941-JobReportDetailStatus Success -StartIndex 0 -Length 1


Parameter Type Comment -ID Required Specifies a job ID to get the detailed object

information. -JobReportDetailStatus Optional Specifies a status filter to only display the object

details of the specified status. The valid values are "Success", "Failed", "Skipped" and "Filtered".

-StartIndex Optional Specifies a number to be used when displaying the detailed object information of the specified status. After the detailed information is filtered according to the status specified in the "JobReportDetailStatus" parameter, the object details will be displayed starting from the detailed information ranked with this number.

-Length Optional Specifies the number of object details to be displayed.

File System Migration Refer to the section below for more information on the cmdlets’ usage in File System Migration.

Generate the Metadata File(s) for the Migrated Contents

To generate the metadata file(s) for the migrated content, run the following command:

Generate-DAFileSystemMigrationMetadataFile [-PlanName] <String> -Option <String> [<CommonParameters>]

71



C:\PS>$jobId = Generate-DAFileSystemMigrationMetadataFile -PlanName 'plan 1' -Option Full


Parameter Type Comment -PlanName Required Specifies the name of the plan used to generate the metadata

configuration file. -Option Required Specifies the generation type for the metadata file. Valid

values are "Full" and "Incremental".

Get a Blank File System Online Migration Plan

To get a blank file system online migration plan, run the following command:

Get-DAFileSystemMigrationBlankOnlinePlan [<CommonParameters>]


C:\PS>$plan = Get-DAFileSystemMigrationBlankOnlinePlan

Get the Plan Settings of a File System Online Migration Plan

To get the plan settings of a file system online migration plan, run the following command:

Get-DAFileSystemMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAFileSystemMigrationOnlinePlan -Name 'plan 1'


Parameter Type Comment -Name Optional Specifies the name(s) of the existing file system online

migration plan(s) that you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all the existing file system online migration plan(s) will be obtained.

Create a New File System Online Migration Plan

To create a new file system online migration plan, run the following command:

New-DAFileSystemMigrationOnlinePlan [-Plan] <FileSystemMigrationOnlinePlan> [<CommonParameters>]

72



C:\PS>$plan = Get-DAFileSystemMigrationBlankOnlinePlan

C:\PS>$plan.Name = 'plan 1'

C:\PS>$plan.ProfileName = 'default profile'

C:\PS>$plan.SourceAgentName = 'sp2010'

C:\PS>$folder = New-Object DocAve.API.Migration.FileSystemMigration.FileSystemFolder 'connection 2', 'folder1\folder2'

C:\PS>$plan.SourceTree.Include($folder)

C:\PS>$list = New-Object DocAve.API.Objects.SharePointList 'Farm(SQL:SHAREPOINT_CONFIG)', 'http://sp2010', '', 'shared documents'

C:\PS>$plan.DestinationTree.SelectSPObject($list)

C:\PS>New-DAFileSystemMigrationOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies a file system migration online plan object.

For more information about the structure and attributes of FileSystemMigrationOnlinePlan, refer to the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

Delete a File System Online Migration Plan

To delete a file system online migration plan, run the following command:

Remove-DAFileSystemMigrationOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAFileSystemMigrationOnlinePlan -Name 'plan1'

73



Parameter Type Comment -Name Required Specifies the name of a file system online migration

plan that you want to delete. -WhatIf Optional Describes what would happen if you executed the


command.

Run a File System Online Migration Job

To perform a file system online migration job, run the following command:

Run-DAFileSystemMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <FileSystemMigrationConflictResolution> [-RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAFileSystemMigrationOnlineJob -PlanName 'plan 1' -Options Incremental-ConflictResolution MergeAndAppend –WaitForJobComplete -RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions


Parameter Type Comment -PlanName Required Specifies the name of an existing file

system online migration plan that you want to run.

-Options Required Specifies to run a full or an incremental migration job of the selected file system online migration plan. Valid values are "Full" and "Incremental".

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "SkipAndNewVersion", "MergeAndOverwrite", "MergeAndAppend" and "MergeAndNewVersion". For detailed information on each of these values, refer to the note below this table.

-RemigrateObjectsWithException Optional Specifies whether or not to re-migrate the objects whose metadata/securities failed to be migrated in the last migration job. This parameter is available only when the

74


Parameter Type Comment migration option is "Incremental" and the Content level conflict resolution is not "Skip".

-IgnoreMetadataAndSecurityExceptions

Optional Specifies whether or not to ignore the metadata/security exceptions. 'True' means not to take them into consideration for the job status; 'False' means to take them into consideration for the job status.


-WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.

*Note: The following information is related to the values in the -ConflictResolution parameter.

• Skip ─ Skips the conflicted containers in a migration job when conflicts occur.

• SkipAndSkip ─ Skips the conflicted containers and all lower-level objects in a migration job when conflicts occur.

• SkipAndOverwrite ─ Skips the conflicted containers and overwrites all lower-level objects in a migration job when conflicts occur.

• SkipAndAppend ─ Skips the conflicted containers and appends all lower-level objects in a migration job when conflicts occur.

• MergeAndSkip ─ Merges the conflicted containers and skips all lower-level objects in a migration job when conflicts occur.

• MergeAndOverwrite ─ Merges the conflicted containers and overwrites all lower-level objects in a migration job when conflicts occur.

• MergeAndAppend ─ Merges the conflicted containers and appends all lower-level objects in a migration job when conflicts occur.

Update a File System Online Migration Plan

To update a file system online migration plan, run the following command:

Update-DAFileSystemMigrationOnlinePlan [-Plan] <FileSystemMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAFileSystemMigrationOnlinePlan -Name 'plan 1'

75


C:\PS>$plan.Description = 'updated from cmdlet'

C:\PS>$file = New-Object DocAve.API.Migration.FileSystemMigration.FileSystemFile 'connection 1', 'folder1\folder2\test.txt'

C:\PS>$plan.SourceTree.Include($file)

C:\PS>Update-DAFileSystemMigrationOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies a file system online migration plan for editing.

Upload a File System Online Migration Options Profile

To upload a File System online migration options profile, run the following command:

Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite


Parameter Type Comment -Path Required Specifies the path of the XML file. -Overwrite Optional Allows the cmdlet to overwrite an existing profile.

Upload a File System Online Migration Mapping Options Profile

To upload a File System online migration mapping options profile, run the following command:

Upload-DAFileSystemMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DAFileSystemMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite



76


Download a File System Online Migration Options Profile

To download a File System online migration options profile, run the following command:

Download-DAFileSystemMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAFileSystemMigrationOnlineMigrationOptionsProfile -Name 'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite


Parameter Type Comment -Name Required Specifies the profile name. -Path Required Specifies the path to store the downloaded XML file. -Overwrite Optional Allows the cmdlet to overwrite an existing file.

Download a File System Online Migration Mapping Options Profile

To download a File System online migration mapping options profile, run the following command:

Download-DAFileSystemMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAFileSystemMigrationOnlineMappingOptionsProfile -Name 'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite



SharePoint 2007 to 2010 Migration Refer to the section below for more information on the cmdlets’ usage in SharePoint 2007 to 2010 Migration.

Get a Blank SharePoint 2007 to 2010 Online Migration Plan

To get a blank SharePoint 2007 to 2010 online Migration plan, run the following command:

Get-DASP07To10MigrationBlankOnlinePlan [<CommonParameters>]

77



C:\PS>$plan = Get-DASP07To10MigrationBlankOnlinePlan

Get a SharePoint 2007 to 2010 Online Migration Plan

To get a SharePoint 2007 to 2010 online Migration plan, run the following command:

Get-DASP07To10MigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DASP07To10MigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Optional Specifies the name(s) of the existing SharePoint 2007 to

2010 online Migration plan(s) you want to obtain. Wildcards and multiple values are allowed, which should be separated by commas. If no values are entered here, all information of the existing SharePoint 2007 to 2010 online Migration plan(s) will be obtained.

Create a SharePoint 2007 to 2010 Online Migration Plan

To create a new SharePoint 2007 to 2010 online Migration plan, run the following command:

New-DASP07To10MigrationOnlinePlan [-Plan] <SP07To10MigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DASP07To10MigrationBlankOnlinePlan C:\PS>$plan.Name = 'plan1' C:\PS>$plan.Description = 'Description' C:\PS>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' C:\PS>$plan.DestinationFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$plan.SourceAgentGroup = 'AgentGroup07' C:\PS>$plan.DestinationAgentGroup = 'AgentGroup10' C:\PS>$plan.ProfileName = 'Default Profile' C:\PS>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2007:10001/sites/site1','sites/site1', 'list1') C:\PS>$plan.SourceTree.IncludeSPList($list07, $true, $false) C:\PS>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2007:10001/sites/site1','sites/site1', 'list1') C:\PS>$plan.DestinationTree.SelectSPObject($list10) C:\PS>$plan.Action = 'Merge'

78


C:\PS>$plan.AssociatedPlanGroup.Add('plan group1') C:\PS>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true C:\PS>New-DASP07To10MigrationOnlinePlan –Plan $plan


Parameter Type Comment -Plan (or $myPlan) Required Specifies a SharePoint 2007 to 2010 Migration online

plan object.

Delete a SharePoint 2007 to 2010 Online Migration Plan

To delete a SharePoint 2007 to 2010 online Migration plan, run the following command:

Remove-DASP07To10MigrationOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DASP07To10MigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of a SharePoint 2007 to 2010 online

Migration plan that you want to delete. -WhatIf Optional Describes what would happen if you executed the command. -Confirm Optional Prompts you for confirmation before executing the

command.

Run a SharePoint 2007 to 2010 Online Migration Job

To run an existing SharePoint 2007 to 2010 online Migration plan, run the following command:

Run-DASP07To10MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution <SP07To10MigrationConflictResolution> -JobReportType <String> [-Description <String>] [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DASP07To10MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed -Description description -WaitForJobComplete

Or

79


C:\PS>Run-DASP07To10MigrationOnlineJob -PlanName 'plan2' -Options Incremental -IncrementalType 123hour -ConflictResolution Skip -JobReportType Detailed -Description description -WaitForJobComplete –TestRun To configure the command parameters, refer to the following table:

Parameter Type Comment -PlanName Required Specifies the name of an existing SharePoint 2007 to 2010

online Migration plan that you want to run. -Options Required Specifies to run a Full or an Incremental job of the selected

Migration plan. Valid values are “Full” and “Incremental”. -IncrementalType Optional Specifies a schedule to be used for an Incremental

Migration job. Enters the parameter in the format of *Minute *Hour *Day *Week *Month. The * is any number between 1 and 2147483647 followed by a time unit. You cannot specify this parameter unless the value of parameter 'Options' is 'Incremental.'

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during Migration. The valid values are “Skip”, “SkipAndSkip”, “SkipAndOverwrite”, “SkipAndAppend”, “MergeAndSkip”, “MergeAndOverwrite”, and “MergeAndAppend”. For detailed information on each of these values, refer to the note below this table.

-JobReportType Optional Specifies the job report level. The valid values are “Simplified” and “Detailed”.

-Description Optional Specifies the description of the SharePoint 2007 to 2010 online Migration plan that you want to run.



*Note: The following information related to the values in the -ConflictResolution parameter.






80




Update a SharePoint 2007 to 2010 Online Migration Plan

To update an existing SharePoint 2007 to 2010 online migration plan, run the following command:

Update-DASP07To10MigrationOnlinePlan [-Plan] <SP07To10MigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DASP07To10MigrationOnlinePlan -Name 'plan1' C:\PS>$plan.Name = 'plan2' C:\PS>$plan.Description = 'New Description' C:\PS>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' C:\PS>$plan.DestinationFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$plan.SourceAgentGroup = 'AgentGroup07' C:\PS>$plan.DestinationAgentGroup = 'AgentGroup10' C:\PS>$plan.ProfileName = 'Default Profile' C:\PS>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2007:10001/sites/site1','/sites/site1', 'list1') C:\PS>$plan.SourceTree.IncludeSPList($list07, $true, $false) C:\PS>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2010:10001/sites/site1','/sites/site1', 'list1') C:\PS>$plan.DestinationTree.SelectSPObject($list10) C:\PS>$plan.Action = 'Merge' C:\PS>$plan.AssociatedPlanGroup.Add('plan group1') C:\PS>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true C:\PS>Update-DASP07To10MigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a plan name to get an existing SharePoint 2007

to 2010 online migration plan for editing.

Upload a SharePoint 2007 to 2010 Online Migration Profile

To upload a SharePoint 2007 to 2010 online Migration profile, run the following command:

Upload-DASP07To10MigrationOnlineProfile [-Path] <String> [-Overwrite] [<CommonParameters>]

81



C:\PS>Upload-DASP07To10MigrationOnlineProfile -Path 'C:\SP07To10MigrationOnlineProfile1.xml' -Overwrite



Download a SharePoint 2007 to 2010 Online Migration Profile

To download a SharePoint 2007 to 2010 online Migration profile, run the following command:

Download-DASP07To10MigrationOnlineProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DASP07To10MigrationOnlineProfile -Name 'SP07To10MigrationOnlineProfile1' -Path 'C:\SP07To10MigrationOnlineProfile1.xml' -Overwrite




Get-DASP07To13MigrationBlankOnlinePlan

To get a blank SharePoint 2007 to 2013 online migration plan, run the following command:




C:\PS>$plan

82


Get the Plan Settings of a SharePoint 2007 to 2013 Online Migration Plan

To get the plan settings of a SharePoint 2007 to 2013 online migration plan, run the following command:

Get-DASP07To13MigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]




Parameter Type Comment -Name Optional Specifies the name(s) of the existing SharePoint 2007 to

2013 online migration plan(s) you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing SharePoint 2007 to 2013 online migration plan(s) will be obtained.

Create a New SharePoint 2007 to 2013 Online Migration Plan

To create a new SharePoint 2007 to 2013 online migration plan, run the following command:




C:\PS>$plan.Name = 'plan1'

C:\PS>$plan.Description = 'Description'

C:\PS>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)'

C:\PS>$plan.DestinationFarmName = 'Farm(SP2013_DB:SHAREPOINT_CONFIG)'

C:\PS>$plan.SourceAgentGroupName = 'AgentGroup07'

C:\PS>$plan.DestinationAgentGroupName = 'AgentGroup13'

C:\PS>$plan.ProfileName = 'Default Profile'

C:\PS>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2007:10001/sites/site1','sites/site1', 'list1')

C:\PS>$plan.SourceTree.IncludeSPList($list07, $true, $false)

83



C:\PS>$plan.DestinationTree.SelectSPObject($list13)

C:\PS>$plan.Action = 'Merge'

C:\PS>$plan.AssociatedPlanGroup.Add('plan group1')

C:\PS>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true

C:\PS>New-DASP07To13MigrationOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies a SharePoint 2007 to 2013 Migration online plan

object. For more information about the structure and attribute of SP07To13MigrationOnlinePlan, refer to the SDK documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm


To delete a SharePoint 2007 to 2013 online migration plan, run the following command:






migration plan that you want to delete. -WhatIf Optional Describes what would happen if you executed the command


command.


To perform a SharePoint 2007 to 2013 online migration job, run the following command:

84


Run-DASP07To13MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution <SP07To13MigrationConflictResolution> -JobReportType <String> [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DASP07To13MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing SharePoint 2007 to 2013

online migration plan that you want to run. -Options Required Specifies to run a full or an incremental migration job of the

selected migration plan. The valid values are "Full" and "Incremental".

-IncrementalType Optional Specifies a time range for an incremental migration job to only migrate the changes in the specified time period. The format is *Minute, *Hour, *Day, *Week, or *Month. Enter any number between 1 and 2147483647 followed by a time unit. This parameter cannot be specified unless the value of the Option parameter is "Incremental". You cannot specify this parameter unless the value of parameter 'Options' is 'Incremental'.

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". For detailed information on each of these values, refer to the note below this table.

-JobReportType Required Specifies the job report level. The valid values are "Simplified" and "Detailed".


-WaitForJobComplete

Optional Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.




85








To update a SharePoint 2007 to 2013 online migration plan, run the following command:



C:\PS>$plan = Get-DASP07To13MigrationOnlinePlan -Name 'plan1'


C:\PS>$plan.Description = 'New Description'



C:\PS>$plan.SourceAgentGroup = 'AgentGroup07'

C:\PS>$plan.DestinationAgentGroup = 'AgentGroup13'







86




C:\PS>Update-DASP07To13MigrationOnlinePlan -Plan $plan





To upload a SharePoint 2007 to 2013 online migration profile, run the following command:






Download-DASP07To13MigrationOnlineProfile

To download a SharePoint 2007 to 2010 online migration plan, run the following command:






87



Get a Blank SharePoint 2010 to 2013 Online Migration Plan

To get a blank SharePoint 2010 to 2013 online migration plan, run the following command:




Get the Plan Settings of a SharePoint 2010 to 2013 Online Migration Plan

To get the plan settings of a SharePoint 2010 to 2013 online migration plan, run the following command:

The Get-DASP10To13MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint 2010 to 2013 online migration plan(s).




Parameter Type Comment -Name Optional Specifies the name(s) of the existing SharePoint 2010 to 2013

online migration plan(s) you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing SharePoint 2010 to 2013 online migration plan(s) will be obtained.

Create a SharePoint 2010 to 2013 Online Migration Plan

To create a SharePoint 2010 to 2013 online migration plan, run the following command:






88




C:\PS>$plan.SourceAgentGroupName = 'AgentGroup10'

C:\PS>$plan.DestinationAgentGroupName = 'AgentGroup13'









C:\PS>New-DASP10To13MigrationOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies a SharePoint 2010 to 2013 Migration online plan

object. For more information about the structure and attribute of SP10To13MigrationOnlinePlan, refer to the SDK documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm


To delete a SharePoint 2010 to 2013 online migration plan, run the following command:


89






migration plan that you want to delete. -WhatIf Optional Describes what would happen if you executed the command


command.


To run a SharePoint 2010 to 2013 online migration job, run the following command:

Run-DASP10To13MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution <SP10To13MigrationConflictResolution> -JobReportType <String> [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DASP10To13MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing SharePoint 2010 to 2013 online

migration plan that you want to run. -Options Required Specifies to run a full or an incremental migration job of the

selected migration plan. The valid values are "Full" and "Incremental".

-IncrementalType Optional Specifies a time range for an incremental migration job to only migrate the changes in the specified time period. The format is *Minute, *Hour, *Day, *Week, or *Month. Enter any number between 1 and 2147483647 followed by a time unit. This parameter cannot be specified unless the value of the Option parameter is "Incremental". You cannot specify this parameter unless the value of parameter 'Options' is 'Incremental'.

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". For detailed information on each of these values, refer to the note

90


Parameter Type Comment below this table.

-JobReportType Required Specifies the job report level. The valid values are "Simplified" and "Detailed".

-TestRun Optional Specifies whether to simulate the execution of the selected plan. -WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If so, the

job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.










To update a SharePoint 2010 to 2013 online migration plan, run the following command:



C:\PS>$plan = Get-DASP10To13MigrationOnlinePlan -Name 'plan1'


C:\PS>$plan.Description = 'New Description'



91


C:\PS>$plan.SourceAgentGroup = 'AgentGroup10'

C:\PS>$plan.DestinationAgentGroup = 'AgentGroup13'









C:\PS>Update-DASP10To13MigrationOnlinePlan -Plan $plan





To upload a SharePoint 2010 to 2013 online migration profile, run the following command:






92


Download a SharePoint 2010 to 2013 Online Migration Profile

To download a SharePoint online migration plan, run the following command:






Lotus Notes Migration Refer to the section below for more information on the cmdlets’ usage in Lotus Notes Migration.

Get a Blank Lotus Notes Online Migration Plan

To get a blank Lotus Notes online migration plan, run the following command:

Get-DALotusNotesMigrationBlankOnlinePlan [<CommonParameters>]


C:\PS>$plan = Get-DALotusNotesMigrationBlankOnlinePlan

C:\PS>$plan

Get the Plan Settings of a Lotus Notes Online Migration Plan

To get the plan settings of a Lotus Notes online migration plan, run the following command:

Get-DALotusNotesMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DALotusNotesMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Optional Specifies the name(s) of the existing Lotus Notes online migration

93


Parameter Type Comment plan(s) that you want to get information from. Wildcards and multiple values are supported and the multiple values are separated by commas. If no values are entered here, the information of all of the existing Lotus Notes online migration plan(s) will be obtained.

Creates a New Lotus Notes Online Migration Plan

To create a new Lotus Notes online migration plan, run the following command:

New-DALotusNotesMigrationOnlinePlan [-Plan] <LotusNotesMigrationOnlinePlan> [<CommonParameters>


C:\PS>$plan = Get-DALotusNotesMigrationBlankOnlinePlan




C:\PS>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1')

C:\PS>$plan.DestinationTree.SelectSPObject($site1)

C:\PS>$plan.SetSourceInformation('Connection-LotusNotes', 'Local')

C:\PS>$NotesObject = New-Object DocAve.API.Migration.LotusNotesMigration.LotusNotesDatabase("dommon.nsf")

C:\PS>$plan.SourceTree.Include($NotesObject)

C:\PS>New-DALotusNotesMigrationOnlinePlan $plan


Parameter Type Comment -Plan Required Specifies a Lotus Notes online Migration plan object. For more

information about the structure and attribute of LotusNotesMigrationOnlinePlan, refer to the SDK documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\

94


Parameter Type Comment DocAveModule\DocAveSDK.chm

Delete a Lotus Notes Online Migration Plan

To delete a Lotus Notes online migration plan, run the following command:

Remove-DALotusNotesMigrationOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DALotusNotesMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of a Lotus Notes online migration plan that

you want to delete. -WhatIf Optional Describes what would happen if you executed the command

without actually executing the command. -Confirm Optional Prompts you for confirmation before executing the command.

Run a Lotus Notes Online Migration Job

To perform a Lotus Notes online migration plan, run the following command:

Run-DALotusNotesMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <LotusNotesMigrationConflictResolution> [-RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DALotusNotesMigrationOnlineJob -PlanName 'plan1' -Options Incremental -ConflictResolution Skip -RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Lotus Notes

online migration plan that you want to run. -Options Required Specifies to run a full or an incremental

migration job of the selected migration plan. Valid values are "Full" and "Incremental".

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip",

95


Parameter Type Comment "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". For detailed information on each of these values, refer to the note below this table.

-RemigrateObjectsWithException Optional Specifies whether or not to re-migrate the objects whose metadata/securities failed to be migrated in the last migration job. This parameter is available only when the migration option is "Incremental" and the Content level conflict resolution is not "Skip".

-IgnoreMetadataAndSecurityExceptions Optional Specifies whether or not to ignore the metadata/security exceptions. 'True' means not to take them into consideration for the job status; 'False' means to take them into consideration for the job status.











96


Update a Lotus Notes Online Migration Plan

To update a Lotus Notes online migration plan, run the following command:

Update-DALotusNotesMigrationOnlinePlan [-Plan] <LotusNotesMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DALotusNotesMigrationOnlinePlan -Name 'plan1'




C:\PS>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1')

C:\PS>$plan.DestinationTree.SelectSPObject($site1)

C:\PS>$plan.SetSourceInformation('Connection-LotusNotes', 'Local')

C:\PS>$NotesObject = New-Object DocAve.API.Migration.LotusNotesMigration.LotusNotesDatabase("dommon.nsf")

C:\PS>$plan.SourceTree.Include($NotesObject)

C:\PS>Update-DALotusNotesMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies the plan name to get an existing Lotus Notes online

migration plan for editing.

Upload a Lotus Notes Online Migration Options Profile

To upload a Lotus Notes online migration options profile, run the following command:

Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite

97




Upload a Lotus Notes Online Migration Mapping Options Profile

To upload a Lotus Notes online migration mapping options profile, run the following command:

Upload-DALotusNotesMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DALotusNotesMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite



Download a Lotus Notes Online Migration Options Profile

To download a Lotus Notes online migration options profile, run the following command:

Download-DALotusNotesMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DALotusNotesMigrationOnlineMigrationOptionsProfile -Name 'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite

To configure the command parameters, see the table below:


Download a Lotus Notes Online Migration Mapping Options Profile

To download a Lotus Notes online migration mapping options profile, run the following command:

Download-DALotusNotesMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]

98



C:\PS>Download-DALotusNotesMigrationOnlineMappingOptionsProfile -Name 'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite



eRoom Migration Refer to the section below for more information on the cmdlets’ usage in eRoom Migration.

Get a Blank eRoom Online Migration Plan

To get a blank eRoom online migration plan, run the following command:

Get-DAERoomMigrationBlankOnlinePlan [<CommonParameters>]


C:\PS>$plan = Get-DAERoomMigrationBlankOnlinePlan

C:\PS>$plan

Get the Plan Settings of an eRoom Online Migration Plan

To get an eRoom online migration plan, run the following command:

Get-DAERoomMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAERoomMigrationOnlinePlan -Name 'plan01'


Parameter Type Comment -Name Optional Specifies the name(s) of the existing eRoom online migration

plan(s) that you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, The information of all of the existing eRoom online migration plan(s) will be obtained.

99


Create a New eRoom Online Migration Plan

To create an eRoom online migration plan, run the following command:

New-DAERoomMigrationOnlinePlan [-Plan] <ERoomMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAERoomMigrationBlankOnlinePlan C:\PS>$plan.Name = 'plan1' C:\PS>$plan.Description = 'this is an eRoom plan' C:\PS>$plan.SourceAgentName = 'agent-eroom' C:\PS>$item = New-Object DocAve.API.Migration.ERoomMigration.ERoomItem('Community01','Facility01','Room01','0_9f7') C:\PS>$room = New-Object DocAve.API.Migration.ERoomMigration.ERoomRoom('Community01','Facility01','Room02') C:\PS>$facility = New-Object DocAve.API.Migration.ERoomMigration.ERoomFacility('Community01','Facility02') C:\PS>$community = New-Object DocAve.API.Migration.ERoomMigration.ERoomCommunity('Community02) C:\PS>$plan.SourceTree.Include($item) C:\PS>$plan.SourceTree.IncludeHomeFolder($room) C:\PS>$plan.SourceTree.Include($facility) C:\PS>$plan.SourceTree.Exclude($community) C:\PS>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/') C:\PS>$plan.DestinationTree.SelectSPObject($webapp10) C:\PS>$plan.ProfileName = 'Default Profile' C:\PS>$plan.AssociatedPlanGroup.Add('plan01') C:\PS>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true C:\PS>New-DAERoomMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies an eRoom online migration plan object. For more

information about the structure and attribute of ERoomMigrationOnlinePlan, refer to the SDK documentation at the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

100


Delete an eRoom Online Migration Plan

To delete an eRoom online migration plan, run the following command:

Remove-DAERoomMigrationOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DAERoomMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of an eRoom online migration plan that



command.

Run an eRoom Online Migration Job

To perform an eRoom online migration job, run the following command:

Run-DAERoomMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <ERoomMigrationConflictResolution> [-RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAERoomMigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -IgnoreMetadataAndSecurityExceptions


Parameter Type Comment -PlanName Required Specifies the name of an existing eRoom



101


Parameter Type Comment -ConflictResolution Optional Specifies a conflict resolution to handle

conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". For detailed information on each of these values, refer to the note below this table.














102


Update an eRoom Online Migration Plan

To update an eRoom online migration plan, run the following command:

Update-DAERoomMigrationOnlinePlan [-Plan] <ERoomMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAERoomMigrationOnlinePlan -Name 'plan1'


C:\PS>$plan.Description = 'this is an eRoom plan'

C:\PS>$plan.SourceAgentName = 'agent-eroom'

C:\PS>$item = New-Object DocAve.API.Migration.ERoomMigration.ERoomItem('Community01','Facility01','Room01','0_9f7')

C:\PS>$room = New-Object DocAve.API.Migration.ERoomMigration.ERoomRoom('Community01','Facility01','Room02')

C:\PS>$facility = New-Object DocAve.API.Migration.ERoomMigration.ERoomFacility('Community01','Facility02')

C:\PS>$community = New-Object DocAve.API.Migration.ERoomMigration.ERoomCommunity('Community02’)

C:\PS>$plan.SourceTree.Include($item)

C:\PS>$plan.SourceTree.IncludeHomeFolder($room)

C:\PS>$plan.SourceTree.Include($facility)

C:\PS>$plan.SourceTree.Exclude($community)

C:\PS>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http: //SharePoint2010:10001/')

C:\PS>$plan.DestinationTree.SelectSPObject($webapp10)


C:\PS>$plan.AssociatedPlanGroup.Add('plan01')

C:\PS>Update-DAERoomMigrationOnlinePlan -Plan $plan

103



Parameter Type Comment -Plan Required Specifies an existing eRoom online migration plan for editing.

Upload an eRoom Online Migration Options Profile

To upload an eRoom online migration options profile, run the following command:

Upload-DAERoomMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DAERoomMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite



Upload an eRoom Online Migration Mapping Options Profile

To upload an eRoom online migration mapping options profile, run the following command:

Upload-DAERoomMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DAERoomMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite



Download an eRoom Online Migration Options Profile

To download an eRoom online migration options profile, run the following command:

Download-DAERoomMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


104


C:\PS>Download-DAERoomMigrationOnlineMigrationOptionsProfile -Name 'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite



Download eRoom Online Migration Mapping Options Profile

To download an eRoom online migration mapping options profile, run the following command:

Download-DAERoomMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAERoomMigrationOnlineMappingOptionsProfile -Name 'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite



Livelink Migration Refer to the section below for more information on the cmdlets’ usage in Livelink Migration.

Get a Blank Livelink Online Migration Plan

To get a blank Livelink online migration plan, run the following command:

Get-DALivelinkMigrationBlankOnlinePlan [<CommonParameters>]


C:\PS>$plan = Get-DALivelinkMigrationBlankOnlinePlan

C:\PS>$plan

Get the Plan Settings of a Livelink Online Migration Plan

To get the plan settings of a Livelink online migration plan, run the following command:

105


Get-DALivelinkMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]

An example of the command is: C:\PS>Get-DALivelinkMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Optional Specifies the name(s) of the existing Livelink online migration

plan(s) that you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing Livelink online migration plan(s) will be obtained.

Create a New Livelink Online Migration Plan

To create a new Livelink online migration plan, run the following command:

New-DALivelinkMigrationOnlinePlan [-Plan] <LivelinkMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DALivelinkMigrationBlankOnlinePlan


C:\PS>$plan.Description = 'this is a livelink plan'

C:\PS>$plan.ProfileName = 'Default profile'

C:\PS>$plan.AssociatedPlanGroup.Add('PlanGroup01')

C:\PS>$plan.ConnectionName = 'livelink'

C:\PS>$item1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkItem('Admin','item01','EnterpriseWorkspace')

C:\PS>$path = 'Folder', 'Folder01', ' Folder02'

C:\PS>$container1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkContainer('Admin',$path,'EnterpriseWorkspace')

C:\PS>$container2 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkContainer('DomainA/user01',$null,'PersonalWorkspace')

C:\PS>$plan.SourceTree.Include($item1)

C:\PS>$plan.SourceTree.Include($container1)

C:\PS>$plan.SourceTree.Exclude($container2)

106


C:\PS>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/')


C:\PS>$plan.ProjectMigrationSelection = 'MigrateProjectAsSiteCollection'


C:\PS>New-DALivelinkMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a Livelink Migration online plan object. For more

information about the structure and attribute of LivelinkMigrationOnlinePlan, refer to the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

Delete a Livelink Online Migration Plan

To delete a Livelink online migration plan, run the following command:

Remove-DALivelinkMigrationOnlinePlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


C:\PS>Remove-DALivelinkMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of a Livelink online migration plan that


without actually executing the command. -Confirm Required Prompts you for confirmation before executing the

command.

Run a Livelink Online Migration Job

To run a Livelink online migration job, run the following command:

107


Run-DALivelinkMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <LivelinkMigrationConflictResolution> [-TestRun] [-RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DALivelinkMigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -WaitForJobComplete -IgnoreMetadataAndSecurityExceptions


Parameter Type Comment -PlanName Required Specifies the name of an existing Livelink



-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". For detailed information on each of these values, refer to the note below this table.








108








Update a Livelink Online Migration Plan

To update a Livelink online migration plan, run the following command:

Update-DALivelinkMigrationOnlinePlan [-Plan] <LivelinkMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DALivelinkMigrationOnlinePlan -Name 'plan1'


C:\PS>$plan.Description = 'this is a livelink plan'

C:\PS>$plan.ProfileName = 'Default profile'

C:\PS>$plan.AssociatedPlanGroup.Add('PlanGroup01')

C:\PS>$plan.ConnectionName = 'livelink'

C:\PS>$item1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkItem('Admin','item01','EnterpriseWorkspace')

C:\PS>$path = 'Folder', 'Folder01', ' Folder02'

C:\PS>$container1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkContainer('Admin',$path,'EnterpriseWorkspace')

C:\PS>$container2 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkContainer('DomainA/user01',$null,'PersonalWorkspace')

C:\PS>$plan.SourceTree.Include($item1)

109


C:\PS>$plan.SourceTree.Include($container1)

C:\PS>$plan.SourceTree.Exclude($container2)

C:\PS>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/')


C:\PS>$plan.ProjectMigrationSelection = 'MigrateProjectAsSiteCollection'


C:\PS>Update-DALivelinkMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a plan name to get an existing Livelink online

migration plan for editing.

Upload a Livelink Online Migration Options Profile

To upload a Livelink online migration options profile, run the following command:

Upload-DALivelinkMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DALivelinkMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' –Overwrite



Upload a Livelink Online Migration Mapping Options Profile

To upload a Livelink online migration mapping options profile, run the following command:

Upload-DALivelinkMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


110


C:\PS>Upload-DALivelinkMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite



Download a Livelink Online Migration Options Profile

To download a Livelink online migration options profile, run the following command:

Download-DALivelinkMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DALivelinkMigrationOnlineMigrationOptionsProfile -Name 'migrationOptionsProfile' -Path 'C:\profile.xml' –Overwrite



Download a Livelink Online Migration Mapping Options Profile

To download a Livelink online migration mapping options profile, run the following command:

Download-DALivelinkMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DALivelinkMigrationOnlineMappingOptionsProfile -Name 'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite



111


Exchange Public Folder Migration Refer to the section below for more information on the cmdlets’ usage in Exchange Public Folder Migration.

Get a Blank Exchange Public Folder Online Migration Plan

To get a blank Exchange Public Folder online migration plan, run the following command:

Get-DAExchangePublicFolderMigrationBlankOnlinePlan [<CommonParameters>]


C:\PS>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan

C:\PS>$plan

Get the Plan Settings of an Exchange Public Folder Online Migration Plan

To get the plan settings of an Exchange Public Folder online migration plan, run the following command:

Get-DAExchangePublicFolderMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1'


Parameter Type Comment -Name Optional Specifies the names of the existing Exchange Public Folder

online migration plans you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing Exchange Public Folder online migration plans will be obtained.

Create a New Exchange Public Folder Online Migration Plan

To create a new Exchange Public Folder online migration plan, run the following command:

New-DAExchangePublicFolderMigrationOnlinePlan [-Plan] <ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan


112



C:\PS>$plan.ProfileName = "Default Profile"

C:\PS>$planGroup = New-Object System.Collections.Generic.List[string]

C:\PS>$planGroup.Add('PlanGroup1')

C:\PS>$plan.AssociatedPlanGroup = $planGroup

C:\PS>$plan.ConnectionName = "Connection1"


C:\PS>$sourceNode = New-Object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangeFolder("MailFolder1")

C:\PS>$farmName = "Farm(SP2010_DB:SHAREPOINT_CONFIG)"

C:\PS>$destinationNode = new-object docave.api.objects.sharepointweb($farmName, "http://SharePoint2010:10001/sites/site1", "")

C:\PS>$plan.SourceTree.Include($sourceNode)

C:\PS>$plan.DestinationTree.SelectSPObject($destinationNode)

C:\PS>New-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies an Exchange Public Folder Migration online plan

object. For more information about the structure and attribute of Exchange Public Folder migration online plan, refer to the following path: Double-click the help file named DocAve SDK Documentation to view this information. You can also find the help file in the following path: \AvePoint\DocAve6\Shell\DocAveModules\ DocAveModule\DocAveSDK.chm

Delete an Exchange Public Folder Online Migration Plan

To delete an Exchange Public Folder online migration plan, run the following command:

Remove-DAExchangePublicFolderMigrationOnlinePlan [-Name] <String> [<CommonParameters>]


C:\PS>Remove-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1'

113



Parameter Type Comment -Name Required Specifies the name of an Exchange Public Folder online

migration plan that you want to delete.

Run an Exchange Public Folder Online Migration Job

To run an Exchange Public Folder online migration job, run the following command:

Run-DAExchangePublicFolderMigrationOnlineJob [-PlanName] <String> -Options<String> -ConflictResolution <ExchangePublicFolderMigrationConflictResolution> [-TestRun] [-RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAExchangePublicFolderMigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip –WaitForJobComplete -RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions


Parameter Type Comment -PlanName Required Specifies the name of an existing Exchange

Public Folder online migration plan that you want to run.

-Options Required Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental".

-ConflictResolution Required Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "MergeAndSkip", and "MergeAndOverwrite". For detailed information on each of these values, refer to the note below this table.



114


Parameter Type Comment -IgnoreMetadataAndSecurityExceptions









Update an Exchange Public Folder Online Migration Plan

To update an Exchange Public Folder online migration plan, run the following command:

Update-DAExchangePublicFolderMigrationOnlinePlan [-Plan] <ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>]


C:\PS>$plan = Get-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1'



C:\PS>$plan.ProfileName = "Default Profile"

C:\PS>$planGroup = New-Object System.Collections.Generic.List[string]

C:\PS>$planGroup.Add('PlanGroup1')

C:\PS>$plan.AssociatedPlanGroup = $planGroup

115


C:\PS>$plan.ConnectionName = "Connection1"

C:\PS>$sourceNode = New-Object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangeFolder("MailFolder1")

C:\PS>$farmName = "Farm(SP2010_DB:SHAREPOINT_CONFIG)"

C:\PS>$destinationNode = new-object docave.api.objects.sharepointweb($farmName, "http://SharePoint2010:10001/sites/site1", "")

C:\PS>$plan.SourceTree.Include($sourceNode)

C:\PS>$plan.DestinationTree.SelectSPObject($destinationNode)

C:\PS>Update-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan


Parameter Type Comment -Plan Required Specifies an existing Exchange Public Folder online migration

plan for editing.

Upload an Exchange Public Folder Online Migration Options Profile

To upload an Exchange Public Folder online migration options profile, run the following command:

Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile [-Path]<String> [-Overwrite] [<CommonParameters>]


C:\PS>Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite



Upload an Exchange Public Folder Online Migration Mapping Options Profile

To upload an Exchange Public Folder online migration mapping options profile, run the following command:

Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>]


116


C:\PS>Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite



Download an Exchange Public Folder Online Migration Options Profile

To download an Exchange Public Folder online migration options profile, run the following command:

Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Name 'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite



Download an Exchange Public Folder Online Migration Mapping Options Profile

To download an Exchange Public Folder online migration mapping options profile, run the following command:

Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [-Name]<String> [-Path] <String> [-Overwrite] [<CommonParameters>]


C:\PS>Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Name 'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite



117


Data Protection Refer to the section below for more information on the cmdlets’ usage in Data Protection.

Granular Backup and Restore Refer to the section below for more information on the cmdlets’ usage in Granular Backup and Restore.

Obtain a Blank Granular Backup Blank Plan

To get a blank Granular Backup blank plan, run the following command:

Get-DAGranularBackupBlankPlan [<CommonParameters>]


C:\PS>Get-DAGranularBackupBlankPlan

Obtain a Granular Backup Plan’s Configuration Details

To get the configurations of an existing Granular Backup plan, run the following command:

Get-DAGranularBackupPlan [[-Name] <String[]>] [<CommonParameters>]


C:\PS>Get-DAGranularBackupPlan -Name 'plan1'


Parameter Type Comment -Name Optional Specifies one or more plans' names. You can type multiple plan

names (separated by commas). Wildcards are supported.

Create a Granular Backup Plan

To create a Granular Backup plan, run the following command:

New-DAGranularBackupPlan [-Plan] <GranularBackupPlan> [<CommonParameters>]


C:\PS>$plan = Get-DAGranularBackupBlankPlan C:\PS>$plan.Name = 'plan1' C:\PS>$plan.Description = 'description' C:\PS>$plan.StoragePolicyName = 'storage policy1' C:\PS>$plan.AgentGroupName = "DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)"

118


C:\PS> C:\PS>$site1 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1') C:\PS>$plan.Tree.IncludeSPObject($site1) C:\PS> C:\PS>New-DAGranularBackupPlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a Granular Backup plan object.

Run a Granular Backup Plan

To run an existing Granular Backup plan, run the following command:

Run-DAGranularBackupJob [-PlanName] <String> -BackupJobType <RunGranularBackupPlanType> -JobReportType <String> [-TestRun] [-WaitForJobComplete] [<CommonParameters>]

The example of the command is：

C:\PS>Run-DAGranularBackupJob -PlanName 'plan1' -BackupJobType full -JobReportType Detailed -WaitForJobComplete


Parameter Type Comment -PlanName Required Specifies the name of an existing Granular Backup plan

that you want to run. -BackupJobType Required Specifies the type of backup. Valid values are “Full”,

“Incremental”, and “Differential”. -JobReportType -JobReportType Specifies the job report level. Valid values are “Simplified”

and “Detailed”. -TestRun Optional Specifies whether to simulate the execution of the

selected plan. -WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If


Delete Granular Backup Plan

To delete a Granular Backup plan, run the following command:

Remove-DAGranularBackupPlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

119



C:\PS>Remove-DAGranularBackupPlan -Name 'plan1'


Parameter Type Comment -Name Required Specifies the name of plan to be removed. -WhatIf Optional Describes what would happen if you executed the

command. -Confirm Optional Prompts you for confirmation before executing

the command.

Update the Configurations of a Granular Backup Plan

To update the configurations of an existing Granular Backup plan, run the following command:

Update-DAGranularBackupPlan [-Plan] <GranularBackupPlan> [<CommonParameters>]


C:\PS>$plan = Get-DAGranularBackupPlan -Name 'plan1' C:\PS>$plan.Name = 'plan2' C:\PS>Update-DAGranularBackupPlan -Plan $plan


Parameter Type Comment -Plan Required Specifies a Granular Backup plan object.

Platform Backup and Restore Refer to the section below for more information on the cmdlets’ usage in Platform Backup and Restore.

Run a Platform Backup Plan

To run an existing Platform Backup plan, run the following command:

Run-DAPlatformBackupJob [-PlanName] <String> -BackupType <PRBackupType> [-CopyDataFromSnapshotToMediaServer] [-DeferCopyingDataFromPersistentSnapshot] [-DeferGeneratingInstaMountMapping] -RestoreGranularityLevel <PlatformRestoreGranularityLevel> [-DeferGenerationGranularRestoreIndex] [-WaitForJobComplete] [<CommonParameters>]


C:\PS>Run-DAPlatformBackupJob -PlanName 'plan1' -BackupType Full -RestoreGranularityLevel ItemLevel

120



Parameter Type Comment -PlanName Required Specifies the name of an existing Platform

Backup plan that you want to run. -BackupType Required Specifies the type of backup. Valid values

are “Full”, “Incremental”, and “Differential”.

-CopyDataFromSnapshotToMediaServer Optional Specifies whether to copy data from snapshot to media server.

-DeferCopyingDataFromPersistentSnapshot Optional Specifies whether to defer copy data from persistent snapshot.

-DeferGeneratingInstaMountMapping Optional Specifies whether to defer generate InstaMount mapping.

-RestoreGranularityLevel Required Specifies the restore granularity level. Valid values are “SiteCollectionLevel”, “SiteLevel”, “FolderLevel”, “ItemLevel”, “ItemVersionLevel”, and “None”.

-DeferGenerationGranularRestoreIndex Optional Specifies whether to defer generate granular restore index.


121


Notices and Copyright Information Notice The materials contained in this publication are owned or provided by AvePoint, Inc. and are the property of AvePoint or its licensors, and are protected by copyright, trademark and other intellectual property laws. No trademark or copyright notice in this publication may be removed or altered in any way.

Copyright Copyright © 2012-2013 AvePoint, Inc. All rights reserved. All materials contained in this publication are protected by United States copyright law and no part of this publication may be reproduced, modified, displayed, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent of AvePoint, 3 Second Street, Jersey City, NJ 07311, USA or, in the case of materials in this publication owned by third parties, without such third party’s consent.

Trademarks AvePoint®, DocAve®, the AvePoint logo, and the AvePoint Pyramid logo are registered trademarks of AvePoint, Inc. with the United States Patent and Trademark Office. These registered trademarks, along with all other trademarks of AvePoint used in this publication are the exclusive property of AvePoint and may not be used without prior written consent.

Microsoft, MS-DOS, Internet Explorer, Microsoft Office SharePoint Servers 2007/2010/2013, SharePoint Portal Server 2003, Windows SharePoint Services, Windows SQL server, and Windows are either registered trademarks or trademarks of Microsoft Corporation.

Adobe Acrobat and Acrobat Reader are trademarks of Adobe Systems, Inc.

All other trademarks contained in this publication are the property of their respective owners and may not be used such party’s consent.

Changes The material in this publication is for information purposes only and is subject to change without notice. While reasonable efforts have been made in the preparation of this publication to ensure its accuracy, AvePoint makes no representation or warranty, expressed or implied, as to its completeness, accuracy, or suitability, and assumes no liability resulting from errors or omissions in this publication or from the use of the information contained herein. AvePoint reserves the right to make changes in the Graphical User Interface of the AvePoint software without reservation and without notification to its users.

AvePoint, Inc. Harborside Financial Center, Plaza 10 3 Second Street, 9th Floor Jersey City, New Jersey 07311 USA