SDK and Management Shell User Guide - AvePoint · 2017-05-01 · SDK and Management Shell User...

DocAve® 6

SDK and Management Shell

User Guide

Service Pack 4, Cumulative Update 3

Revision M

Issued September 2014

2

DocAve 6: SDK and Management Shell

Table of Contents

About SDK and Management Shell ........................................................................................................ 11

Configuration .................................................................................................................................... 11

Agents ............................................................................................................................................... 11

Getting Started ...................................................................................................................................... 12

Environment Requirement ................................................................................................................ 12

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

Supported Features in DocAve SDK .................................................................................................... 13

Breaking Changes in DocAve SDK ....................................................................................................... 17

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

Logging into DocAve .......................................................................................................................... 21

Invoking the Granular Backup Service ................................................................................................ 21

Creating a New Plan .......................................................................................................................... 21

Getting Plans ..................................................................................................................................... 23

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

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

Updating an Existing Granular Backup Plan ........................................................................................ 23

Running a Granular Backup Plan ........................................................................................................ 24

Getting Job Information ..................................................................................................................... 24

Downloading Job Report.................................................................................................................... 24

Completing a Granular Backup Process .............................................................................................. 25

DocAve 6 Management Shell ................................................................................................................. 29

Installation ........................................................................................................................................ 29

Access DocAve 6 Management Shell .................................................................................................. 30

Upgrading DocAve SDK and Management Shell ..................................................................................... 31

DocAve Management Shell Cmdlet Reference ....................................................................................... 32

Log Into DocAve Manager .................................................................................................................. 32

Login-DAManager .......................................................................................................................... 32

Log Out of DocAve Manager .............................................................................................................. 35

Logout-DAManager........................................................................................................................ 35

3


Administrator .................................................................................................................................... 36

Get-DASPBlankSecuritySearchSetting............................................................................................. 36

Search-DASPPermission ................................................................................................................. 37

Get-DASPBlankCloneUserPermissionSetting .................................................................................. 40

Clone-DASPUserPermission ........................................................................................................... 41

Get-DASPBlankCloneGroupPermissionSetting ................................................................................ 44

Clone-DASPGroupPermission ......................................................................................................... 45

Scan-DASPDeadAccount ................................................................................................................ 48

Remove-DASPDeadAccount ........................................................................................................... 51

Check-DASPInheritingPermissions .................................................................................................. 53

Stop-DASPInheritingPermissions .................................................................................................... 56

Content Manager .............................................................................................................................. 59

Get-DAContentManagerOnlinePlan ............................................................................................... 59

Get-DAContentManagerBlankOnlinePlan ....................................................................................... 61

New-DAContentManagerOnlinePlan .............................................................................................. 64

Update-DAContentManagerOnlinePlan ......................................................................................... 66

Remove-DAContentManagerOnlinePlan ........................................................................................ 67

Run-DAContentManagerCopyJob................................................................................................... 69

Run-DAContentManagerExportJob ................................................................................................ 70

Run-DAContentManagerImportJob ................................................................................................ 72

Run-DAContentManagerMoveJob.................................................................................................. 73

Get-DAContentManagerJobConfigurationDetail............................................................................. 75

Get-DAContentManagerJobSecurityDetail ..................................................................................... 78

Deployment Manager ........................................................................................................................ 82

Get-DADeploymentManagerPlan ................................................................................................... 82

Get-DADeploymentManagerBlankPlan .......................................................................................... 83

New-DADeploymentManagerPlan ................................................................................................. 84

Update-DADeploymentManagerPlan ............................................................................................. 89

Remove-DADeploymentManagerPlan ............................................................................................ 90

Run-DADeploymentManagerJob .................................................................................................... 92

Replicator .......................................................................................................................................... 93

Run-DAReplicatorOnlineJob ........................................................................................................... 93

4


Run-DAReplicatorExportJob ........................................................................................................... 96

Run-DAReplicatorImportJob .......................................................................................................... 99

BLOB Provider ................................................................................................................................. 100

Get-DABLOBProviderBinariesInfo ................................................................................................. 100

Get-DAStubDBConfiguration ........................................................................................................ 102

Configure-DAStubDB.................................................................................................................... 103

Get-DABLOBProviderConfiguration .............................................................................................. 106

Save-DABLOBProviderConfiguration ............................................................................................ 107

Archiver ........................................................................................................................................... 113

Run-DAArchiverJob ...................................................................................................................... 113

Run-DAArchiverIndexJob ............................................................................................................. 115

Get-DAArchiverIndexDataInfo ...................................................................................................... 115

Get-DAArchiverJobDetailForBackup ............................................................................................. 117

Get-DAArchiverJobDetailForDeletion ........................................................................................... 119

Set-DAArchiverIndexDataInfo ...................................................................................................... 122

Storage Manager ............................................................................................................................. 123

Export-DABLOBTraceOfStub ........................................................................................................ 123

New-DARemapStorageManagerLogicalDeviceConfiguration ........................................................ 125

Remap-DAStorageManagerLogicalDevice..................................................................................... 127

Real-Time Storage Manager............................................................................................................. 129

Get-DARealtimeStorageManagerRule .......................................................................................... 129

Get-DARealtimeStorageManagerBlankRule.................................................................................. 133

New-DARealtimeStorageManagerRule......................................................................................... 134

Update-DARealtimeStorageManagerRule .................................................................................... 135

Remove-DARealtimeStorageManagerRule ................................................................................... 136

Reuse-DARealtimeStorageManagerRule ...................................................................................... 137

Retract-DARealtimeStorageManagerRule .................................................................................... 138

SharePoint Migration....................................................................................................................... 140

Get-DASPMigrationJobObjectsDetail............................................................................................ 140

Get-DASPMigrationJobConfigurationDetail .................................................................................. 143

Get-DASPMigrationJobPermissionDetail ...................................................................................... 146

SharePoint 2007 to 2010 Migration ................................................................................................. 149

5


Get-DASP07To10MigrationOnlinePlan ......................................................................................... 149

Get-DASP07To10MigrationBlankOnlinePlan................................................................................. 151

New-DASP07To10MigrationOnlinePlan........................................................................................ 153

Update-DASP07To10MigrationOnlinePlan ................................................................................... 155

Remove-DASP07To10MigrationOnlinePlan .................................................................................. 157

Run-DASP07To10MigrationOnlineJob .......................................................................................... 158

Get-DASP07To10MigrationJobConfigurationDetail ...................................................................... 162

Get-DASP07To10MigrationJobObjectsDetail ................................................................................ 165

Get-DASP07To10MigrationJobPermissionDetail ........................................................................... 168

Download-DASP07To10MigrationOnlineProfile ........................................................................... 170

Upload-DASP07To10MigrationOnlineProfile ................................................................................ 172



















Lotus Notes Migration ..................................................................................................................... 203

Get-DALotusNotesMigrationOnlinePlan ....................................................................................... 203

Get-DALotusNotesMigrationBlankOnlinePlan .............................................................................. 205

6


New-DALotusNotesMigrationOnlinePlan ..................................................................................... 206

Update-DALotusNotesMigrationOnlinePlan ................................................................................. 210

Remove-DALotusNotesMigrationOnlinePlan ................................................................................ 211

Run-DALotusNotesMigrationOnlineJob ........................................................................................ 212

Download-DALotusNotesMigrationOnlineMappingOptionsProfile ............................................... 215

Upload-DALotusNotesMigrationOnlineMappingOptionsProfile .................................................... 216

Download-DALotusNotesMigrationOnlineMigrationOptionsProfile .............................................. 217

Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile .................................................. 218

File System Migration ...................................................................................................................... 219

Get-DAFileSystemMigrationOnlinePlan ........................................................................................ 219

Get-DAFileSystemMigrationBlankOnlinePlan ............................................................................... 221

New-DAFileSystemMigrationOnlinePlan ...................................................................................... 223

Generate-DAFileSystemMigrationMetadataFile ........................................................................... 226

Update-DAFileSystemMigrationOnlinePlan .................................................................................. 227

Remove-DAFileSystemMigrationOnlinePlan ................................................................................. 228

Run-DAFileSystemMigrationOnlineJob ......................................................................................... 230

Download-DAFileSystemMigrationOnlineMappingOptionsProfile ................................................ 232

Upload-DAFileSystemMigrationOnlineMappingOptionsProfile ..................................................... 233

Download-DAFileSystemMigrationOnlineMigrationOptionsProfile ............................................... 234

Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile ................................................... 235

Livelink Migration ............................................................................................................................ 236

Get-DALivelinkMigrationOnlinePlan ............................................................................................. 236

Get-DALivelinkMigrationBlankOnlinePlan .................................................................................... 239

New-DALivelinkMigrationOnlinePlan ........................................................................................... 240

Update-DALivelinkMigrationOnlinePlan ....................................................................................... 243

Remove-DALivelinkMigrationOnlinePlan ...................................................................................... 245

Run-DALivelinkMigrationOnlineJob .............................................................................................. 246

Download-DALivelinkMigrationOnlineMappingOptionsProfile ..................................................... 249

Upload-DALivelinkMigrationOnlineMappingOptionsProfile .......................................................... 250

Download-DALivelinkMigrationOnlineMigrationOptionsProfile .................................................... 251

Upload-DALivelinkMigrationOnlineMigrationOptionsProfile ........................................................ 252

eRoom Migration ............................................................................................................................ 253

7


Get-DAERoomMigrationOnlinePlan ............................................................................................. 253

Get-DAERoomMigrationBlankOnlinePlan ..................................................................................... 255

New-DAERoomMigrationOnlinePlan ............................................................................................ 257

Update-DAERoomMigrationOnlinePlan........................................................................................ 260

Remove-DAERoomMigrationOnlinePlan ...................................................................................... 262

Run-DAERoomMigrationOnlineJob .............................................................................................. 263

Download-DAERoomMigrationOnlineMappingOptionsProfile ...................................................... 265

Upload-DAERoomMigrationOnlineMappingOptionsProfile .......................................................... 266

Download-DAERoomMigrationOnlineMigrationOptionsProfile .................................................... 267

Upload-DAERoomMigrationOnlineMigrationOptionsProfile ......................................................... 269

Exchange Public Folder Migration .................................................................................................... 270

Get-DAExchangePublicFolderMigrationOnlinePlan....................................................................... 270

Get-DAExchangePublicFolderMigrationBlankOnlinePlan .............................................................. 272

New-DAExchangePublicFolderMigrationOnlinePlan ..................................................................... 274

Update-DAExchangePublicFolderMigrationOnlinePlan ................................................................. 278

Remove-DAExchangePublicFolderMigrationOnlinePlan ............................................................... 279

Run-DAExchangePublicFolderMigrationOnlineJob........................................................................ 280

Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile ............................... 283

Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile.................................... 284

Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile ............................. 285

Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile .................................. 286

EMC Documentum Migration .......................................................................................................... 287

Get-DADocumentumMigrationOnlinePlan ................................................................................... 287

Get-DADocumentumMigrationBlankOnlinePlan ........................................................................... 290

New-DADocumentumMigrationOnlinePlan .................................................................................. 291

Update-DADocumentumMigrationOnlinePlan ............................................................................. 294

Remove-DADocumentumMigrationOnlinePlan ............................................................................ 296

Run-DADocumentumMigrationOnlineJob .................................................................................... 297

Download-DADocumentumMigrationOnlineMappingOptionsProfile............................................ 299

Upload-DADocumentumMigrationOnlineMappingOptionsProfile ................................................ 300

Download-DADocumentumMigrationOnlineMigrationOptionsProfile .......................................... 302

Upload-DADocumentumMigrationOnlineMigrationOptionsProfile ............................................... 303

8


Quickr Migration ............................................................................................................................. 304

Get-DAQuickrMigrationOnlinePlan .............................................................................................. 304

Get-DAQuickrMigrationBlankOnlinePlan ...................................................................................... 306

New-DAQuickrMigrationOnlinePlan ............................................................................................. 308

Update-DAQuickrMigrationOnlinePlan ........................................................................................ 311

Remove-DAQuickrMigrationOnlinePlan ....................................................................................... 312

Run-DAQuickrMigrationOnlineJob ............................................................................................... 313

Download-DAQuickrMigrationOnlineMappingOptionsProfile ....................................................... 316

Upload-DAQuickrMigrationOnlineMappingOptionsProfile ........................................................... 317

Download-DAQuickrMigrationOnlineMigrationOptionsProfile ..................................................... 318

Upload-DAQuickrMigrationOnlineMigrationOptionsProfile .......................................................... 319

Granular Backup and Restore .......................................................................................................... 320

Get-DAGranularBackupPlan ......................................................................................................... 320

Get-DAGranularBackupBlankPlan................................................................................................. 322

New-DAGranularBackupPlan........................................................................................................ 324

Update-DAGranularBackupPlan ................................................................................................... 326

Remove-DAGranularBackupPlan .................................................................................................. 327

Run-DAGranularBackupJob .......................................................................................................... 328

Platform Backup and Restore .......................................................................................................... 330

Run-DAPlatformBackupJob .......................................................................................................... 330

Obtain a Date Time Object............................................................................................................... 336

Get-DADate ................................................................................................................................. 336

Get-DADateTime.......................................................................................................................... 337

Agent Monitor ................................................................................................................................. 339

Get-DAAgentService .................................................................................................................... 339

Update-DAAgentService .............................................................................................................. 340

Account Manager ............................................................................................................................ 341

Get-DALocalUser.......................................................................................................................... 342

Get-DABlankLocalUser ................................................................................................................. 343

Get-DAActiveDirectoryUser ......................................................................................................... 344

Get-DABlankActiveDirectoryUser ................................................................................................. 345

Get-DAActiveDirectoryGroup ....................................................................................................... 347

9


Get-DABlankActiveDirectoryGroup .............................................................................................. 348

New-DAUser ................................................................................................................................ 349

Update-DAUser............................................................................................................................ 351

Remove-DAActiveDirectoryGroup ................................................................................................ 352

Remove-DAActiveDirectoryUser .................................................................................................. 353

Remove-DALocalUser .................................................................................................................. 354

Security Information Manager ......................................................................................................... 355

Backup-DADatabaseEncryptionKey .............................................................................................. 355

Restore-DADatabaseEncryptionKey ............................................................................................. 356

Backup-DADataEncryptionProfile ................................................................................................. 358

Restore-DADataEncryptionProfile ................................................................................................ 359

Set-DAPassPhrase ........................................................................................................................ 360

Set-DAFipsAlgorithmPolicy........................................................................................................... 361

Physical Device ................................................................................................................................ 363

Get-DAPhysicalDevice .................................................................................................................. 363

Get-DABlankPhysicalDevice ......................................................................................................... 367

New-DAPhysicalDevice ................................................................................................................ 368

Update-DAPhysicalDevice ............................................................................................................ 370

Remove-DAPhysicalDevice ........................................................................................................... 371

Logical Device .................................................................................................................................. 372

Get-DALogicalDevice .................................................................................................................... 372

Get-DABlankLogicalDevice ........................................................................................................... 373

New-DALogicalDevice .................................................................................................................. 374

Update-DALogicalDevice .............................................................................................................. 376

Remove-DALogicalDevice............................................................................................................. 378

Storage Policy .................................................................................................................................. 379

Get-DAStoragePolicy .................................................................................................................... 379

Get-DABlankStoragePolicy ........................................................................................................... 380

New-DAStoragePolicy .................................................................................................................. 381

Update-DAStoragePolicy .............................................................................................................. 382

Remove-DAStoragePolicy............................................................................................................. 383

Update Manager ............................................................................................................................. 385

10


Upload-DAUpdate........................................................................................................................ 385

Get-DAUpdate ............................................................................................................................. 386

Get-DAUpdateConfiguration ........................................................................................................ 387

Test-DAUpdate ............................................................................................................................ 388

Install-DAUpdate ......................................................................................................................... 389

Job Monitor ..................................................................................................................................... 391

Get-DAJob ................................................................................................................................... 391

Get-DAJobDetail .......................................................................................................................... 395

Get-DAJobSetting ........................................................................................................................ 397

Get-DAJobSummary ..................................................................................................................... 399

Download-DAJobReport............................................................................................................... 401

Health Analyzer ............................................................................................................................... 402

Export-DAHealthAnalyzerReport .................................................................................................. 402

Notices and Copyright Information ...................................................................................................... 404

11


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 platform must be installed and

configured properly on your farm. DocAve SDK and Management Shell will not function without

installing DocAve platform.

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/sharepoint_user_guides/DocAve_6_Installation_Guide.pdf

12


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.

13


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

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

14



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

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)


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

15



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


Create a new plan


Delete a plan

Run a plan

Download profile

Upload profile



Create a new plan


Delete a plan

Run a plan

Download profile

Upload profile

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

Get a blank plan


Create a new plan


Delete a plan

Run a plan

Update a plan

eRoom Migration Get a blank plan


Create a new plan


16



Delete a plan

Run a plan

Lotus Notes Migration Get a blank plan


Create a new 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


eRoom Migration Upload/download a migration options profile


Livelink Migration Get a blank plan


Create a new plan


Delete a plan

Run a plan

Upload/download a migration options profile


Exchange Public Folder Migration

Get a blank plan


Create a new plan


Delete a plan

Run a plan

Upload/download a migration 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

17



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 SP4

EMC Documentum Migration

List plans

Create/update/delete a plan

Start a job

Download/upload migration options profile

Download/upload mapping options profile

Quickr Migration List plans Create/update/delete a plan

Start a job

Download/upload migration options profile

Download/upload mapping options profile

All Migration Modules Support SharePoint Online

Granular Backup Support selecting the App nodes when creating a plan

Content Manager Support selecting the App nodes when creating a plan

Deployment Manager Create a plan

Health Analyzer Export a report Log into Manager Support logging into Manager using Active Directory

user *Note: DocAve command lines and APIs support to work on the SharePoint folder level and SharePoint

item level starting from 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.

18


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.

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

The DLL files for DocAve API have been changed. Refer to the Prepare Required Libraries section in DocAve SDK Documentation -for the current list of DLL files. You can find DocAve SDK Documentation in the Start menu after installing DocAve 6 Management Shell.

Figure 1: Locating DocAve SDK Documentation on the Agent server.

Remove the "SetAccount" method from the DocAve.API.ControlPanel.Monitor.AgentService class.

Remove the "Username" and "Password" properties from the DocAve.API.ControlPanel.StorageConfiguration.NetSharePhysicalDevice class. Add "AccountProfile" property to the DocAve.API.ControlPanel.StorageConfiguration.NetSharePhysicalDevice class.

Remove the 'BatchProcessingType' and 'DestinationTree' properties from the DocAve.API.Administration.DeploymentManager.DeploymentManagerDesignElementM

19


apping class and add these two properties to the DocAve.API.Administration.DeploymentManager.DeploymentManagerDesignElementImportMapping or DocAve.API.Administration.DeploymentManager.DeploymentManagerDesignElementOnlineMapping class derived from DeploymentManagerDesignElementMapping.

20


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

CentralAdminContract.dll

CommonContract.dll

CommonMicroKernel.dll

CommonUtility.dll

ContentManagerContract.dll

DeploymentManagerContract.dll

EDiscoveryContract.dll

HighAvailabilityContract.dll

ItemContract.dll

log4net.dll

MigrationContract.dll

PlatformRecoveryContract.dll

ReplicatorContract.dll

ReportCenterContract.dll

SQLServerDataManagerContract.dll

Storage.dll

StorageOptimizationContract.dll

VaultContract.dll

HealthAnalyzerContract.dll

21


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;

Creating a New Plan

DocAve API does not support configuring the 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;

22


granularBackupPlan.IncludeWorkflowInstance = true;

granularBackupPlan.EnableDataCompression(GranularBackupCompressio

nType.Level5, GranularBackupCompressionMethod.MediaService);

granularBackupPlan.EnableDataEncryption(GranularBackupDataEncrypt

ionType.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 CreatePlan Method to create a plan.

granularBackupService.CreatePlan(granularBackupPlan);

23


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.ShareP

ointAgent, "new Security Profile");

plan.AgentGroupName = "new Agent Group";

2. Define a SharePoint object.



"http://SharePoint2010:10001/sites/new GranularBackup");

24


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);

25


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

26


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(GranularBackupDataEncryptionTy

pe.MediaService, "Default Security Profile");

granularBackupPlan.AgentGroupName =

"DEFAULT_AGENT_GROUP_FOR_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

27


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.SharePointA

gent, "new Security Profile");

plan.AgentGroupName = "new Agent Group";



"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);

28


}

while (job.Status == JobStatus.InProgress || job.Status ==

JobStatus.Pausing);

docave.JobMonitorService.DownloadJobReport(jobID,

JobReportFormat.CSV, @"D:\JobReport.zip", false);

#endregion

}

}

}

29


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 2: Specify the installation location.

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

Figure 3: Exit the tool.

30


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*

31


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 4: Get-Help about_DAUpdate in DocAve 6 Management Shell.

32


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 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

Refer to the following sections for more information.

Login-DAManager

Logs into Manager.

Syntax Login-DAManager -ControlHost <String> -ControlPort <Int32> -Credential

<PSCredential> [-ADGroupName <String>] [<CommonParameters>]

Login-DAManager -ControlHost <String> -ControlPort <Int32> -Username

<String> -Password <SecureString> [-ADGroupName <String>]

[<CommonParameters>]

Login-DAManager -ControlHost <String> -ControlPort <Int32> -Username

<String> -PlainTextPassword <String> [-ADGroupName <String>]


Description

The Login-DAManager cmdlet is used to log into Manager. The local user and the Active Directory user

are supported for logging into Manager.

Parameters -ControlHost<String>

Specifies the address of control host.

Required? Position? Default value Accept pipeline input?

Accept wildcard characters?

true named false false

33


-ControlPort<Int32>

Specifies the control port.




-Credential<PSCredential>

Specifies the credential.




-ADGroupName<String>

Specifies name of the Active Directory group whose permission you want to use to log into

Manager. Use the full domain name, for example, example.com\group.



false named false false

-Username<String>

Specifies the username. If the user is an AD user, please use the full domain name, for example,

example.com\user.




-Password<SecureString>

Specifies the password in the form of secure string.




-PlainTextPassword<String>

34


Specifies the password in the form of plain text string.




<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable,

WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, type, "get-

help about_commonparameters".

Examples

Example 1

PS C:\>$Credential = Get-Credential

PS C:\>Login-DAManager -ControlHost localhost -ControlPort 14000 -

Credential $credential

Description

Logins manager according to the credential.

Example 2

PS C:\>$SecurePassword = Read-Host -AsSecureString

*****


Username admin -Password $SecurePassword

Description

Logs into manager according to the username and the secure string password.

Example 3


Username admin -PlainTextPassWord admin

Description

Logs into manager according to the username and the plain text password.

35


Example 4


Username example.com\user1 -PlainTextPassword admin -ADGroupName

example.com\group1

Description

This command logs into Manager using the specified Active Directory user.

Related Links Logout-DAManager

Log Out of DocAve Manager


Logout-DAManager

Logs out the DocAve Manager.

Syntax Logout-DAManager [<CommonParameters>]

Description

The Logout-DAManager cmdlet logs out the DocAve Manager.

Parameters <CommonParameters>




Examples

Example 1

PS C:\>Logout-DAManager

Description

This command logs out the DocAve Manager.

Related Links Login-DAManager

36


Administrator


Get-DASPBlankSecuritySearchSetting

Gets a blank security search setting.

Syntax Get-DASPBlankSecuritySearchSetting [<CommonParameters>]

Description

The Get-DASPBlankSecuritySearchSetting cmdlet gets a blank security search setting.





Examples

Example 1

PS C:\>$setting = Get-DASPBlankSecuritySearchSetting

PS C:\>$setting

UserAndGroup : {}

LimitedPermissions : AnyPermission

PermissionPolicy : ExactPermission

IncludeSharePointUsersAndGroupsWithNoPermissions : False

OnlySearchForExplicitPermissions : False

IncludeSharePointGroupMembers : False

IncludeADGroupMembersOrFBARoleMembers : False

SearchLevels : WebApplication,

SiteCollection, Site, List, Folder, Item, Document

37


SearchFilterRules :

DocAve.API.Administration.Administrator.Security.SecuritySearchFilterR

ules

Description

This command shows how to get a blank security search setting.

Related Links Search-DASPPermission

Search-DASPPermission

Searches for users or groups with specific permissions.

Syntax Search-DASPPermission [-Scope] <SharePointObject[]> [-Setting]

<SecuritySearchSetting> [-PlanName <String>] [<CommonParameters>]

Search-DASPPermission [-FarmName] <String> [-Setting]

<SecuritySearchSetting> [-PlanName <String>] [<CommonParameters>]

Description

The Search-DASPPermission cmdlet searches for users or groups with specific permissions.

Parameters -Scope<SharePointObject[]>

Specifies the scope with the node(s) you want to search.



true 0 true (ByValue) false

-Setting<SecuritySearchSetting>

Specifies a security search setting.




-PlanName<String>

Specifies a plan name.

38





-FarmName<String>

Specifies a farm name.



true 0 true (ByValue, ByPropertyName)

false

<CommonParameters>




Examples

Example 1


PS C:\>$setting.UserAndGroup.Add('example.com/user1')

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

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

PS C:\>

PS C:\>$rule01 = New-Object

DocAve.API.Administration.Administrator.Security.ListOrLibraryUrlFilte

rRule

PS C:\>$rule01.EqualsCondition = 'http://SharePoint2010:10001/Shared

Documents'

PS C:\>$rule01.CombineMode = 'Or'

PS C:\>

PS C:\>$rule02 = New-Object

DocAve.API.Administration.Administrator.Security.ListOrLibraryUrlFilte

rRule

39


PS C:\>$rule02.MatchesCondition = '*Link*'

PS C:\>

PS C:\>$setting.SearchFilterRules.Add($rule01)

PS C:\>$setting.SearchFilterRules.Add($rule02)

PS C:\>

PS C:\>$webapplication1 = New-Object

DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT

_CONFIG)','http://SharePoint2010:10001/')

PS C:\>$webapplication2 = New-Object


_CONFIG)','http://SharePoint2010:10002')

PS C:\>

PS C:\>$setting.SearchLevels = 'List, Folder, Item'

PS C:\>

PS C:\>Search-DASPPermission -Scope $webapplication1,$webapplication2

-Setting $setting

Description

These commands show how to search permissions within a specified scope.

Example 2


PS C:\>$setting.IncludeSharePointUsersAndGroupsWithNoPermissions =

$true

PS C:\>$setting.LimitedPermissions = 'FullControl'

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

PS C:\>$setting.PermissionPolicy = 'ExactPermissionOrBetter'

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

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

PS C:\>$setting.SearchLevels = 'WebApplication,SiteCollection'

40


PS C:\>Search-DASPPermission -FarmName

'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -Setting $setting -PlanName

'plan1'

Description

These commands show how to search permissions within a specified farm.

Related Links Get-DASPBlankSecuritySearchSetting

Get-DASPBlankCloneUserPermissionSetting

Gets the settings list of cloning user permissions.

Syntax Get-DASPBlankCloneUserPermissionSetting [<CommonParameters>]

Description The Get-DocAveSPBlankCloneUserPermissionSetting cmdlet gets the settings list which allows you to

configure the Clone User Permission settings.





Examples

Example 1

PS C:\>Get-DASPBlankCloneUserPermissionSetting

FilterPolicy :

PermissionOption : Append

AdditionalOption :

AddTargetUsersToSourceUsersGroup

RemoveSourceUsersExplicitPermissionsOrGroupPermissions : False

41


RemoveSourceUserFromSharePointGroups : False

DeleteSourceUserOrGroupFromSiteCollection : False

SendSourceUserAlertsToDestinationUsers : False

MetadataToChange : { }

IncludeDetailedReport : False

Description

This command gets the settings list which allows you to configure the Clone User Permission settings.

Related Links Clone-DASPUserPermission

Clone-DASPUserPermission

Clones permissions of the specified user to other user(s) or group(s).

Syntax Clone-DASPUserPermission [-Scope] <List`1[SharePointObject]> [-

SourceUser] <String> [-Destination] <List`1[String]> [-Setting]

<CloneUserPermissionSetting> [<CommonParameters>]

Clone-DASPUserPermission [-FarmName] <String> [-SourceUser] <String>

[-Destination] <List`1[String]> [-Setting]

<CloneUserPermissionSetting> [<CommonParameters>]

Description

The Clone-DASPUserPermission cmdlet clones a user's permissions to other user(s) or group(s) according

to the scope, source group, destination account(s) and the clone-related settings you configured.

Parameters -Scope<List`1[SharePointObject]>

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. And they must be at the same level.




false

42


-SourceUser<String>

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




false

-Destination<List`1[String]>

Specifies the username(s) or group name(s) as the destination account(s) that you can clone

permissions to.




false

-Setting<CloneUserPermissionSetting>

Configures the settings for cloning user permissions.




false

-FarmName<String>

Specifies the farm where you wish search for the source user.




false

<CommonParameters>




43


Examples

Example 1

PS C:\>$setting = Get-DASPBlankCloneUserPermissionSetting

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

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

PS C:\>

PS C:\>Clone-DASPUserPermission -FarmName

'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -SourceUser 'user1' -Destination

'user2' -Setting $setting

ID : CA20120710105904343484

PlanName : CloneUserPermission_PLAN20120710105904

Module : Administrator

Status : Finished

StartTime : 7/10/2012 10:59:04 AM

FinishTime : 7/10/2012 11:00:26 AM

Progress : 100

Description

This command searches for the user in the specified farm, and then clone the user’s permissions to the

destination according to the settings you configured.

Example 2

PS C:\>$setting = Get-DASPBlankCloneUserPermissionSetting


PS C:\>$setting.AdditionalOption = 'AddTargetUsersToSourceUsersGroup'


PS C:\>

PS C:\>$webapplication1= New-Object

DocAve.API.Objects.SharePointWebApplication

('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2010:10001/')

44


PS C:\>Clone-DASPUserPermission -Scope $webapplication1 -SourceUser

'user1' -Destination 'user2' -Setting $setting

ID : CA20120710105904453253



Status : Finished

StartTime : 7/10/2012 10:59:54 AM

FinishTime : 7/10/2012 11:01:26 AM

Progress : 100

Description

This command searches for the user in the specified scope, and then clone the user’s permissions to the

destination according to the settings you configured.

Related Links Get-DASPBlankCloneUserPermissionSetting

Stop-DASPInheritingPermissions

Get-DASPBlankCloneGroupPermissionSetting

Gets the settings list of cloning group permissions.

Syntax Get-DASPBlankCloneGroupPermissionSetting [<CommonParameters>]

Description

The Get-DASPBlankCloneGroupPermissionSetting cmdlet gets the settings list which allows you to

configure the Clone Group Permission settings.





45


Examples

Example 1

PS C:\>Get-DASPBlankCloneGroupPermissionSetting

FilterPolicy :

PermissionOption : Append

RemoveSourceUsersExplicitPermissionsOrGroupPermissions : False

DeleteSourceUserOrGroupFromSiteCollection : False

SendSourceUserAlertsToDestinationUsers : False

MetadataToChange : {}

IncludeDetailedReport : False

Description

This command gets the settings list which allows you to configure the Clone Group Permission settings.

Related Links Clone-DASPGroupPermission

Clone-DASPGroupPermission

Clones permissions from the specified group to other user(s) or group(s).

Syntax Clone-DASPGroupPermission [-Scope] <List`1[SharePointObject]> [-

SourceGroup] <String> [-Destination] <List`1[String]> [-Setting]

<CloneGroupPermissionSetting> [<CommonParameters>]

Clone-DASPGroupPermission [-FarmName] <String> [-SourceGroup] <String>

[-Destination] <List`1[String]> [-Setting]

<CloneGroupPermissionSetting> [<CommonParameters>]

Description

The Clone-DASPGroupPermission cmdlet clones a group's permissions to other user or group according

to the scope, source group, destination account(s) and the clone-related settings you configured.

46


Parameters -Scope<List`1[SharePointObject]>

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.




false

-SourceGroup<String>

Specifies a group as the source whose permissions will be cloned.




false

-Destination<List`1[String]>

Specifies the username(s) or group name(s) as the destination that you can clone permissions

to.




false

-Setting<CloneGroupPermissionSetting>

Configures the settings for cloning group permissions.




false

47


-FarmName<String>

Specifies the farm where you wish search for the source group.




false

<CommonParameters>




Examples

Example 1

PS C:\>$setting = Get-DASPBlankCloneGroupPermissionSetting



PS C:\>

PS C:\>$webapplication1= New-Object

DocAve.API.Objects.SharePointWebApplication

('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'http://SharePoint2010:10001/')

PS C:\>Clone-DASPGroupPermission -Scope $webapplication1 -

SourceGroup 'group1' -Destination 'user1' -Setting $setting

ID : CA20120710105904921842



Status : Finished

StartTime : 7/10/2012 10:59:04 AM

FinishTime : 7/10/2012 11:00:26 AM

Progress : 100

Description

48


This command searches for the group in the specified scope, and then clone the group’s permissions to

the destination according to the settings you configured.

Example 2

PS C:\>$setting = Get-DASPBlankCloneGroupPermissionSetting



PS C:\>

PS C:\>Clone-DASPGroupPermission -FarmName

'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -SourceGroup 'group1' -

Destination 'user1' -Setting $setting

ID : CA20120710105904343484



Status : Finished

StartTime : 7/10/2012 10:59:54 AM

FinishTime : 7/10/2012 11:01:26 AM

Progress : 100

Description

This command searches for the group in the specified farm, and then clone the group’s permissions to

the destination according to the settings you configured.

Related Links Get-DASPBlankCloneGroupPermissionSetting


Scan-DASPDeadAccount

Scans the dead accounts.

49


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


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

Description

The Scan-DASPDeadAccount cmdlet scans the dead accounts.

Parameters -Scope<SharePointObject[]>

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 specified must be at the same level.




-FarmName<String>





<CommonParameters>




Examples

Example 1

PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite

('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/site

s/site1')



s/site2')

PS C:\>$result = Scan-DASPDeadAccount -Scope $site1,$site2

50


PS C:\>$result | fl

UserName : dead account1

Type : Disabled

Site : http://SharePoint2010:10001/sites/site1

PermissionLevels : Contribute

Description

These commands scan the dead accounts in the specified scope.

Example 2

PS C:\>$result = Scan-DASPDeadAccount -FarmName

'Farm(SP2010_DB:SHAREPOINT_CONFIG)'

PS C:\>$result | fl


Type : Disabled

Site : http://SharePoint2010:10001/



Type : Disabled



Description

This command scans the dead accounts in the specified farm.

Related Links Remove-DASPDeadAccount


51


Remove-DASPDeadAccount

Removes the dead accounts.

Syntax Remove-DASPDeadAccount [-DeadAccount] <DeadAccount[]> [-DeleteMySite]

[-DeleteUserProfiles] [<CommonParameters>]

Description

The Remove-DASPDeadAccount cmdlet removes the dead accounts.

Parameters -DeadAccount<DeadAccount[]>

Specifies the dead accounts to remove.




-DeleteMySite[<SwitchParameter>]

Specifies whether to delete the My Site or not.




-DeleteUserProfiles[<SwitchParameter>]

Specifies whether to delete the user profiles or not.




<CommonParameters>




52


Examples

Example 1

PS C:\>$result = Scan-DASPDeadAccount -FarmName


PS C:\>$result | fl


Type : Disabled

Site : http://SharePoint2010:10001/



Type : Disabled




Type : Disabled



PS C:\>$deadAccountForRemoving = $result[0],$result[2]

PS C:\>Remove-DASPDeadAccount -DeadAccount $deadAccountForRemoving -

DeleteMySite -DeleteUserProfiles

ID : CA20120710133524028901

PlanName : DeadAccountCleaner_PLAN20120710133522


53


Status : Finished

StartTime : 7/10/2012 1:35:24 PM

FinishTime : 7/10/2012 1:35:43 PM

Progress : 100

Description

This command removes the dead accounts.

Related Links Scan-DASPDeadAccount

Check-DASPInheritingPermissions

Checks whether or not the specified SharePoint object is inheriting permissions from its parent.

Syntax Check-DASPInheritingPermissions [-SharePointWeb] <SharePointWeb>


Check-DASPInheritingPermissions [-SharePointList] <SharePointList>


Check-DASPInheritingPermissions [-SharePointFolder] <SharePointFolder>


Check-DASPInheritingPermissions [-SharePointItem] <SharePointItem>


Description

The Check-DASPInheritingPermissions cmdlet checks whether or not the specified SharePoint object is

inheriting permissions from its parent.

Parameters -SharePointWeb<SharePointWeb>

Specifies a SharePoint site object to check whether or not it is inheriting permissions from its

parent.




54


-SharePointList<SharePointList>

Specifies a SharePoint list object to check whether or not it is inheriting permissions from its

parent.




-SharePointFolder<SharePointFolder>

Specifies a SharePoint folder object to check whether or not it is inheriting permissions from its

parent.




-SharePointItem<SharePointItem>

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

parent.




<CommonParameters>




Examples

Example 1

PS C:\>$web1 = New-Object DocAve.API.Objects.SharePointWeb

('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint:10001/sites/si

te1','/sites/site1/web1')

PS C:\>Check-DASPInheritingPermissions -SharePointWeb $web1

True

55


Description

These commands check whether or not the specified SharePoint site object is inheriting permissions

from its parent.

Example 2

PS C:\>$list1 = New-Object DocAve.API.Objects.SharePointList


s/site1','/sites/site1/web1','list1')

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

True

Description

These commands check whether or not the specified SharePoint list object is inheriting permissions

from its parent.

Example 3

PS C:\>$folder1 = New-Object

DocAve.API.Objects.SharePointFolder('Farm(SP2010_DB:SHAREPOINT_CONFIG)

','http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1

','folder1')

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

True

Description

These commands check whether or not the specified SharePoint folder object is inheriting permissions

from its parent.

Example 4

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

eca0c117ccb4')

PS C:\>$item1 = New-Object

DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)',

'http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1',

'folder1',$itemGuid)

56


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

True

Description

These commands check whether or not the specified SharePoint item object is inheriting permissions

from its parent.

Related Links Stop-DASPInheritingPermissions


Stops the permission inheritance of the specified SharePoint object(s).

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


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


Stop-DASPInheritingPermissions [-SharePointFolder]

<SharePointFolder[]> [<CommonParameters>]

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


Description

The Stop-DASPInheritingPermissions cmdlet stops the permission inheritance of the specified

SharePoint object(s).

Parameters -SharePointWeb<SharePointWeb[]>

Specifies the SharePoint site object(s) to stop its permission inheritance.




57


-SharePointList<SharePointList[]>

Specifies the SharePoint list object(s) to stop its permission inheritance.




-SharePointFolder<SharePointFolder[]>

Specifies the SharePoint folder object(s) to stop its permission inheritance.




-SharePointItem<SharePointItem[]>

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




<CommonParameters>




Examples

Example 1

PS C:\>$web = New-Object DocAve.API.Objects.SharePointWeb


s/site1','/sites/site1/web1')

PS C:\>Stop-DASPInheritingPermissions -SharePointWeb $web

Description

These commands stop the permission inheritance of the specified SharePoint site object.

58


Example 2

PS C:\>$list = New-Object DocAve.API.Objects.SharePointList


s/site1','/sites/site1/web1','list1')

PS C:\>Stop-DASPInheritingPermissions -SharePointList $list

Description

These commands stop the permission inheritance of the specified SharePoint list object.

Example 3

PS C:\>$folder1 = New-Object

DocAve.API.Objects.SharePointFolder('Farm(SP2010_DB:SHAREPOINT_CONFIG)

','http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1

','folder1')

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

Description

These commands stop the permission inheritance of the specified SharePoint folder object.

Example 4

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

eca0c117ccb4')


DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)',

'http://SharePoint2010:10001/sites/site1','/sites/site1/web1','list1',

'folder1',$itemGuid)

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

Description

These commands stop the permission inheritance of the specified SharePoint item object.

Related Links Scan-DASPDeadAccount

Check-DASPInheritingPermissions

59


Content Manager


Get-DAContentManagerOnlinePlan

Gets the plan settings of the specified online content manager plan(s).

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


Description

The Get-DAContentManagerOnlinePlan cmdlet gets the plan settings of the specified online content

manager plan(s).

Parameters -Name<String[]>

Specifies the name(s) of the existing online content manager plan(s) you want to get. Wildcards

and multiple values are allowed, which are separated by commas. If no values are entered here,

the plan settings of all the existing online content manager plan(s) will be gotten.



false 0 true (ByValue, ByPropertyName)

true

<CommonParameters>




Examples

Example 1

PS C:\>Get-DAContentManagerOnlinePlan -Name plan1

Type : Copy

Name : plan1

60


Description : this is a content manager plan.

MethodSettings :

DocAve.API.Administration.ContentManager.ContentManagerCopySettings

Action : Attach

PromoteMethod : PromoteTopLevelSiteToSiteCollection

ManagedPathForDestination :

FilterPolicy : filter policy 01

NotificationName : Notification1

AssociatedPlanGroup : {PlanGroup1}

Configuration : ConfigurationOption6

Security : SecurityOption3

Content : ContentOption3

UserProfile : False

IncludeWorkflowDefinition : True

IncludeWorkflowInstance : False

IncludeCompletedWorkflowInstance : False

RunningWorkflowInstanceSetting : None

MetadataServiceSetting : None

PreserveNullColumnValues : True

CollapseFolderStructure : True

ColumnName : folderName

DataCompression : Level7

DataEncryption : True

SecurityProfile : Default Security Profile

ColumnMapping : column mapping 01

ContentTypeMapping :

TemplateMapping :

61


UserMapping : user mapping 01

DomainMapping :

LanguageMapping :

ConflictResolution : ConflictResolutionOption7

AppsConflictResolution : Skip

SourceTree :

DocAve.API.Administration.ContentManager.ContentManagerSourceTree

DestinationTree :

DocAve.API.Administration.ContentManager.ContentManagerDestinationTree

SourceFarmName :

DestinationFarmName : Farm(SP2010_DB1:SHAREPOINT_CONFIG)

Level : Lateral

ModifiedTime : 7/11/2013 11:41:04 AM

SourceSPSitesGroupName : Default_SharePoint Sites_ Group

DestinationSPSitesGroupName :

Description

This command gets the plan settings of the specified content manager plan.

Related Links New-DAContentManagerOnlinePlan

Update-DAContentManagerOnlinePlan

Remove-DAContentManagerOnlinePlan

Get-DAContentManagerBlankOnlinePlan

Gets a blank online content manager plan without any plan settings.

Syntax Get-DAContentManagerBlankOnlinePlan [<CommonParameters>]

Description

The Get-DAContentManagerBlankOnlinePlan cmdlet gets a blank online content manager plan without

any plan settings for creating a new plan.

62






Examples

Example 1

PS C:\>Get-DAContentManagerBlankOnlinePlan

Type : Copy

Name :

Description :

MethodSettings :

DocAve.API.Administration.ContentManager.ContentManagerCopySettings

Action : Attach

PromoteMethod : PromoteTopLevelSiteToSiteCollection

ManagedPathForDestination : sites

FilterPolicy :

NotificationName :

AssociatedPlanGroup : {}

Configuration : ConfigurationOption1

Security : SecurityOption3

Content : ContentOption2

UserProfile : False

IncludeWorkflowDefinition : False


IncludeCompletedWorkflowInstance : False

63


RunningWorkflowInstanceSetting : None

MetadataServiceSetting : TermSets

PreserveNullColumnValues : True

CollapseFolderStructure : False

ColumnName :

DataCompression : None

DataEncryption : False

SecurityProfile :

ColumnMapping :

ContentTypeMapping :

TemplateMapping :

UserMapping :

DomainMapping :

LanguageMapping :

ConflictResolution : ConflictResolutionOption2

AppsConflictResolution : Skip

SourceTree :

DestinationTree :

SourceFarmName :

DestinationFarmName :

Level :

ModifiedTime :

SourceSPSitesGroupName :


Description This command gets a blank online content manager blank plan without any plan settings.

64



New-DAContentManagerOnlinePlan

Creates a new online content manager plan.

Syntax New-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan>


Description

The New-DAContentManagerOnlinePlan cmdlet creates a new online content manager plan based on a

blank online content manager plan object.

Parameters -Plan<ContentManagerOnlinePlan>

Specifies an online content manager plan object. For the structure and attributes of

ContentManagerOnlinePlan, please refer to the DocAve 6 SDK documentation for more

information.



true 0 true (ByValue) false <CommonParameters>




Examples

Example 1

PS C:\>$plan = Get-DAContentManagerBlankOnlinePlan

PS C:\>$plan.SourceFarmName = 'Farm(SP2010_DB1:SHAREPOINT_CONFIG)'

PS C:\>$plan.DestinationSPSitesGroupName = 'Default_SharePoint Sites_

Group'

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

PS C:\>$sitecollection01 = New-Object

DocAve.API.Objects.SharePointSite($plan.SourceFarmName,

'http://SharePoint2010:10001')

65



DocAve.API.Objects.SharePointOnlineSite($plan.DestinationSPSitesGroupN

ame,'http://10.1.1.1:10020')

PS C:\>$plan.SourceTree.IncludeSPObject($sitecollection01)

PS C:\>$plan.DestinationTree.SelectSPOnlineObject($sitecollection02)

PS C:\>$plan.Action = 'Merge'

PS C:\>$plan.SetPlanType('Move')

PS C:\>$plan.MethodSettings.DeleteSourceCheckedOutDocuments = $true

PS C:\>$plan.MethodSettings.SourceDocumentsAndItemsDeletedMethod =

'Manually'

PS

C:\>$plan.MethodSettings.EnableBackupEnvironment('SourceEnvironment','

storage policy1')

PS C:\>$plan.FilterPolicy = 'filter policy 01'

PS C:\>$plan.Configuration = 'configuration1'

PS C:\>$plan.Security = 'SecurityOption1'

PS C:\>$plan.Content = 'ContentOption1'

PS C:\>$plan.UserProfile = $true

PS C:\>$plan.IncludeWorkflowDefinition = $true

PS C:\>$plan.IncludeWorkflowInstance = $false

PS C:\>$plan.MetadataServiceSetting = 'ManagedMetadataService'

PS C:\>$plan.PreserveNullColumnValues = $false

PS C:\>$plan.CollapseFolderStructure = $false

PS C:\>$plan.DataCompression = 'Level7'

PS C:\>$plan.ColumnMapping = 'column mapping 01'

PS C:\>$plan.ContentTypeMapping = 'content type mapping 01'

PS C:\>$plan.TemplateMapping = 'template mapping 01'

PS C:\>$plan.UserMapping = 'user mapping 01'

PS C:\>$plan.DomainMapping = 'domain mapping 01'

66


PS C:\>$plan.LanguageMapping = 'language mapping 01'

PS C:\>$plan.ListNameMapping = 'list mapping 01'

PS C:\>$plan.ConflictResolution = 'ConflictResolutionOption7'

PS C:\>$plan.NotificationName = 'Notification1'

PS C:\>$plan.AssociatedPlanGroup.Add('plan group1')

PS C:\>

PS C:\>$plan.MethodSettings.Schedule = New-Object

DocAve.API.Administration.ContentManager.ContentManagerMoveschedule

PS C:\>$plan.MethodSettings.Schedule.StartTime = '2013-10-30 15:00'

PS C:\>$plan.MethodSettings.Schedule.TimeZoneId = 'Pacific Standard

Time'

PS C:\>$plan.MethodSettings.Schedule.AutoAdjustForDST = $true

PS C:\>$plan.MethodSettings.Schedule.Interval = 10

PS C:\>$plan.MethodSettings.Schedule.NumberOfOccurrence = 5

PS C:\>

PS C:\>$plan.CollapseFolderStructure = $true

PS C:\>$plan.ColumnName = 'column 01'

PS C:\>

PS C:\>New-DAContentManagerOnlinePlan $plan

Description

These commands create an online content manager plan by getting a blank plan.

Related Links Get-DAContentManagerBlankOnlinePlan




Updates an existing online content manager plan.

67


Syntax Update-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan>


Description

The Update-DAContentManagerOnlinePlan cmdlet updates an existing online content manager plan.

Parameters -Plan<ContentManagerOnlinePlan>

Specifies a content manager online plan object for updating.







Examples

Example 1

PS C:\>$plan = Get-DAContentManagerOnlinePlan -Name 'plan1'


PS C:\>Update-DAContentManagerOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified online content manager plan.





Deletes the specified online content manager plan.

68


Syntax Remove-DAContentManagerOnlinePlan [-Name] <String> [-WhatIf] [-

Confirm] [<CommonParameters>]

Description

The Remove-DAContentManagerOnlinePlan cmdlet deletes the specified online content manager plan.

Parameters -Name<String>

Specifies the name of the online content manager plan that you want to delete.




false

-WhatIf[<SwitchParameter>]

Describes what would happen if you executed the command without actually executing the

command.




-Confirm[<SwitchParameter>]

Prompts you for confirmation before executing the command.




<CommonParameters>




Examples

Example 1

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

69


Description

This command deletes the specified online content manager plan.




Run-DAContentManagerCopyJob

Runs an existing content manager copy plan.

Syntax Run-DAContentManagerCopyJob [-PlanName] <String> [-TestRun] [-

WaitForJobComplete] [<CommonParameters>]

Description

The Run-DAContentManagerCopyJob cmdlet runs an existing content manager copy plan.

Parameters -PlanName<String>

Specifies the name of an existing content manager copy plan that you want to run.



true 0 false false

-TestRun[<SwitchParameter>]

Specifies whether to simulate the execution of the selected plan.




-WaitForJobComplete[<SwitchParameter>]

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.

70





<CommonParameters>




Examples

Example 1

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

WaitForJobComplete

ID : CM20120710113730905728

PlanName : plan1

Module : ContentManager

Status : Finished

StartTime : 7/10/2012 11:37:30 AM

FinishTime : 7/10/2012 11:39:24 AM

Progress : 100

Description

This command runs a content manager copy plan.

Related Links Run-DAContentManagerMoveJob

Run-DAContentManagerImportJob

Run-DAContentManagerExportJob


Runs an existing content manager export plan.

71


Syntax Run-DAContentManagerExportJob [-PlanName] <String> [-


Description

The Run-DAContentManagerExportJob cmdlet runs an existing content manager export plan.


Specifies the name of an existing content manager export plan that you want to run.



true 0 false false -WaitForJobComplete[<SwitchParameter>]






false named false false <CommonParameters>




Examples Example 1

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

WaitForJobComplete

ID : CM20120710113730905728

PlanName : plan1


Status : Finished

72


StartTime : 7/10/2012 11:37:30 AM

FinishTime : 7/10/2012 11:39:24 AM

Progress : 100

Description

This command runs a content manager export plan.

Related Links Run-DAContentManagerImportJob


Run-DAContentManagerMoveJob


Runs an existing content manager import plan.

Syntax Run-DAContentManagerImportJob [-PlanName] <String> [-


Description

The Run-DAContentManagerImportJob cmdlet runs an existing content manager import plan.


Specifies the name of an existing content manager import plan that you want to run.



true 0 false false








73


<CommonParameters>




Examples

Example 1

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

WaitForJobComplete

ID : CM20120710113730905728

PlanName : plan1


Status : Finished

StartTime : 7/10/2012 11:37:30 AM

FinishTime : 7/10/2012 11:39:24 AM

Progress : 100

Description

This command runs a content manager import plan.

Related Links Run-DAContentManagerExportJob




Runs a content manager move plan.

Syntax Run-DAContentManagerMoveJob [-PlanName] <String> [-TestRun] [-


74


Description

The Run-DAContentManagerMoveJob cmdlet runs a content manager move plan.


Specifies the name of an existing content manager move plan that you want to run.



true 0 false false













<CommonParameters>




Examples Example 1

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

WaitForJobComplete

75


ID : CM20120710113730905728

PlanName : plan1


Status : Finished

StartTime : 7/10/2012 11:37:30 AM

FinishTime : 7/10/2012 11:39:24 AM

Progress : 100

Description

This command runs a content manager move plan.

Related Links Run-DAContentManagerCopyJob



Get-DAContentManagerJobConfigurationDetail

Gets the configuration details of a Content Manager job.

Syntax Get-DAContentManagerJobConfigurationDetail [-ID] <String> [-

JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>]

[-Length <Int32>] [<CommonParameters>]

Description

The Get-DAContentManagerJobConfigurationDetail cmdlet gets the configuration details of a Content

Manager job according to the specified Job ID.

Parameters -ID<String>

Specifies a Job ID to get the detailed job information.




false

76


-JobReportDetailStatus<JobReportDetailStatus[]>

Specifies a job status that is used to filter which job configuration detail will be displayed. The

available values are "Success", "Failed", "Skipped" and "Filtered".




-StartIndex<Int32>

Specifies a start number. The job detail will be displayed starting from the specified number of

objects whose job status is the specified value for the parameter "JobReportDetailStatus".




-Length<Int32>

Specifies how many object's job details will be displayed.




<CommonParameters>




Examples Example 1

PS C:\>Get-DAContentManagerJobConfigurationDetail -ID

CM20131028111320255224

Key Value

--- -----

Date 2013-10-28 19:16:40

(UTC+08:00)

77


Beij...

Property Site Column

Type Site

Name Enterprise Keywords

Related Object Title smoke 01

Source URL

http://SharePointServer2012:10010

Target URL

http://SharePointServer:10020/Root

Status Successful

Comment

Date 2013-10-28 19:16:40

(UTC+08:00)

Beij...


Type Site

Name HashTags


Source URL


Target URL


Status Successful

Comment

Description

This command gets the configuration details of the specified Content Manager job.

78


Example 2

PS C:\>Get-DAContentManagerJobConfigurationDetail -ID

cm20131028111320255224 -

JobReportDetailStatus Success -StartIndex 0 -Length 1

Key Value

--- -----

Date 2013-10-28 19:16:40

(UTC+08:00)

Beij...


Type Site

Name Enterprise Keywords


Source URL


Target URL


Status Successful

Comment

Description

This command gets the first Successful configuration details object of the specified job.

Related Links Get-DAContentManagerJobSecurityDetail

Get-DAContentManagerJobSecurityDetail

Gets the security details of a Content Manager job.

79


Syntax Get-DAContentManagerJobSecurityDetail [-ID] <String> [-



Description

The Get-DAContentManagerJobSecurityDetail cmdlet gets the security details of a Content Manager job

according to the specified Job ID.


Specifies a Job ID.




false


Specifies a job status that is used to filter which job security detail will be displayed. The

available values are "Success", "Failed", "Skipped" and "Filtered".




-StartIndex<Int32>






-Length<Int32>





80


<CommonParameters>




Examples

Example 1

PS C:\>Get-DAContentManagerJobSecurityDetail -ID

CM20131028111320255224

Key Value

--- -----

Date 2013-10-28 19:16:40

(UTC+08:00)

Beij...

User/Group User

Type Site

Name NT AUTHORITY\LOCAL SERVICE


Source URL


Target URL


Status of User/Groups Successful

Comment

Date 2013-10-28 19:16:40

(UTC+08:00)

Beij...

81


User/Group Group

Type Site

Name Excel Services Viewers


Source URL


Target URL



Comment

Description

This command gets the security details of the specified Content Manager job.

Example 2

PS C:\>Get-DAContentManagerJobSecurityDetail -ID

CM20131028111320255224 -


Key Value

--- -----

Date 2013-10-28 19:16:40

(UTC+08:00)

Beij...

User/Group User

Type Site

Name NT AUTHORITY\LOCAL SERVICE


82


Source URL


Target URL



Comment

Description

This command gets the first Successful security details object of the specified job.

Related Links Get-DAContentManagerJobConfigurationDetail

Deployment Manager


Get-DADeploymentManagerPlan

Gets the plan settings of the specified deployment manager plan(s).

Syntax Get-DADeploymentManagerPlan [[-Name] <String[]>] [<CommonParameters>]

Description The Get-DADeploymentManagerPlan cmdlet gets the plan settings of the specified deployment manager

plan(s).


Specifies the name(s) of the existing deployment manager plan(s) you want to get. Wildcards

and multiple values are allowed, which are separated by commas. If no values are entered here,

the plan settings of all the existing deployment manager plan(s) will be gotten.




true

<CommonParameters>

83





Examples

Example 1

PS C:\>$plan = Get-DADeploymentManagerPlan -Name plan01

PS C:\>$plan | Format-List

Name : plan01

Description : this is a

deployment manager plan.

StoragePolicyNameForBackingupDestinationEnvironment : storage policy01

NotificationName : email01

Mappings :

{Farm(SP2010_DB1:SHAREPOINT_CONFIG)}

Schedule :

Description

This command gets the plan settings of the specified deployment manager plan.

Related Links Get-DADeploymentManagerBlankPlan

Update-DADeploymentManagerPlan

Remove-DADeploymentManagerPlan

Get-DADeploymentManagerBlankPlan

Gets a blank deployment manager plan without any plan settings.

Syntax Get-DADeploymentManagerBlankPlan [<CommonParameters>]

84


Description

The Get-DADeploymentManagerBlankPlan cmdlet gets a blank deployment manager plan without any

plan settings for creating a new plan.





Examples

Example 1

PS C:\>$plan = Get-DADeploymentManagerBlankPlan

PS C:\>$plan | Format-List

Name :

Description :

StoragePolicyNameForBackingupDestinationEnvironment :

NotificationName :

Mappings : {}

Schedule :

Description

This command gets a deployment manager blank plan without any plan settings.

Related Links New-DADeploymentManagerPlan

New-DADeploymentManagerPlan

Creates a new deployment manager plan.

Syntax New-DADeploymentManagerPlan [-Plan] <DeploymentManagerPlan>


85


Description

The New-DADeploymentManagerPlan cmdlet creates a new deployment manager plan based on a blank

deployment manager plan object.

Parameters -Plan<DeploymentManagerPlan>

Specifies a deployment manager plan object. For the structure and attributes of

DeploymentManagerPlan, please refer to the DocAve 6 SDK documentation for more

information.



true 0 false false

<CommonParameters>




Examples Example 1

PS C:\>$plan = Get-DADeploymentManagerBlankPlan

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

PS C:\>$plan.Description = 'this is a deployment manager plan'

PS C:\>$plan.StoragePolicyNameForBackingupDestinationEnvironment =

'storage policy 01'

PS C:\>$plan.NotificationName = 'email 01'

PS C:\>

PS C:\>$farmName = 'Farm(SP2010_DB1:SHAREPOINT_CONFIG)'

PS C:\>$webapp = New-Object

DocAve.API.Objects.SharePointWebApplication($farmName,'http://SharePoi

nt2010:10001/')

PS C:\>$site = New-Object

DocAve.API.Objects.SharePointSite($farmName,'http://SharePoint2010:100

02')

86


PS C:\>

PS C:\>$mapping01 = $plan.GetBlankFarmSolutionOnlineMapping()

PS C:\>$mapping01.IncludeSolution($farmName,'farmsolution01.wsp')

PS C:\>$mapping01.IncludeSolution($farmName,'farmsolution02.wsp')

PS C:\>$mapping01.SelectDestinationFarm($farmName)

PS C:\>

PS C:\>$names = New-Object System.Collections.Generic.List[string]

PS C:\>$names.Add('farmsolution02.wsp')

PS C:\>$names.Add('farmsolution01.wsp')

PS C:\>$mapping01.ReorderSolutions($names)

PS C:\>

PS C:\>$plan.AddMapping($mapping01)

PS C:\>

PS C:\>$mapping02 = $plan.GetBlankUserSolutionOnlineMapping()

PS C:\>$mapping02.IncludeSolution($site,'UserSolutionA.wsp')

PS C:\>$mapping02.IncludeSolution($site,'UserSolutionB.wsp')

PS C:\>$mapping02.SelectDestinationSPObject($webapp)

PS C:\>$mapping02.ConflictResolutionType = 'Skip'

PS C:\>


PS C:\>

PS C:\>$mapping03 = $plan.GetBlankSolutionFromSolutionStoreMapping()

PS C:\>$solutionStoreName = 'storage policy 02'

PS

C:\>$mapping03.IncludeSolution($solutionStoreName,'farmsolution01.wsp'

)

87


PS

C:\>$mapping03.IncludeSolution($solutionStoreName,'usersolution02.wsp'

)

PS C:\>$mapping03.SelectDestinationFarm($farmName)

PS C:\>


PS C:\>

PS C:\>$mapping04 = $plan.GetBlankSolutionFromFileSystemMapping()

PS C:\>$mapping04.SelectDestinationSPObject($webapp)

PS C:\>$mapping04.IncludeSolution('export location 01/folder

01/solution01.wsp')

PS C:\>$mapping04.IncludeSolution('export location 02/folder

02/solution02.wsp')

PS C:\>$mapping04.ConflictResolutionType = 'Upgrade'

PS C:\>


PS C:\>

PS C:\>$guid = New-Object Guid("c817d588-b211-4db9-9d32-616aa3dc87b7")

PS C:\>$farm13Name = 'Farm(SP2013_DB1:SHAREPOINT_CONFIG)'

PS C:\>$app = New-Object docave.api.objects.SharePointApp($farm13Name,

"http://SharePoint2013:10001", "", $guid)


docave.api.objects.sharepointsite($farm13Name,'http://SharePoint2013:1

0002')


docave.api.objects.sharepointsite($farm13Name,'http://SharePoint2013:1

0003')

PS C:\>

PS C:\>$mapping05 = $plan.GetBlankDesignElementOnlineMapping()

PS C:\>$mapping05.SourceTree.IncludeSPObject($app)

88


PS C:\>$mapping05.DestinationTree.SelectSPObject($sitecollection01)

PS C:\>

PS C:\>$mapping05.BatchProcessingType = 'DeployToTopSiteOnly'

PS C:\>$mapping05.ConflictResolution =

'ContainerLevelMergeAndContentLevelOverwrite'

PS C:\>$mapping05.AppConflictResolution = 'Replace'

PS C:\>


PS C:\>

PS C:\>$mapping06 = $plan.GetBlankDesignElementImportMapping()

PS C:\>$mapping06.DestinationTree.SelectSPObject($sitecollection02)

PS C:\>$mapping06.SelectExportJob("2013Location",

"DM20130903171408618189_000")

PS C:\>

PS C:\>$mapping06.ConflictResolution =

'ContainerLevelMergeAndContentLevelOverwrite'

PS C:\>$mapping06.AppConflictResolution = 'Replace'

PS C:\>$mapping06.BatchProcessingType = 'DeployToAllSites'

PS C:\>$mapping06.DomainMappingName = 'Domain Mapping'

PS C:\>$mapping06.UserMappingName = 'User Mapping'

PS C:\>$mapping06.LanguageMappingName = 'Language Mapping'

PS C:\>$mapping06.DestinationFilterPolicyName = 'filter01'

PS C:\>$mapping06.PreserveTheNullColumnValues = $false

PS C:\>


PS C:\>

PS C:\>$plan.Schedule = New-Object

DocAve.API.Administration.DeploymentManager.DeploymentManagerSchedule

89


PS C:\>$plan.Schedule.StartTime = '2013-10-30 15:00'

PS C:\>$plan.Schedule.TimeZoneId = 'Pacific Standard Time'

PS C:\>$plan.Schedule.AutoAdjustForDST = $true

PS C:\>

PS C:\>New-DADeploymentManagerPlan -Plan $plan

Description

These commands create a deployment manager plan by getting a blank plan.

Related Links Update-DADeploymentManagerPlan

Get-DADeploymentManagerBlankPlan



Updates an existing deployment manager plan.

Syntax Update-DADeploymentManagerPlan [-Plan] <DeploymentManagerPlan>


Description

The Update-DADeploymentManagerPlan cmdlet updates an existing deployment manager plan.

Parameters -Plan<DeploymentManagerPlan>

Specifies a deployment manager plan object for updating.



true 0 false false

<CommonParameters>




90


Examples

Example 1

PS C:\>$plan = Get-DADeploymentManagerPlan -Name 'dpm plan'

PS C:\>$plan.Name = 'dpm plan update'

PS C:\>$plan.Description = 'this is a dpm plan'

PS C:\>

PS C:\>$mapping = $plan.Mappings[0]

PS C:\>if($mapping.Type -eq 'Solution')

>> {

>>

$mapping.SelectDestinationFarm('Farm(SP2010_DB1:SHAREPOINT_CONFIG)')

>> }

>>

PS C:\>$plan.UpdateMapping($mapping)

PS C:\>Update-DADeploymentManagerPlan -Plan $plan

Description

These commands update the plan settings of the specified deployment manager plan.





Deletes the specified deployment manager plan.

Syntax Remove-DADeploymentManagerPlan [-Name] <String> [-WhatIf] [-Confirm]


Description The Remove-DADeploymentManagerPlan cmdlet deletes the specified deployment manager plan.

91



Specifies the name of the deployment manager plan that you want to delete.






command.









<CommonParameters>




Examples

Example 1

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

Description

This command deletes the specified deployment manager plan.



92



Run-DADeploymentManagerJob

Runs a job based on a Deployment Manager plan.

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


Description

The Run-DADeploymentManagerJob cmdlet runs a Deployment Manager job based on the specified

plan.


Specifies the Deployment Manager plan name.



true 0 false false


Whether to wait for the completion of the job. If you select to wait for the completion,it will

show the job process. Otherwise, it will run in the background.




<CommonParameters>




Examples

Example 1

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

WaitForJobComplete

93


ID : DM20120710141030243429

PlanName : plan1

Module : DeploymentManager

Status : Finished

StartTime : 7/10/2012 2:10:30 PM

FinishTime : 7/10/2012 2:12:12 PM

Progress : 100

Description

This command runs a Deployment Manager job based on the plan named plan1.

Related Links

Replicator


Run-DAReplicatorOnlineJob

Runs online Replicator job.

Syntax Run-DAReplicatorOnlineJob [-PlanName] <String> -ReplicatorRunLevel

<String> [-ReplicateModifications] [-ReplicateDeletions] [-

SpecialReferenceTime <String>] [-TestRun] [-WaitForJobComplete]


Description

The Run-DAReplicatorOnlineJob cmdlet runs a online Replicator job based on the specified plan.


Specifies the plan name, the job will run based on the plan.



true 0 false false

94


-ReplicatorRunLevel<String>

Specifies the job level. Valid values are "Full" and "Incremental".




-ReplicateModifications[<SwitchParameter>]

Specifies whether to replicate the modifications. You cannot specify this parameter unless

the value of parameter 'ReplicatorRunLevel' is 'Incremental'.




-ReplicateDeletions[<SwitchParameter>]

Specifies whether to replicate the deletions. You cannot specify this parameter unless the

value of parameter 'ReplicatorRunLevel' is 'Incremental'.




-SpecialReferenceTime<String>

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. This parameter should be in the

form of '*m *h *d' (representing minutes, hours and days - where * can be a number between 0

and 65535). You cannot specify this parameter unless the value of parameter

'ReplicatorRunLevel' is 'Incremental'.





Whether to run the test job.

95











<CommonParameters>




Examples

Example 1

PS C:\>Run-DAReplicatorOnlineJob -PlanName 'plan1' -ReplicatorRunLevel

Full -WaitForJobComplete -TestRun

ID : RP20111118191910234421

PlanName : plan1

Module : Replicator

Status : Finished

StartTime : 11/18/2011 7:19:10 PM

FinishTime : 11/18/2011 7:41:53 PM

Progress : 100

Description

This command runs a online Replicator job based on plan1 and the job is a full job.

Example 2

96


PS C:\>Run-DAReplicatorOnlineJob -PlanName 'plan1' -ReplicatorRunLevel

Incremental -ReplicateModifications -ReplicateDeletions -TestRun

ID : RP20111118201910223412

PlanName : plan1

Module : Replicator

Status : Finished

StartTime : 11/18/2011 8:19:10 PM

FinishTime : 11/18/2011 8:41:53 PM

Progress : 100

Description

This command runs a new online Replicator job based on plan1 and the job is an incremental job.

Related Links Run-DAReplicatorExportJob

Run-DAReplicatorImportJob

Run-DAReplicatorExportJob

Runs Replicator data export job.

Syntax Run-DAReplicatorExportJob [-PlanName] <String> -ReplicatorRunLevel

<String> [-ReplicateModifications] [-ReplicateDeletions] [-

SpecialReferenceTime <String>] [-WaitForJobComplete]


Description

The Run-DAReplicatorExportJob cmdlet runs a Replicator data export job based on the specified plan.



97




true 0 false false

-ReplicatorRunLevel<String>

Specifies the job level. Valid values are "Full" and "Incremental".




-ReplicateModifications[<SwitchParameter>]

Specifies whether to replicate the modifications. You cannot specify this parameter unless

the value of parameter 'ReplicatorRunLevel' is 'Incremental'.




-ReplicateDeletions[<SwitchParameter>]

Specifies whether to replicate the deletions. You cannot specify this parameter unless the

value of parameter 'ReplicatorRunLevel' is 'Incremental'.




-SpecialReferenceTime<String>

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. This parameter should be in the

form of '*m *h *d' (representing minutes, hours and days - where * can be a number between 0

and 65535). You cannot specify this parameter unless the value of parameter

'ReplicatorRunLevel' is 'Incremental'.





98







<CommonParameters>




Examples

Example 1

PS C:\>Run-DAReplicatorExportJob -PlanName 'plan1' -ReplicatorRunLevel

Full -WaitForJobComplete

ID : RP20111118192720945323

PlanName : plan1

Module : Replicator

Status : Finished

StartTime : 11/18/2011 7:27:20 PM

FinishTime : 11/18/2011 7:37:39 PM

Progress : 100

Description

This command runs a Replicator export job based on plan1 and the job is a full job.

Example 2

PS C:\>Run-DAReplicatorExportJob -PlanName 'plan1' -ReplicatorRunLevel

Incremental -ReplicateModifications -ReplicateDeletions -

SpecialReferenceTime 11m

ID : RP20111118202720929234

99


PlanName : plan1

Module : Replicator

Status : Finished

StartTime : 11/18/2011 8:27:20 PM

FinishTime : 11/18/2011 8:37:39 PM

Progress : 100

Description

This command runs a Replicator export job based on plan1 and the job is an incremental job.

Related Links Run-DAReplicatorOnlineJob



Runs Replicator data import job.

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


Description

The Run-DAReplicatorImportJob cmdlet runs a Replicator data import job based on the specified plan.





true 0 false false




100





<CommonParameters>




Examples

Example 1

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

ID : RP20111118193954234332

PlanName : plan1

Module : Replicator

Status : Finished

StartTime : 11/18/2011 7:39:54 PM

FinishTime : 11/18/2011 7:46:49 PM

Progress : 100

Description

This command runs a Replicator data import job based on plan1.

Related Links Run-DAReplicatorExportJob

Run-DAReplicatorOnlineJob

BLOB Provider


Get-DABLOBProviderBinariesInfo

Gets the BLOB provider binaries information.

101


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


Description

The Get-DABLOBProviderBinariesInfo cmdlet gets the BLOB provider binaries information, including

server name, service name, and whether agent and BLOB provider binaries are installed.

Parameters -FarmName<String>

Specifies a farm name. If you do not set any value for the parameter, all the farms' BLOB

provider binaries information will be returned.



false 0 true (ByValue) false

<CommonParameters>




Examples Example 1

PS C:\>Get-DABLOBProviderBinariesInfo -FarmName


FarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG)

Server : Server1

Service : {Microsoft SharePoint Foundation

Database, Managed Metadata Web Service, Business Data Connectivity

Service, Search Administration Web Service...}

AgentInstalled : True

BLOBProviderBinariesInstalled : True

Description

102


This command shows how to get the BLOB provider binaries information of a specified farm.

Related Links

Get-DAStubDBConfiguration

Gets the farm level stub database configuration.

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

Description

The Get-DAStubDBConfiguration cmdlet gets the farm level stub database configuration. You can

configure the stub database for farm, web application and content database via the configuration

instance.






false

<CommonParameters>




Examples

Example 1

PS C:\>$StubDBConfig = Get-DAStubDBConfiguration -FarmName


PS C:\>$StubDBConfig.WebApplicationStubDBConfigurations


103


WebApplicationUrl : http://SharePoint2010:10001/

DatabaseServer : Server\SharePoint

DatabaseName :

FailoverDatabaseServer :

Authentication : Windows

SQLAuthenticationAccount :



DatabaseServer : Server\SharePoint

DatabaseName :

FailoverDatabaseServer :

Authentication : Windows

SQLAuthenticationAccount :

Description

This command shows how to get stub database configuration of a specified farm. You can use the

"WebApplicationStubDBConfigurations" property to get all web applications' stub database

configurations. Also the "ContentDBStubDBConfigurations" property to get all content databases' stub

database configurations.

Related Links Configure-DAStubDB

Configure-DAStubDB

Configures stub database.

Syntax Configure-DAStubDB [-Configuration] <StubDBConfiguration>


Description

The Configure-DAStubDB cmdlet configures the stub database.

104


Parameters -Configuration<StubDBConfiguration>

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.




<CommonParameters>




Examples

Example 1



PS C:\>$ContentDBs =

$StubDBConfig.GetContentDBLevelStubDBConfigurationByName('WSS_Content_

10001')

PS C:\>$ContentDB1 = $ContentDBs[0]

PS

C:\>$ContentDB1.ConfigureAsWindowsAuthentication('DBServer','StubDB1')

PS C:\>$ContentDB1.FailoverDatabaseServer = 'FailoverDBServer'

PS C:\>Configure-DAStubDB -Configuration $ContentDB1

PS C:\>$ContentDB2 =

$StubDBConfig.GetContentDBLevelStubDBConfigurationById("f17d7594-d09a-

49a8-b41a-479a877a51d0")

PS C:\>$password = Read-Host -AsSecureString

*********

PS

C:\>$ContentDB2.ConfigureAsSQLAuthentication('DBServer','StubDB2','Use

rname',$password)

105


PS C:\>$ContentDB2.FailoverDatabaseServer = 'FailoverDBServer'

PS C:\>Configure-DAStubDB -Configuration $ContentDB2

Description

These commands show how to configure stub database for a content database as Windows

authentication or SQL authentication.

Example 2



PS C:\>$WebAppConfig =

$StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://ShareP

oint2010:10001/')

PS C:\>$password = Read-Host -AsSecureString

*********

PS

C:\>$WebAppConfig.ConfigureAsSQLAuthentication('DBServer','StubDB1','U

sername',$password)

PS C:\>$WebAppConfig.FailoverDatabaseServer = 'FailoverDBServer'

PS C:\>Configure-DAStubDB -Configuration $WebAppConfig

Description

These commands show how to configure stub database for a web application as SQL authentication.

Example 3



PS C:\>$WebAppConfig =

$StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://ShareP

oint2010:10001/')

PS C:\>$WebAppConfig.ConfigureByConnectionString('Data

Source=myServerAddress;Failover Partner=myMirrorServerAddress;Initial

Catalog=myDataBase;Integrated Security=true;')

PS C:\>Configure-DAStubDB -Configuration $WebAppConfig

Description

106


These commands configure a stub database for a specified Web application using the connection string.

Related Links Get-DAStubDBConfiguration

Get-DABLOBProviderConfiguration

Gets BLOB provider configuration.

Syntax Get-DABLOBProviderConfiguration [-FarmName] <String>


Description

The Get-DABLOBProviderConfiguration cmdlet gets the BLOB provider configuration of a specified farm.






false

<CommonParameters>




Examples Example 1

PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName


PS C:\>$BLOB.WebApplicationLevelRBSConfigurations

FarmName WebApplicationUrl

IncludeNewContentDBs

107


-------- ----------------- ---------------

-----

Farm(SP2010_DB:SHAREPOI... http://SharePoint2010:10001/

False


False


False


False

PS C:\>$BLOB.ContentDBLevelRBSConfigurations



ContentDBID : cee5aa66-2d6c-4719-9c28-aadc14d06a4d

ContentDBName : WSS_Content_10001

RBSEnabled : False

Description

This command shows how to get the BLOB provider configuration information of a specified farm.

Related Links Save-DABLOBProviderConfiguration

Save-DABLOBProviderConfiguration

Saves the BLOB provider configuration.

Syntax Save-DABLOBProviderConfiguration [-Configuration]

<BLOBProviderConfiguration> [-RunNow] [<CommonParameters>]

Description

The Save-DABLOBProviderConfiguration cmdlet saves the BLOB provider configuration to Manager.

108


Parameters -Configuration<BLOBProviderConfiguration>

Specifies the BLOB Provider configuration instance.




-RunNow[<SwitchParameter>]

Whether to run now after save the configuration.




<CommonParameters>




Examples Example 1



PS C:\>$ContentDBs =

$BLOB.GetContentDBLevelRBSConfigurationByName('WSS_Content_10001')

PS C:\>$ContentDB1 = $ContentDBs[0]

PS C:\>$ContentDB1.RBSEnabled = $true

PS C:\>$ContentDB2 =

$BLOB.GetContentDBLevelRBSConfigurationById('f17d7594-d09a-49a8-b41a-

479a877a51d0')

PS C:\>$ContentDB2.RBSEnabled = $true

PS C:\>$ContentDB1


109



ContentDBID : 9c9ee869-a8c9-44b5-afb6-c1a632c602a1


RBSEnabled : True

PS C:\>$ContentDB2



ContentDBID : 8c9be869-a839-4wb5-afb6-c1a732c602a5


RBSEnabled : True

PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB

Description

These commands show how to configure RBS for two content databases and save the configuration.

Example 2



PS C:\>$WebApp1 =

$BLOB.GetWebApplicationLevelRBSConfiguration('http://SharePoint2010:10

001/')

PS C:\>$WebApp1.IncludeNewContentDBs = $true

PS C:\>$TimeZoneID =

[DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime

PS C:\>$StartTime = Get-DADateTime -Year 2012 -Month 03 -Day 20 -Hour

14 -Minute 30 -TimeZoneId $TimeZoneID

PS C:\>$BLOB.Schedule.Enable($StartTime, '34d')

PS C:\>$BLOB.Schedule

110


Enabled : True

StartTime : 3/20/2012 2:30:00 PM (UTC-04:00) Santiago

Interval : 34D

EndTime :

NumberOfOccurrence : 0

PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB -RunNow

Description

These commands show how to configure "Include New Content Databases" for web application and run.

Example 3




Enabled : False

StartTime :

Interval :

EndTime :






PS C:\>$BLOB.Schedule.Enable($StartTime, '34d')


111


Enabled : True


Interval : 34D

EndTime :


PS C:\> Save-DABLOBProviderConfiguration -Configuration $BLOB

Description

These commands show how to configure a no end schedule for BLOB Provider.

Example 4




Enabled : False

StartTime :

Interval :

EndTime :





14 -M

inute 30 -TimeZoneId $TimeZoneID

PS C:\>$BLOB.Schedule.Enable($StartTime, '34d', 20)


112


Enabled : True


Interval : 34D

EndTime :



Description

These commands show how to set an end for occurrence schedule of BLOB Provider.

Example 5




Enabled : False

StartTime :

Interval :

EndTime :






PS C:\>$EndTime = Get-DADateTime -Year 2012 -Month 04 -Day 20 -Hour 14

-Minute 30 -TimeZoneId $TimeZoneID

PS C:\>$BLOB.Schedule.Enable($StartTime,'34d',$EndTime)

PS C:\>$blob.Schedule

113


Enabled : True


Interval : 34D

EndTime : 4/20/2012 2:30:00 PM (UTC-04:00) Santiago



Description

These commands show how to set an end for time schedule of BLOB Provider.

Related Links Get-DABLOBProviderConfiguration

Archiver


Run-DAArchiverJob

Runs Archiver job.

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


Description

The Run-DAArchiverJob cmdlet runs Archiver job.

Parameters -SPObject<SharePointObject>

The SharePoint object to be archived. Please refer to SDK documentation for the information of

SPObject constructors.




false

114








<CommonParameters>




Examples

Example 1



s/site1')

PS C:\>Run-DAArchiverJob -SPObject $site1

ID : AR20120710135406923230S

PlanName :

Module : Archiver

Status : Waiting

StartTime : 7/10/2012 1:54:06 PM

FinishTime :

Progress : 0

Description

These commands show how to archive site1.

115


Related Links

Run-DAArchiverIndexJob

Runs an archiver index job according to the job ID.

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

Description

The Run-DAArchiverIndexJob cmdlet runs an archiver index job according to the specified archiver index

job ID.

Parameters -JobId<String>

Specifies a job ID of an archiver index job.




<CommonParameters>




Examples Example 1

PS C:\>Run-DAArchiverIndexJob -JobId AI2012070101234567890

Description

This command shows how to run an archiver index job according to the specified job ID.

Related Links

Get-DAArchiverIndexDataInfo

Gets the information of the DocAve archiver data that has not been successfully indexed.

116


Syntax Get-DAArchiverIndexDataInfo [-FarmName] <String> [-OutPut] <String> [-

Overwrite] [<CommonParameters>]

Description

The Get-DAArchiverIndexDataInfo cmdlet gets the web application or the site collection whose archiver

data has not been successfully indexed.


Specifies the name of a farm where the archiver data’s index information will be gotten.



true 0 false false

-OutPut<String>

Specifies a path to store the output file.



true 1 false false

-Overwrite[<SwitchParameter>]

Overwrites the file if it already exists at the specified path.




<CommonParameters>




Examples

Example 1

PS C:\>Get-DAArchiverIndexDataInfo -FarmName

'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -OutPut C:\IndexInfo.xls

117


Description

This command shows how to get the Archiver data's index information from the specified farm.

Related Links Set-DAArchiverIndexDataInfo

Get-DAArchiverJobDetailForBackup

Gets Archiver job details for backup.

Syntax Get-DAArchiverJobDetailForBackup [-ID] <String> [-



Description The Get-DAArchiverJobDetailForBackup cmdlet gets job details for backup of the specified Archiver job.


Specifies the job ID.




false


Specifies the detail status to filter the detail. Valid values are "Success", "Failed", "Skipped" and

"Filtered".




-StartIndex<Int32>

Specifies the start number of the details that you want to get.




118


-Length<Int32>

Specifies the total number of details in the result.




<CommonParameters>




Examples

Example 1

PS C:\>Get-DAArchiverJobDetailForBackup -ID AR20120710135855645356A0

Key Value

--- -----

Type SiteCollection

Source URL

http://SharePoint2010/sites/site1

Media 10.2.6.110

Agent SP2010

Size 503.00KB

Status Successful

Finish Time 2012-07-10 14:15:02 (UTC-

08:00) Pacific Time (US & Canada)

Comment

Description

This command retrieves all backup details of the Archiver job.

119


Example 2

PS C:\>Get-DAArchiverJobDetailForBackup -ID AR20120710135855645356A0 -

JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1

Key Value

--- -----

Type SiteCollection

Source URL

http://SharePoint2010/sites/site1

Media 10.2.6.110

Agent SP2010

Size 503.00KB

Status Successful

Finish Time 2012-07-10 14:15:02 (UTC-


Comment

Description

This command retrieves the first backup detail of the Archiver job.

Related Links Get-DAArchiverJobDetailForDeletion

Get-DAArchiverJobDetailForDeletion

Gets Archiver job details for deletion.

Syntax Get-DAArchiverJobDetailForDeletion [-ID] <String> [-



Description The Get-DAArchiverJobDetailForDeletion cmdlet gets details for deletion of the specified Archiver job.

120







false



"Filtered".




-StartIndex<Int32>

Specifies the start number of the details that you want to get.




-Length<Int32>

Specifies the total number of details in the result.




<CommonParameters>




121


Examples

Example 1

PS C:\>Get-DAArchiverJobDetailForDeletion -ID AR20120710135855645356A0

Key Value

--- -----

Type Item

Source URL Shared Documents\Case.xlsx

Media 10MGRSHU

Agent 10SPSHU

Size 25.00KB

Status Successful

Finish Time 2012-07-10 14:15:43 (UTC-


Comment

Description

This command retrieves all deletion details of the Archiver job.

Example 2

PS C:\>Get-DAArchiverJobDetailForDeletion -ID AR20120710135855645356A0

-JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1

Key Value

--- -----

Type Item

Source URL Shared Documents\Case.xlsx

Media 10MGRSHU

Agent 10SPSHU

Size 25.00KB

122


Status Successful

Finish Time 2012-07-10 14:15:03 (UTC-


Comment

Description

This command retrieves the first deletion detail of the Archiver job.

Related Links Get-DAArchiverJobDetailForBackup

Set-DAArchiverIndexDataInfo

Sets the index information of the archiver data that has not been successfully indexed.

Syntax Set-DAArchiverIndexDataInfo [-Path] <String> [-OutPut] <String> [-


Description

The Set-DAArchiverIndexDataInfo sets the index information of the archiver data that has not been

successfully indexed.

Parameters -Path<String>

Specifies a path to load the file storing the archiver data’s index information.



true 0 false false

-OutPut<String>




true 1 false false


Overwrites the file if it already exists at the specified path.

123





<CommonParameters>




Examples

Example 1

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

C:\Result.xls

Description

This command shows how to set archiver data's index information in the loaded file.

Related Links Get-DAArchiverIndexDataInfo

Storage Manager


Export-DABLOBTraceOfStub

Exports the information of the item if the specified item is a stub.

Syntax Export-DABLOBTraceOfStub -Configuration <ExportBlobInfoConfiguration>


Description

The Export-DABLOBTraceOfStub cmdlet exports the information of the item if the specified item is a

stub.

Parameters -Configuration<ExportBlobInfoConfiguration>

Specifies the information of the item. The FarmName property represents the name of the farm

where the item resides; and the URL property represents the item's full path or the item's full

path followed by a version.

124





<CommonParameters>




Examples

Example 1

PS C:\>$config=New-Object

DocAve.Cmdlet.StorageOptimization.ExportBlobInfoConfiguration

PS C:\>$config.FarmName='Farm(SP201X_DB:SHAREPOINT_CONFIG)'

PS

C:\>$config.URL.Add('http://leafsp2010:1111/library1/document.docx:1.1

')

PS C:\>$result=Export-DABLOBTraceOfStub -Configuration $config

PS C:\>$result.StubTraceInfomation

ItemFullPath : http://leafsp2010:1111/library1/document.docx:1.1

FileName : 7816109b-b4bc-42cf-a476-cbb6a0c3d130

ItemSize : 2867

RBSId : 0x0000000000000009000000010002

BlobId : 0x444f4301xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

StubType : Scheduled

StubDBServer : 10.1.53.15

StubDBName : StubDB

StubInfoTable : StubInfo_83b53a95_f74c_4371_8bc4_91f071aad6ba

StubId : 7816109b-b4bc-42cf-a476-cbb6a0c3d130

DeviceName : DeviceName

125


FolderName :

Data_Extender\Farm(SP201X_DB:SHAREPOINT_CONFIG)\webAppUrl\d8dcb342-

50ef-4d9e-9

d9a-10ea929d4edb\7\8

BlobName : 7816109b-b4bc-42cf-a476-cbb6a0c3d130

ProviderType : RBS

IsOrphanStub : False

BSN : 671

LastAccessTime :

Description


stub.

Example 2

PS C:\>$config=New-Object

DocAve.Cmdlet.StorageOptimization.ExportBlobInfoConfiguration

PS C:\>$config.FarmName='Farm(SP201X_DB:SHAREPOINT_CONFIG)'

PS

C:\>$config.URL.Add('http://leafsp2010:1111/library1/document.docx:1.1

')

PS C:\>$result=Export-DABLOBTraceOfStub -Configuration $config

PS C:\>$result.FailedType

FarmNameNotExisting

Description


stub.

Related Links

New-DARemapStorageManagerLogicalDeviceConfiguration

Creates a Storage Manager logical device mapping configuration object.

126


Syntax New-DARemapStorageManagerLogicalDeviceConfiguration


Description

The New-DARemapStorageManagerLogicalDeviceConfiguration cmdlet creates a Storage Manager

logical device mapping configuration object.





Examples

Example 1

PS C:\>$config = New-DARemapStorageManagerLogicalDeviceConfiguration

#Enter the name of the Disaster Recovery farm.

PS C:\>$config.FarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)'

#Enter the name of the SQL Server Instance.

PS C:\>$config.ContentDBServer = 'Server\SharePoint'

#Enter the name of the content database in the Disaster Recovery farm.

PS C:\>$config.ContentDBName ='WSS_Content_1000'

#Specify a default destination logical device. If no destination

logical device is configured for a source logical device. The default

logical device will be used to store the BLOB data copied from the

127


specified source logical device. When mapping the logical devices, you

can choose to only use the default destination logical device, or

combine the usage of the device mapping and the default destination

logical device.

PS C:\>$config.DefaultDestinationLogicalDevice ='default logical

device'

#'true' means to copy the BLOB data and update the logical device

information for the stubs; 'false' means to only update the logical

device information for the stubs.;

'false' means only change stub information.

PS C:\>$config.CopyBLOBData =$true

#Enter a logical device mapping rule.

PS C:\>$config.LogicalDeviceMapping.Add('source logical

device','destination logical device')

PS C:\>$config.LogicalDeviceMapping.Add('source logical

device1','destination logical device1')

Description

This command creates a Storage Manager logical device mapping configuration object.

Related Links Remap-DAStorageManagerLogicalDevice

Remap-DAStorageManagerLogicalDevice

Maps the source Storage Manager logical devices to the destination Storage Manager logical devices.

Syntax Remap-DAStorageManagerLogicalDevice -Configuration

<CopyBlobAndRemapDeviceRequestConfig> [<CommonParameters>]

128


Description

The Remap-DAStorageManagerLogicalDevice cmdlet maps the source Storage Manager logical devices

to the destination Storage Manager logical devices.

Parameters -Configuration<CopyBlobAndRemapDeviceRequestConfig>

Specifies the configurations to map the source Storage Manager logical devices to the

destination Storage Manager logical devices.




<CommonParameters>




Examples

Example 1

PS C:\>$result =Remap-DAStorageManagerLogicalDevice -Configuration

$config

Finish

PS C:\>$result.Succeeded

10000

PS C:\>$result.Failed

0

129


Description

This command maps the source Storage Manager logical devices to the destination Storage Manager

logical devices.

Related Links New-DARemapStorageManagerLogicalDeviceConfiguration

Real-Time Storage Manager


Get-DARealtimeStorageManagerRule

Gets the real-time storage manager rule(s) based on different parameters you have configured.

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

Get-DARealtimeStorageManagerRule [-SPWebApplication

<SharePointWebApplication>] [<CommonParameters>]

Get-DARealtimeStorageManagerRule [-SPContentDB <SharePointContentDB>]


Get-DARealtimeStorageManagerRule [-SPSite <SharePointSite>]


Description

The Get-DARealtimeStorageManagerRule cmdlet gets the real-time storage manager rules according to

the specified rule name, the SharePoint content database, web application or site collection. If no

parameter value is entered, all the existing real-time storage manager rules' configurations will be

gotten.


Specifies the name of the real-time storage manager rule whose configurations will be gotten.



false named true (ByValue) false

130


-SPWebApplication<SharePointWebApplication>

Specifies a SharePoint web application. All the real-time storage manager rules that have been

applied to this specified web application will be gotten.




-SPContentDB<SharePointContentDB>

Specifies a SharePoint content database. All the real-time storage manager rules that have been

applied to this specified database will be gotten.




-SPSite<SharePointSite>

Specifies a SharePoint site collection. All the real-time storage manager rules that have been

applied to this specified site collection will be gotten.




<CommonParameters>




Examples

Example 1

PS C:\>Get-DARealtimeStorageManagerRule

Name : rule1

Description :

131


SizeThreshold : 2MB

LogicalDeviceName : logical device1

CompressionLevel : Level1


SecurityProfileName :

Name : rule2

Description :

SizeThreshold : 512KB


CompressionLevel : None


SecurityProfileName : security profile1

Description

This command gets all the existing real-time storage manager rules.

Example 2

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

Name : rule2

Description :





132



Description

This command gets the real-time storage manager rule that has the specified name.

Example 3

PS C:\>$db = New-Object DocAve.API.Objects.SharePointContentDB

'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/',

'wss_content_10001'

PS C:\>Get-DARealtimeStorageManagerRule -SPContentDB $db

Name : rule1

Description :

SizeThreshold : 2MB





Name : rule2

Description :






133


Description

These commands get the real-time storage manager rules that have been applied to the specified

SharePoint content database. In the very similar way, you can get rules applied on a web application or a

site collection.

Related Links

Get-DARealtimeStorageManagerBlankRule

Gets a blank real-time storage manager rule without any configurations.

Syntax Get-DARealtimeStorageManagerBlankRule [<CommonParameters>]

Description

The Get-DARealtimeStorageManagerBlankRule cmdlet gets a blank real-time storage manager rule

without any configurations.





Examples

Example 1

PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule

PS C:\>$rule

Name :

Description :

SizeThreshold :

LogicalDeviceName :


134




Description

This command gets a blank real-time storage manager rule where it allows you to configure a new real-

time storage manager rule.

Related Links

New-DARealtimeStorageManagerRule

Creates a new real-time storage manager rule.

Syntax New-DARealtimeStorageManagerRule [-Rule] <RealtimeStorageManagerRule>


Description

The New-DARealtimeStorageManagerRule cmdlet creates a new real-time storage manager rule.

Parameters -Rule<RealtimeStorageManagerRule>

Specifies a real-time storage manager rule object where you can create a new real-time storage

manager rule.




<CommonParameters>




Examples

Example 1

PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule

PS C:\>$rule.Name = 'rule1'

135


PS C:\>$rule.SizeThreshold = '768kb'

PS C:\>$rule.LogicalDeviceName = 'logical device1'

PS C:\>$rule.CompressionLevel = 'level3'

PS C:\>$rule.EnableDataEncryption('MyProfile')

PS C:\>New-DARealtimeStorageManagerRule -Rule $rule

Description

These commands create a new real-time storage manager rule based on a blank rule.

Related Links

Update-DARealtimeStorageManagerRule

Updates the configurations of an existing real-time storage manager rule.

Syntax Update-DARealtimeStorageManagerRule [-Rule]

<RealtimeStorageManagerRule> [<CommonParameters>]

Description The Update-DARealtimeStorageManagerRule cmdlets updates the configurations of an existing real-

time storage manager rule.

Parameters -Rule<RealtimeStorageManagerRule>

Specifies a real-time storage manager rule object whose configurations will be updated.




<CommonParameters>




Examples

Example 1

136


PS C:\>$rule = Get-DARealtimeStorageManagerRule -Name 'rule1'

PS C:\>$rule.Name = 'rule2'

PS C:\>$rule.CompressionLevel = 'level7'

PS C:\>Update-DARealtimeStorageManagerRule -Rule $rule

Description

These commands update the configurations of the specified real-time storage manager rule.

Related Links

Remove-DARealtimeStorageManagerRule

Deletes an existing real-time storage manager rule according to the rule's name.

Syntax Remove-DARealtimeStorageManagerRule [-Name] <String>


Description

The Remove-DARealtimeStorageManagerRule cmdlet deletes an existing real-time storage manager rule

according to the rule's name.


Specifies the name of a real-time storage manager rule that you want to delete.




<CommonParameters>




Examples

Example 1

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

137


Description

This command deletes the real-time storage manager rule with the specified name.

Related Links

Reuse-DARealtimeStorageManagerRule

Reuses an existing real-time storage manager rule to a specified SharePoint content database, a web

application or a site collection.

Syntax Reuse-DARealtimeStorageManagerRule -RuleName <String> [-SPContentDB

<SharePointContentDB>] [<CommonParameters>]

Reuse-DARealtimeStorageManagerRule -RuleName <String> [-

SPWebApplication <SharePointWebApplication>] [<CommonParameters>]

Reuse-DARealtimeStorageManagerRule -RuleName <String> [-SPSite

<SharePointSite>] [<CommonParameters>]

Description

The Reuse-DARealtimeStorageManagerRule cmdlet reuses an existing real-time storage manager rule to

a specified SharePoint content database, a web application or a site collection.

Parameters -RuleName<String>

Specifies the name of the real-time storage manager rule that you want to reuse.



true named true (ByValue) false


Specifies a SharePoint content database where the specified real-time storage manager rule will

be applied.




138



Specifies a SharePoint web application where the specified real-time storage manager rule will

be applied.





Specifies a SharePoint site collection where the specified real-time storage manager rule will be

applied.




<CommonParameters>




Examples

Example 1



'wss_content_10001'

PS C:\>Reuse-DARealtimeStorageManagerRule -RuleName 'rule1' -

SPContentDB $db

Description These commands apply the specified real-time storage manager rule to the specified SharePoint content

database. In the very similar way, you can apply an existing rule to a web application or a site collection.

Related Links

Retract-DARealtimeStorageManagerRule

Retracts an already applied real-time storage manager rule from the specified SharePoint content

database, web application, or site collection.

139


Syntax Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPContentDB

<SharePointContentDB>] [<CommonParameters>]

Retract-DARealtimeStorageManagerRule -RuleName <String> [-

SPWebApplication <SharePointWebApplication>] [<CommonParameters>]

Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPSite

<SharePointSite>] [<CommonParameters>]

Description

The Retract-DARealtimeStorageManagerRule cmdlet retracts an already applied real-time storage

manager rule from the specified SharePoint content database, web application, or site collection.

Parameters -RuleName<String>

Specifies the name of the real-time storage manager rule that you want to retract from the

specified SharePoint content database.



true named true (ByValue) false


Specifies a SharePoint content database where the specified real-time storage manager rule will

be retracted.





Specifies a SharePoint web application where the specified real-time storage manager rule will

be retracted.




140



Specifies a SharePoint site collection where the specified real-time storage manager rule will be

retracted.




<CommonParameters>




Examples

Example 1



'wss_content_10001'

PS C:\>Retract-DARealtimeStorageManagerRule -RuleName 'rule1' -

SPContentDB $db

Description

These commands retract the specified real-time storage manager rule from the specified SharePoint

content database. In the very similar way, you can retract rule from a web application or a site

collection.

Related Links

SharePoint Migration


Get-DASPMigrationJobObjectsDetail

Gets the detailed information of the objects in a SharePoint online migration job.

Syntax Get-DASPMigrationJobObjectsDetail [-ID] <String> [-



141


Description

The Get-DASPMigrationJobObjectsDetail cmdlet gets the detailed information of the objects in a

SharePoint online migration job.


Specifies a job ID to get the detailed object information.




false


Specifies a status filter to only display the object details of the specified status. The valid values

are "Success", "Failed", "Skipped" and "Filtered".




-StartIndex<Int32>

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<Int32>

Specifies the number of object details to be displayed.




142


<CommonParameters>




Examples

Example 1

PS C:\>Get-DASPMigrationJobObjectsDetail -ID MD20120601151648823941

Key Value

--- -----

Date

Type Web Application

Source URL http://SharePoint2007:10001/

Target URL http://SharePoint2010:10002/

Source Agent server1

Target Agent server2

Size 100Bytes

Status Successful

Operation Skipped

Comment

Truncated Policy

Target Owner

Custom Metadata

Description

This command gets all the objects' detailed information of the specified Job.

Example 2

PS C:\>Get-DASPMigrationJobObjectsDetail -ID MD20120601151648823941-


143


Key Value

--- -----

Date






Size 100Bytes

Status Successful

Operation Skipped

Comment

Truncated Policy

Target Owner

Custom Metadata

Description

This command only gets the detailed information of the first successfully migrated object in the

specified job.

Related Links Get-DASPMigrationJobConfigurationDetail

Get-SASP07To10MigrationJobPermissionDetail

Get-DASPMigrationJobConfigurationDetail

Gets the detailed configuration information of the specified SharePoint online migration job.

Syntax Get-DASPMigrationJobConfigurationDetail [-ID] <String> [-



144


Description

The Get-DASPMigrationJobConfigurationDetail cmdlet gets the detailed configuration information of a

SharePoint online migration job according to the specified Job ID.


Specifies a Job ID to get the detailed job configurations.




false


Specifies a status filter to only display the configuration details of the specified status. The valid

values are "Success", "Failed", "Skipped" and "Filtered".




-StartIndex<Int32>

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





-Length<Int32>

Specifies the number of the configuration details to be displayed.




145


<CommonParameters>




Examples

Example 1

PS C:\>Get-DASPMigrationJobConfigurationDetail -ID

MD20120601151648823941

Key Value

--- -----

Date

Property List Column

Type List

Name Content Type ID

Related Object Title Form Templates

Source URL

http://SharePoint2007:10001/sites/site1/list1

Target URL


Status Successful

Comment

Description

This command gets the detailed job configurations of the specified SharePoint online migration job.

Example 2

PS C:\>Get-DASPMigrationJobConfigurationDetail -ID

MD20120601151648823941 -JobReportDetailStatus Success -StartIndex 0 -

Length 1

Key Value

146


--- -----

Date


Type List



Source URL


Target URL


Status Successful

Comment

Description

This command only gets the configuration details of the first successfully migrated object in the

specified job.

Related Links Get-DASPMigrationJobObjectsDetail

Get-DASPMigrationJobPermissionDetail

Get-DASPMigrationJobPermissionDetail

Gets the permission configurations of a specified SharePoint online migration job.

Syntax Get-DASPMigrationJobPermissionDetail [-ID] <String> [-



Description

TheGet-DASPMigrationJobPermissionDetail cmdlet gets the permission configurations of a SharePoint

online migration job according to the specified Job ID.

147



Specifies a Job ID to get the detailed permission configurations.




false


Specifies a status filter to only display the permission details of the specified status. The valid

values are "Success", "Failed", "Skipped" and "Filtered".




-StartIndex<Int32>

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





-Length<Int32>

Specifies the number of the permission details to be displayed.




<CommonParameters>




148


Examples

Example 1

PS C:\>Get-DASPMigrationJobPermissionDetail -ID MD20120601151648823941

Key Value

--- -----

Date

User\Group User

Type List

Name example.com\user1


Source URL

http://SharePoint2007:10001/sites/site1/list

Target URL


Status of User\Groups Skipped

Comment

Description

This command gets all the objects' security configuration information of the specified job.

Example 2

PS C:\>Get-DASPMigrationJobPermissionDetail -ID

MD20120601151648823941-JobReportDetailStatus Success -StartIndex 0 -

Length 1

Key Value

--- -----

Date

User\Group User

Type List

149




Source URL


Target URL



Comment

Description

This command only gets the permission details of the first successfully migrated object in the specified

job.

Related Links Get-DASPMigrationJobConfigurationDetail

Get-DASPMigrationJobObjectsDetail



Get-DASP07To10MigrationOnlinePlan

Gets the plan settings of the specified SharePoint 2007 to 2010 online migration plan(s).

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


Description The Get-DASP07To10MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint

2007 to 2010 online migration plan(s).


Specifies the name(s) of the existing SharePoint 2007 to 2010 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

2010 online migration plan(s) will be obtained.

150





true

<CommonParameters>




Examples

Example 1

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

SourceFarmName : Farm(SP2007_DB:SH

AREPOINT_CONFIG)

DestinationFarmName : Farm(SP2010_DB:SH

AREPOINT_CONFIG)

SourceAgentGroupName : DEFAULT_AGENT_GRO

UP_FOR_Farm(SP200

7_DB:SHAREPOINT_C

ONFIG)

DestinationAgentGroupName : DEFAULT_AGENT_GRO

UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)

SourceTree : DocAve.API.Migrat

ion.SP07To10Migra

tion.SP07To10Migr

ationSourceTree

151


DestinationTree : DocAve.API.Migrat

ion.SP07To10Migra

tion.SP07To10Migr

ationDestinationT

ree

Action : Merge

MigrationDatabaseName : MigrationDB

UseSpecifiedMigrationDatabaseToStoreTheJobData : False

Schedules : {}

Name : plan1

Description :

ProfileName : Default Profile



Description

This command gets the plan settings of the specified plan.

Related Links New-DASP07To10MigrationOnlinePlan

Update-DASP07To10MigrationOnlinePlan

Remove-DASP07To10MigrationOnlinePlan

Get-DASP07To10MigrationBlankOnlinePlan

Gets a blank SharePoint 2007 to 2010 online migration plan without any plan settings.

Syntax Get-DASP07To10MigrationBlankOnlinePlan [<CommonParameters>]

Description The Get-DASP07To10MigrationBlankOnlinePlan cmdlet gets a blank SharePoint 2007 to 2010 online

migration plan for creating a new plan.

152






Examples

Example 1

PS C:\>$plan = Get-DASP07To10MigrationBlankOnlinePlan

PS C:\>$plan

SourceFarmName :


SourceAgentGroupName :

DestinationAgentGroupName :


ion.SP07To10Migra

tion.SP07To10Migr

ationSourceTree


ion.SP07To10Migra

tion.SP07To10Migr

ationDestinationT

ree

Action : Merge

MigrationDatabaseName :


Schedules : {}

Name :

153


Description :

ProfileName :

NotificationName :

NotificationName :


Description

This command gets a blank SharePoint 2007 to 2010 online migration plan that has no plan settings

configured.


New-DASP07To10MigrationOnlinePlan

Creates a new SharePoint 2007 to 2010 online migration plan.

Syntax New-DASP07To10MigrationOnlinePlan [-Plan]

<SP07To10MigrationOnlinePlan> [<CommonParameters>]

Description

The New-DASP07To10MigrationOnlinePlan cmdlet creates a new SharePoint 2007 to 2010 online

migration plan.

Parameters -Plan<SP07To10MigrationOnlinePlan>

Specifies a SharePoint 2007 to 2010 Migration online plan object. About the structure and

attribute of SP07To10MigrationOnlinePlan, please refer to the SDK documentation for more

information.




<CommonParameters>




154


Examples

Example 1



PS C:\>$plan.Description = 'Description'

PS C:\>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)'

PS C:\>$plan.DestinationFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)'

PS C:\>$plan.SourceAgentGroupName = 'AgentGroup07'

PS C:\>$plan.DestinationAgentGroupName = 'AgentGroup10'

PS C:\>$plan.ProfileName = 'Default Profile'


PS C:\>$list07 = New-Object

DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)',

'http://SharePoint2007:10001/sites/site1','/sites/site1', 'list1')

PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false)




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



PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true

PS C:\>$scheduleForFullJob = New-Object

DocAve.API.Migration.SP07To10Migration.SP07To10MigrationSchedule

PS C:\>$scheduleForFullJob.JobOption = "Full"

PS C:\>$scheduleForFullJob.ConflictResolution = "MergeAndOverwrite"

PS C:\>$scheduleForFullJob.StartTime = "2013-10-10 13:00"

PS C:\>$scheduleForFullJob.TimeZoneId = "Pacific Standard Time"

PS C:\>$scheduleForFullJob.Interval = "2Day"

155


PS C:\>$scheduleForFullJob.NumberOfOccurrence = 1

PS C:\>$plan.Schedules.Add($scheduleForFullJob)

PS C:\>$scheduleForIncrementalJob = New-Object


PS C:\>$scheduleForIncrementalJob.JobOption = "Incremental"

PS C:\>$scheduleForIncrementalJob.ConflictResolution = "Skip"

PS C:\>$scheduleForIncrementalJob.StartTime = "2013-10-12 13:00"

PS C:\>$scheduleForIncrementalJob.TimeZoneId = "Pacific Standard Time"

PS C:\>$scheduleForIncrementalJob.Interval = "2Day"

PS C:\>$scheduleForIncrementalJob.SetNoEnd()

PS C:\>$plan.Schedules.Add($scheduleForIncrementalJob)

PS C:\>New-DASP07To10MigrationOnlinePlan -Plan $plan

Description

These commands show how to create a SharePoint 2007 to 2010 online migration plan by getting a

blank plan.

Related Links Get-DASP07To10MigrationBlankOnlinePlan

Update-DASP07To10MigartionOnlinePlan

Remove-DASP07To10MigartionOnlinePlan

Get-DASP07To10MigartionOnlinePlan


Updates an existing SharePoint 2007 to 2010 online migration plan.

Syntax Update-DASP07To10MigrationOnlinePlan [-Plan]


Description

The Update-DASP07To10MigrationOnlinePlan cmdlet updates an existing SharePoint 2007 to 2010

online migration plan.

156



Specifies a plan name to get an existing SharePoint 2007 to 2010 online migration plan for

editing.




<CommonParameters>




Examples

Example 1

PS C:\>$plan = Get-DASP07To10MigrationOnlinePlan -Name 'plan1'


PS C:\>$plan.Description = 'New Description'



PS C:\>$plan.SourceAgentGroup = 'AgentGroup07'

PS C:\>$plan.DestinationAgentGroup = 'AgentGroup10'




'htt

p://SharePoint2007:10001/sites/site1','/sites/site1', 'list1')




'htt


157






PS C:\>Update-DASP07To10MigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified SharePoint 2007 to 2010 online migration

plan.

Related Links Get-DASP07To10MigrationOnlinePlan

New-DASP07to10MigrationOnlinePlan



Deletes the specified SharePoint 2007 to 2010 online migration plan.

Syntax Remove-DASP07To10MigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DASP07To10MigrationOnlinePlan cmdlet deletes the specified SharePoint 2007 to 2010



Specifies the name of a SharePoint 2007 to 2010 online migration plan that you want to delete.




158




command.









<CommonParameters>




Examples

Example 1

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

Description

This command deletes the specified plan.



New-SP07To10MigrationOnlinePlan

Run-DASP07To10MigrationOnlineJob

Runs a SharePoint 2007 to 2010 online migration plan.

Syntax Run-DASP07To10MigrationOnlineJob [-PlanName] <String> -Options

<String> [-IncrementalType <String>] -ConflictResolution

159


<SP07To10MigrationConflictResolution> -JobReportType <String> [-

Description <String>] [-TestRun] [-WaitForJobComplete]


Description The Run-DASP07To10MigrationOnlineJob cmdlet runs a SharePoint 2007 to 2010 online migration plan.


Specifies the name of an existing SharePoint 2007 to 2013 online migration plan that you want

to run.




-Options<String>

Specifies to run a full or an incremental migration job of the selected migration plan. The valid

values are "Full" and "Incremental".




-IncrementalType<String>

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<SP07To10MigrationConflictResolution>

Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are

"Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip",

"MergeAndOverwrite" and "MergeAndAppend".

160





-JobReportType<String>

Specifies the job report level. The valid values are "Simplified" and "Detailed".




-Description<String>

Specifies the description of the SharePoint 2007 to 2010 online migration plan that you want to

run.











and another job can be run until this job has completed; if not, the job will run in the





<CommonParameters>




161


Examples

Example 1

PS C:\>Run-DASP07To10MigrationOnlineJob -PlanName 'plan1' -Options

Full -ConflictResolution Skip -JobReportType Detailed -Description

description -WaitForJobComplete

ID : MD20120710144929298926

PlanName : plan1

Module : SharePointMigration

Status : Finished

StartTime : 7/10/2012 2:49:29 PM

FinishTime : 7/10/2012 3:19:44 PM

Progress : 100

Description

This command runs the specified SharePoint 2007 to 2010 online migration plan in full.

Example 2


Incremental -IncrementalType 123hour -ConflictResolution Skip -

JobReportType Detailed -Description description -WaitForJobComplete -

TestRun

ID : MD20120710142929238219

PlanName : plan2


Status : Finished

StartTime : 7/10/2012 2:54:29 PM

FinishTime : 7/10/2012 3:29:44 PM

Progress : 100

Description

162


This command simulates an incremental migration job of the specified SharePoint 2007 to 2010 online

migration plan.


Get-DASP07To10MigrationJobConfigurationDetail

Gets the detailed information of a specified SharePoint 2007 to 2010 migration job.

Syntax Get-DASP07To10MigrationJobConfigurationDetail [-ID] <String> [-



Description

The Get-DASP07To10MigrationJobConfigurationDetail cmdlet gets the detailed information of a

SharePoint 2007 to 2010 migration job according to the specified Job ID.


Specifies a Job ID to get the detailed job information.




false


Specifies a job status of the migrated objects that is used to filter which migrated objects' job

detail will be displayed. The available values are "Success", "Failed", "Skipped" and "Filtered".




163


-StartIndex<Int32>






-Length<Int32>





<CommonParameters>




Examples

Example 1

PS C:\>Get-DASP07To10MigrationJobConfigurationDetail -ID

MD20120601151648823941

Key Value

--- -----

Date


Type List



Source URL


164


Target URL


Status Successful

Comment

Description

This command gets the detailed job configurations of the specified SharePoint 2007 to 2010 online

migration plan.

Example 2

PS C:\>Get-DASP07To10MigrationJobConfigurationDetail -ID

MD20120601151648823941 -JobReportDetailStatus Success -StartIndex 0 -

Length 1

Key Value

--- -----

Date


Type List



Source URL


Target URL


Status Successful

Comment

Description

This command gets the first successfully migrated configuration's detailed information of the specified

job.

Related Links Get-DASP07To10MigrationJobObjectsDetail

165


Get-DASP07To10MigrationJobPermissionDetail

Get-DASP07To10MigrationJobObjectsDetail

Gets the detailed information of the objects in a SharePoint 2007 to 2010 online migration job.

Syntax Get-DASP07To10MigrationJobObjectsDetail [-ID] <String> [-



Description

The Get-DASP07To10MigrationJobObjectsDetail cmdlet gets the detailed information of the objects in a

SharePoint 2007 to 2010 online migration job.


Specifies a job ID to get the object information.




false


Specifies a job status of the migrated objects that is used to filter which migrated object's

detailed information will be displayed. The available values are "Success", "Failed", "Skipped"

and "Filtered".




-StartIndex<Int32>

Specifies a start number. The object detail will be displayed starting from the specified number

of objects whose job status is specified value for the parameter "JobReportDetailStatus".




166


-Length<Int32>

Specifies how many object's security configuration will be displayed.




<CommonParameters>




Examples

Example 1

PS C:\>Get-DASP07To10MigrationJobObjectsDetail -ID

MD20120601151648823941

Key Value

--- -----

Date






Size 100Bytes

Status Successful

Operation Skipped

Comment

Truncated Policy

Target Owner

167


Custom Metadata

Description

This command gets all the objects' detailed information of the specified Job.

Example 2

PS C:\>Get-DASP07To10MigrationJobObjectsDetail -ID


Length 1

Key Value

--- -----

Date






Size 100Bytes

Status Successful

Operation Skipped

Comment

Truncated Policy

Target Owner

Custom Metadata

Description

This command gets the first successfully migrated object's detailed information of the specified job.

Related Links Get-DASP07to10MigrationJobConfigurationDetail

Get-SASP07To10MigrationJobPermissionDetail

168


Get-DASP07To10MigrationJobPermissionDetail

Gets the permission configuration of a specified SharePoint 2007 to 2010 migration job.

Syntax Get-DASP07To10MigrationJobPermissionDetail [-ID] <String> [-



Description

TheGet-DASP07To10MigrationJobPermissionDetail cmdlet gets the permission configuration of a

SharePoint 2007 to 2010 migration job by specified Job ID.


Specifies a Job ID to get the detailed security configuration information of the objects.




false


Specifies a job status of the migrated objects that is used to filter which migrated object's

security configuration will be displayed. The available values are "Success", "Failed", "Skipped"

and "Filtered".




-StartIndex<Int32>

Specifies a start number. The security configuration will be displayed starting from the specified

number of objects whose job status is specified value for the parameter

"JobReportDetailStatus".




169


-Length<Int32>

Specifies how many object's security configuration will be displayed.







Examples

Example 1

PS C:\>Get-DASP07To10MigrationJobPermissionDetail -ID

MD20120601151648823941

Key Value

--- -----

Date

User\Group User

Type List



Source URL

http://SharePoint2007:10001/sites/site1/list

Target URL



Comment

Description

This command gets all the objects' security configuration information of the specified job.

170


Example 2

PS C:\>Get-DASP07To10MigrationJobPermissionDetail -ID


Length 1

Key Value

--- -----

Date

User\Group User

Type List



Source URL


Target URL



Comment

Description

This command gets the first successfully migrated object's security configuration information of the

specified job.

Related Links Get-DASP07To10MigrationJobConfigurationDetail

Get-DASP07To10MigrationJobObjectsDetail

Download-DASP07To10MigrationOnlineProfile

Downloads the SharePoint 2007 to 2010 online migration profile.

Syntax Download-DASP07To10MigrationOnlineProfile [-Name] <String> [-Path]

<String> [-Overwrite] [<CommonParameters>]

171


Description

The Download-DASP07To10MigrationOnlineProfile cmdlet downloads the SharePoint 2007 to 2010

online migration profile to an XML file.


Specifies the profile name.



true 0 false false -Path<String>

Specifies the path to store the downloaded XML file.



true 1 false false -Overwrite[<SwitchParameter>]

Allows the cmdlet to overwrite an existing file.







Examples

Example 1

PS C:\>Download-DASP07To10MigrationOnlineProfile -Name

'SP07To10MigrationOnlineProfile1' -Path

'C:\SP07To10MigrationOnlineProfile1.xml' -Overwrite

Description

This command downloads the SharePoint 2007 to 2010 online migration profile to an XML file.

Related Links Upload-DASP07To10MigrationOnlineProfile

172


Upload-DASP07To10MigrationOnlineProfile

Uploads the SharePoint 2007 to 2010 online migration profile.

Syntax Upload-DASP07To10MigrationOnlineProfile [-Path] <String> [-Overwrite]


Description

The Upload-DASP07To10MigrationOnlineProfile cmdlet uploads the SharePoint 2007 to 2010 online

migration profile from an XML file.


Specifies the path of the XML file.



true 0 true (ByValue) false -Overwrite[<SwitchParameter>]

Allows the cmdlet to overwrite an existing profile.







Examples Example 1

PS C:\>Upload-DASP07To10MigrationOnlineProfile -Path


Description

This command uploads the SharePoint 2007 to 2010 online migration profile to manager.

Related Links Download-DASP07To10MigrationOnlineProfile

173








Description

The Get-DASP07To13MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint










true

<CommonParameters>




Examples

Example 1



AREPOINT_CONFIG)


174


AREPOINT_CONFIG)



UP_FOR_Farm(SP200

7_DB:SHAREPOINT_C

ONFIG)


UP_FOR_Farm(SP201

3_DB:SHAREPOINT_C

ONFIG)


ion.SP07To13Migra

tion.SP07To13Migr

ationSourceTree


ion.SP07To13Migra

tion.SP07To13Migr

ationDestinationT

ree

Action : Merge



Schedules : {}

Name : plan1

Description :



175



Description








Description

The Get-DASP07To13MigrationBlankOnlinePlan cmdlet gets a blank SharePoint 2007 to 2013 online

migration plan for creating a new plan.





Examples

Example 1


PS C:\>$plan

SourceFarmName :




176




ion.SP07To13Migra

tion.SP07To13Migr

ationSourceTree


ion.SP07To13Migra

tion.SP07To13Migr

ationDestinationT

ree

Action : Merge



Schedules : {}

Name :

Description :

ProfileName :

Notification :


Description


configured.




177




Description


migration plan.




information.







Examples

Example 1













178





























Description

179


These commands show how to create a SharePoint 2007 to SharePoint 2013 online migration plan. The

destination is from SharePoint On-Premises farm.

Example 2





PS C:\>$plan.DestinationSPSitesGroupName = 'Default_SharePoint

Sites_Group'








PS C:\>$listOnline = New-Object

DocAve.API.Objects.SharePointOnlineList('Default_SharePoint

Sites_Group', 'http://SharePointServer/sites/site1','/sites/site1',

'list1')

PS C:\>$plan.DestinationTree.SelectSPOnlineObject($listOnline)





Description

These commands show how to create a SharePoint 2007 to SharePoint Online 2013 online migration

plan. The destination is from My Registered Sites.


180









Description

The Update-DASP07To13MigrationOnlinePlan cmdlet updates an existing SharePoint 2007 to 2013




editing.







Examples

Example 1







181






'htt





'htt







Description


plan.








182


Description







true 0 true (ByValue) false -WhatIf[<SwitchParameter>]


command.



false named false false -Confirm[<SwitchParameter>]








Examples

Example 1


Description




183








TestRun] [-WaitForJobComplete] [<CommonParameters>]

Description

The Run-DASP07To13MigrationOnlineJob cmdlet runs a SharePoint 2007 to 2013 online migration plan.



to run.



true 0 true (ByValue) false -Options<String>





true named false false -IncrementalType<String>








false named false false -ConflictResolution<SP07To13MigrationConflictResolution>

184







true named false false -JobReportType<String>




true named false false -TestRun[<SwitchParameter>]




false named false false -WaitForJobComplete[<SwitchParameter>]










Examples

Example 1


Full -ConflictResolution Skip -JobReportType Detailed -

WaitForJobComplete

ID : MD20120710144929298926

PlanName : plan1

185



Status : Finished

StartTime : 7/10/2012 2:49:29 PM

FinishTime : 7/10/2012 3:19:44 PM

Progress : 100

Description


Example 2



JobReportType Detailed -WaitForJobComplete -TestRun

ID : MD20120710142929238219

PlanName : plan2


Status : Finished

StartTime : 7/10/2012 2:54:29 PM

FinishTime : 7/10/2012 3:29:44 PM

Progress : 100

Description


migration plan.




186




Description



















Examples

Example 1




Description


187







Description

The Upload-DASP07To13MigrationOnlineProfile cmdlet uploads the SharePoint 2007 to 2013 online














Examples

Example 1



Description


188









Description

The Get-DASP10To13MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint










true

<CommonParameters>




Examples

Example 1



189


AREPOINT_CONFIG)


AREPOINT_CONFIG)


UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)


UP_FOR_Farm(SP201

3_DB:SHAREPOINT_C

ONFIG)



ion.SP10To13Migra

tion.SP10To13Migr

ationSourceTree


ion.SP10To13Migra

tion.SP10To13Migr

ationDestinationT

ree

Action : Merge



Schedules : {}

Name : plan1

Description :

190





Description








Description


configured.





Examples

Example 1


PS C:\>$plan

SourceFarmName :


191






ion.SP10To13Migra

tion.SP10To13Migr

ationSourceTree


ion.SP10To13Migra

tion.SP10To13Migr

ationDestinationT

ree

Action : Merge



Schedules : {}

Name :

Description :

ProfileName :

Notification :


Description

This command gets a SharePoint 2010 to 2013 online migration blank plan that has no plan settings

configured.


192






Description


migration plan.




information.







Examples

Example 1









193































194




Description

These commands show how to create a SharePoint 2010 to 2013 online migration plan. The destination

is from SharePoint On-Premises farm.

Example 2





PS C:\>$plan.DestinationSPSitesGroupName = 'Default_SharePoint

Sites_Group'









DocAve.API.Objects.SharePointonlineList('Default_SharePoint

Sites_Group', 'http://SharePointServer/sites/site1','/sites/site1',

'list1')






Description

195


These commands show how to create a SharePoint 2010 to 2013 online migration plan. The destination

is from My Registered Sites.









Description The Update-DASP10To13MigrationOnlinePlan cmdlet updates an existing SharePoint 2010 to 2013




editing.







Examples

Example 1




196









'htt





'htt







Description


plan.




197






Description









command.











Examples

Example 1


Description

198











TestRun] [-WaitForJobComplete] [<CommonParameters>]

Description

The Run-DASP10To13MigrationOnlineJob cmdlet runs a SharePoint 2010 to 2013 online migration plan.



to run.








true named false false -IncrementalType<String>






199




false named false false -ConflictResolution<SP10To13MigrationConflictResolution>






true named false false -JobReportType<String>


















Examples

Example 1


Full -ConflictResolution Skip -JobReportType Detailed -

WaitForJobComplete

200


ID : MD20120710144929298926

PlanName : plan1


Status : Finished

StartTime : 7/10/2012 2:49:29 PM

FinishTime : 7/10/2012 3:19:44 PM

Progress : 100

Description


Example 2



JobReportType Detailed -WaitForJobComplete -TestRun

ID : MD20120710142929238219

PlanName : plan2


Status : Finished

StartTime : 7/10/2012 2:54:29 PM

FinishTime : 7/10/2012 3:29:44 PM

Progress : 100

Description


migration plan.


201






Description



















Examples

Example 1




202


Description







Description The Upload-DASP10To13MigrationOnlineProfile cmdlet uploads the SharePoint 2010 to 2013 online














Examples Example 1



203


Description



Lotus Notes Migration


Get-DALotusNotesMigrationOnlinePlan

Gets the plan settings of the specified Lotus Notes online migration plan(s).

Syntax Get-DALotusNotesMigrationOnlinePlan [[-Name] <String[]>]


Description

The Get-DALotusNotesMigrationOnlinePlan cmdlet gets the configurations of the specified Lotus Notes

online migration plan(s).


Specifies the name(s) of the existing Lotus Notes online migration 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.




true

<CommonParameters>




Examples

Example 1

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

204


SourceTree : DocAve.API.Migration.LotusNotesMigra

tion.LotusNotesMigrationSourceTree

SourceAgentName : Agent-LotusNotes

ConnectionName : Connection-LotusNotes

DominoServerName : NotesDominoServer

ServerName : NotesServer

AddressBookName : NotesAddressBook

ShowSystemDB : True

DestinationTree : DocAve.API.Migration.LotusNotesMigra

tion.LotusNotesMigrationDestinationT

ree

DestinationFarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG)


MigrationDatabaseName : MigrationDatabase

Schedules : {}

DestinationAgentGroupName : DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_

DB:SHAREPOINT_CONFIG)

Name : plan1

Description : Description




Description


205


Related Links New-DALotusNotesMigrationOnlinePlan

Update-DALotusNotesMigrationOnlinePlan

Remove-DALotusNotesMigrationOnlinePlan

Get-DALotusNotesMigrationBlankOnlinePlan

Gets a Lotus Notes online migration blank plan without any plan settings.

Syntax Get-DALotusNotesMigrationBlankOnlinePlan [<CommonParameters>]

Description

The Get-DALotusNotesMigrationBlankOnlinePlan cmdlet gets a blank Lotus Notes online migration plan

for creating a new plan.





Examples Example 1

PS C:\>$plan = Get-DALotusNotesMigrationBlankOnlinePlan

PS C:\>$plan

SourceTree :

SourceAgentName :

ConnectionName :

DominoServerName :

ServerName :

AddressBookName :

206


ShowSystemDB : True

DestinationTree : DocAve.API.Migration.LotusNotesMigra

tion.LotusNotesMigrationDestinationT

ree




Schedules : {}


Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a Lotus Notes online migration blank plan that has no plan settings configured.

Related Links New-DALotusNotesMigrationOnlinePlan

New-DALotusNotesMigrationOnlinePlan

Creates a new Lotus Notes online migration plan.

Syntax New-DALotusNotesMigrationOnlinePlan [-Plan]

<LotusNotesMigrationOnlinePlan> [<CommonParameters>]

Description

The New-DALotusNotesMigrationOnlinePlan cmdlet creates a new Lotus Notes online migration plan.

Parameters -Plan<LotusNotesMigrationOnlinePlan>

207


Specifies a Lotus Notes online Migration plan object. About the structure and attribute of

LotusNotesMigration OnlinePlan, please refer to the SDK documentation for more information.







Examples

Example 1






PS C:\>$site1 = New-Object

DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)',

'http://Sha

rePoint2010:10001/sites/site1')

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

PS C:\>$plan.SetSourceInformation('Connection-LotusNotes', 'Local')

PS C:\>$NotesObject = New-Object

DocAve.API.Migration.LotusNotesMigration.LotusNotesDatabase("dommon.ns

f")

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

PS C:\>$schedule1 = new-object

DocAve.API.Migration.LotusNotesMigration.LotusNotesMigrationSchedule

PS C:\>$schedule1.JobOption = "Full"

PS C:\>$schedule1.ConflictResolution = "Skip"

PS C:\>$schedule1.StartTime = "2013-12-05 15:00"

208


PS C:\>$schedule1.TimeZoneId = "pacific standard time"

PS C:\>$schedule1.Interval = "1hour"

PS C:\>$schedule1.NumberOfOccurrence = 1

PS C:\>$plan.Schedules.Add($schedule1)



PS C:\>$schedule2.JobOption = "Incremental"



PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time"

PS C:\>$schedule2.AutoAdjustForDST = $true

PS C:\>$schedule2.Interval = "1day"

PS C:\>$schedule2.EndTime = "2013-12-31 20:00"


PS C:\>New-DALotusNotesMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Lotus Notes online migration plan by getting a blank plan.

Example 2






PS C:\>$destinationNode = New-Object

DocAve.API.Objects.SharePointOnlineWeb 'Default_SharePoint

Sites_Group',

'http://SharePointServer/sites/site01', ''

PS C:\>$plan.DestinationTree.SelectSPOnlineObject($destinationNode)

209





f")





















PS C:\>New-DALotusNotesMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Lotus Notes online migration plan. The destination is from My

Registered Sites.

210


Related Links Get-DALotusNotesMigrationBlankOnlinePlan

Get-DALotusNotesMigrationOnlinePlan




Updates an existing Lotus Notes online migration plan.

Syntax Update-DALotusNotesMigrationOnlinePlan [-Plan]

<LotusNotesMigrationOnlinePlan> [<CommonParameters>]

Description The Update-DALotusNotesMigrationOnlinePlan cmdlet updates an existing Lotus Notes online migration

plan.

Parameters -Plan<LotusNotesMigrationOnlinePlan>

Specifies the plan name to get an existing Lotus Notes online migration plan for editing.







Examples

Example 1

PS C:\>$plan = Get-DALotusNotesMigrationOnlinePlan -Name 'plan1'




211



DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)',

'http://Sha

rePoint2010:10001/sites/site1')





f")


PS C:\>Update-DALotusNotesMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified Lotus Notes online migration plan.

Related Links Get-DALotusNotesMigrationOnlinePlan




Deletes the specified Lotus Notes online migration plan.

Syntax Remove-DALotusNotesMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DALotusNotesMigrationOnlinePlan deletes the specified Lotus Notes online migration plan.


Specifies the name of a Lotus Notes online migration plan that you want to delete.




212




command.











Examples Example 1

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

Description





Run-DALotusNotesMigrationOnlineJob

Runs a Lotus Notes online migration plan.

Syntax Run-DALotusNotesMigrationOnlineJob [-PlanName] <String> -Options

<String> -ConflictResolution <LotusNotesMigrationConflictResolution>

[-RemigrateObjectsWithException] [-

IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete]


213


Description

The Run-DALotusNotesMigrationOnlineJob cmdlet runs a Lotus Notes online migration plan.


Specifies the name of an existing Lotus Notes online migration plan that you want to run.




Specifies to run a full or an incremental migration job of the selected migration plan. Valid




true named false false -ConflictResolution<LotusNotesMigrationConflictResolution>






true named false false -RemigrateObjectsWithException[<SwitchParameter>]

Specifies whether or not to remigrate 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".



false named false false -IgnoreMetadataAndSecurityExceptions[<SwitchParameter>]

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.



false named false false -TestRun[<SwitchParameter>]

214















Examples Example 1

PS C:\>Run-DALotusNotesMigrationOnlineJob -PlanName 'plan1' -Options

Incremental -ConflictResolution MergeAndAppend -

RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions -

WaitForJobComplete

ID : LM20121009125536049056

PlanName : plan1

Module : LotusNotesMigration

Status : Finished

StartTime : 9/10/2012 12:55:36 PM

FinishTime : 9/10/2012 1:25:44 PM

Progress : 100

Description

This command runs the specified Lotus Notes online migration plan in incremental.

215



Download-DALotusNotesMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the Lotus Notes online migration.

Syntax Download-DALotusNotesMigrationOnlineMappingOptionsProfile [-Name]

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

Description

The Download-DALotusNotesMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of Lotus Notes online migration to an XML file in the specified local path.

















Examples

Example 1

216


PS C:\>Download-DALotusNotesMigrationOnlineMappingOptionsProfile -Name

'mappingOptionsProfile' -Path 'C:\profile.xml' -Overwrite

Description

This command downloads the Mapping Options profile of the Lotus Notes online migration to an XML

file in the specified local path.

Related Links Upload-DALotusNotesMigrationOnlineMappingOptionsProfile

Upload-DALotusNotesMigrationOnlineMappingOptionsProfile

Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the

Lotus Notes online migration.

Syntax Upload-DALotusNotesMigrationOnlineMappingOptionsProfile [-Path]


Description

The Upload-DALotusNotesMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Mapping Options profile of the Lotus Notes online migration.













217


Examples

Example 1

PS C:\>Upload-DALotusNotesMigrationOnlineMappingOptionsProfile -Path

'C:\mappingOptionsProfile.xml' -Overwrite

Description

This command uploads the specified XML file from the local path to Manager as the Mapping Options

profile of Lotus Notes online migration.

Related Links Download-DALotusNotesMigrationOnlineMappingOptionsProfile

Download-DALotusNotesMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the Lotus Notes online migration.

Syntax Download-DALotusNotesMigrationOnlineMigrationOptionsProfile [-Name]


Description The Download-DALotusNotesMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration

Options profile of the Lotus Notes online migration to an XML file in the specified local path.











218








Examples

Example 1

PS C:\>Download-DALotusNotesMigrationOnlineMigrationOptionsProfile -

Name 'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite

Description

This command downloads the Migration Options profile of the Lotus Notes online migration to an XML


Related Links Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile

Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile

Uploads the specified XML file from the local path to the Manager as the Migration Options profile of

the Lotus Notes online migration.

Syntax Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile [-Path]


Description

The Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML

file from the local path to the Manager as the Migration Options profile of the Lotus Notes online

migration.






219









Examples

Example 1

PS C:\>Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile -Path

'C:\migrationOptionsProfile.xml' -Overwrite

Description

This command uploads the specified XML file from the local path to the Manager as the Migration

Options profile of the Lotus Notes online migration.

Related Links Download-DALotusNotesMigrationOnlineMigrationOptionsProfile

File System Migration


Get-DAFileSystemMigrationOnlinePlan

Gets the plan settings of the specified file system online migration plan(s).

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


Description

The Get-DAFileSystemMigrationOnlinePlan cmdlet gets the plan settings of the specified file system

online migration plan(s).


220


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.




true

<CommonParameters>




Examples

Example 1

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

MetadataResolution : UseCustomizedMeta

dataFile

MetadataSettings : DocAve.API.Migrat

ion.FileSystemMig

ration.UseCustomi

zedMetadataFile

MetadataFileReady : True

SourceAgentName : SP2010


ion.FileSystemMig

ration.FileSystem

MigrationSourceTr

ee

221


DestinationFarmName : Farm(SQL:SHAREPOI

NT_CONFIG)



UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)


ion.FileSystemMig

ration.FileSystem

MigrationDestinat

ionTree



Schedules : {}

Name : plan 1

Description :




Description


Related Links

Get-DAFileSystemMigrationBlankOnlinePlan

Gets a blank file system online migration plan.

222


Syntax Get-DAFileSystemMigrationBlankOnlinePlan [<CommonParameters>]

Description

The Get-DAFileSystemMigrationBlankOnlinePlan cmdlet gets a blank file system online migration plan.





Examples

Example 1

PS C:\>$plan = Get-DAFileSystemMigrationBlankOnlinePlan

PS C:\>

MetadataResolution : UseMetadataOfFileS

ystem

MetadataSettings : DocAve.API.Migrati

on.FileSystemMigra

tion.UseMetadataOf

FileSystem

MetadataFileReady : False

SourceAgentName :

SourceTree : DocAve.API.Migrati

on.FileSystemMigra

tion.FileSystemMig

rationSourceTree



223



DestinationTree : DocAve.API.Migrati

on.FileSystemMigra

tion.FileSystemMig

rationDestinationT

ree



UserHighPerformanceConversion : False

MigrateContentOnly : False

Schedules : {}

Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a blank file system online migration plan that has no plan settings configured.

Related Links

New-DAFileSystemMigrationOnlinePlan

Creates a new file system online migration plan.

Syntax New-DAFileSystemMigrationOnlinePlan [-Plan]

<FileSystemMigrationOnlinePlan> [<CommonParameters>]

Description

The New-DAFileSystemMigrationOnlinePlan cmdlet creates a new file system online migration plan.

224


Parameters -Plan<FileSystemMigrationOnlinePlan>

Specifies a file system migration online plan object. About the structure and attributes of

FileSystemMigrationOnlinePlan, please refer to the SDK documentation for more information.







Examples Example 1



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


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

PS C:\>$folder = New-Object

DocAve.API.Migration.FileSystemMigration.FileSystemFolder 'connection

2', 'folder1\folder2'

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


'Farm(SQL:SHAREPOINT_CONFIG)', 'http://sp2010', '', 'shared documents'

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



DocAve.API.Migration.FileSystemMigration.FileSystemMigrationSchedule

PS C:\>$scheduleForIncrementalJob.JobOption = 'incremental'

PS C:\>$scheduleForIncrementalJob.TimeZoneId = 'Tokyo Standard Time'

PS C:\>$scheduleForIncrementalJob.Interval = '15minute'

225


PS C:\>$scheduleForIncrementalJob.NumberOfOccurrence = 2

PS C:\>$scheduleForIncrementalJob.StartTime = '2013-11-01 15:10'

PS C:\>$scheduleForIncrementalJob.EndTime = '2013-11-02 00:00'

PS C:\>$scheduleForIncrementalJob.IgnoreMetadataAndSecurityExceptions

= $true


PS C:\>New-DAFileSystemMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a file system online migration plan. The destination is from

SharePoint On-Premises farm.

Example 2



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


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


DocAve.API.Migration.FileSystemMigration.FileSystemFolder 'connection

2', 'folder1\folder2'

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


DocAve.API.Objects.SharePointOnlineList 'Default_SharePoint

Sites_Group', 'http://SharePointServer/sites/site01', '', 'shared

documents'



PS C:\>New-DAFileSystemMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a file system online migration plan. The destination is from My

Registered Sites.

226


Related Links Get-DAFileSystemMigrationBlankOnlinePlan

Get-DAFileSystemMigrationOnlinePlan

Update-DAFileSystemMigrationOnlinePlan

Remove-DAFileSystemMigrationOnlinePlan

Unknown

Generate-DAFileSystemMigrationMetadataFile

Generates the Excel file(s) in the source file system for configuring the metadata applied to the migrated

content when performing the file system migration job.

Syntax Generate-DAFileSystemMigrationMetadataFile [-PlanName] <String> -

Option <String> [<CommonParameters>]

Description The Generate-DAFileSystemMigrationMetadataFile cmdlet generates the Excel file(s) in the source file

system for configuring the metadata that will be applied to the migrated content when performing the

file system migration job.


Specifies the name of the plan used to generate the metadata configuration file.



true 0 true (ByValue) false -Option<String>

Specifies the generation type for the metadata file. Valid values are "Full" and "Incremental".



true named false false <CommonParameters>




227


Examples

Example 1

PS C:\>$jobId = Generate-DAFileSystemMigrationMetadataFile -PlanName

'plan 1' -Option Full

Description

This command generates the metadata Excel file for plan 1 in the source file system to configure the

metadata for the migrated contents. The job ID of this operation will be returned.

Related Links

Update-DAFileSystemMigrationOnlinePlan

Updates an existing file system online migration plan.

Syntax Update-DAFileSystemMigrationOnlinePlan [-Plan]

<FileSystemMigrationOnlinePlan> [<CommonParameters>]

Description The Update-DAFileSystemMigrationOnlinePlan updates an existing file system online migration plan.

Parameters -Plan<FileSystemMigrationOnlinePlan>

Specifies a file system online migration plan for editing.







Examples

Example 1

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

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

228


PS C:\>$file = New-Object

DocAve.API.Migration.FileSystemMigration.FileSystemFile 'connection

1', 'folder1\folder2\test.txt'

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

PS C:\>Update-DAFileSystemMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified file system online migration plan.

Example 2

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

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

PS C:\>$file = New-Object

DocAve.API.Migration.FileSystemMigration.FileSystemFile 'connection

1', 'folder1\folder2\test.txt'

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


DocAve.API.Objects.SharePointOnlineList 'New Sites Group',

'http://SharePointServer/sites/site02', '', 'shared documents'


PS C:\>Update-DAFileSystemMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified file system online migration plan.

Related Links

Remove-DAFileSystemMigrationOnlinePlan

Deletes the specified file system online migration plan.

Syntax Remove-DAFileSystemMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


229


Description

The Remove-DAFileSystemMigrationOnlinePlan cmdlet deletes the specified file system online migration

plan.


Specifies the name of a file system online migration plan that you want to delete.





command.











Examples

Example 1

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

Description


Related Links

230


Run-DAFileSystemMigrationOnlineJob

Runs a file system online migration plan.

Syntax Run-DAFileSystemMigrationOnlineJob [-PlanName] <String> -Options

<String> -ConflictResolution <FileSystemMigrationConflictResolution>




Description

The Run-DAFileSystemMigrationOnlineJob cmdlet runs a file system online migration plan.


Specifies the name of an existing file system online migration plan that you want to run.




Specifies to run a full or an incremental migration job of the selected file system online

migration plan. Valid values are "Full" and "Incremental".



true named false false -ConflictResolution<FileSystemMigrationConflictResolution>



"SkipAndNewVersion", "MergeAndOverwrite", "MergeAndAppend" and

"MergeAndNewVersion".







231







job status.

















Examples

Example 1

PS C:\>Run-DAFileSystemMigrationOnlineJob -PlanName 'plan 1' -Options

Incremental -ConflictResolution MergeAndAppend -WaitForJobComplete -

RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions

ID : FM20121023172852046968

PlanName : plan 1

232


Module : FileSystemMigration

Status : Finished

StartTime : 2012/10/23 17:28:52

FinishTime : 2012/10/23 17:30:09

Progress : 100

Description

This command runs the specified file system online migration plan in incremental.

Related Links

Download-DAFileSystemMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the file system online migration.

Syntax Download-DAFileSystemMigrationOnlineMappingOptionsProfile [-Name]


Description

The Download-DAFileSystemMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of the file system online migration from the Manager to an XML file in the specified local

path.










233









Examples

Example 1

PS C:\>Download-DAFileSystemMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the file system online migration to an XML file

in the specified local path.

Related Links Upload-DAFileSystemMigrationOnlineMappingOptionsProfile

Upload-DAFileSystemMigrationOnlineMappingOptionsProfile


file system online migration.

Syntax Upload-DAFileSystemMigrationOnlineMappingOptionsProfile [-Path]


Description

The Upload-DAFileSystemMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Migration Options profile of the file system online migration.






234










Examples

Example 1

PS C:\>Upload-DAFileSystemMigrationOnlineMappingOptionsProfile -Path


Description

This command uploads the specified XML profile from the local path to the Manager as the Migration

Options profile of the file system online migration.

Related Links Download-DAFileSystemMigrationOnlineMappingOptionsProfile

Download-DAFileSystemMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the file system online migration.

Syntax Download-DAFileSystemMigrationOnlineMigrationOptionsProfile [-Name]


Description

The Download-DAFileSystemMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration

Options profile of the file system online migration from the Manager to an XML file in the specified local

path.



235
















Examples

Example 1

PS C:\>Download-DAFileSystemMigrationOnlineMigrationOptionsProfile -


Description

This command downloads the Migration Options profile of the file system online migration to an XML


Related Links Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile

Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile

Uploads the specified XML profile from the local path to the Manager as the Migration Options profile of

the file system online migration.

Syntax Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile [-Path]


236


Description

The Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Migration Options profile of the file system online migration.













Examples

Example 1

PS C:\>Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile -Path


Description

This command uploads the specified XML profile from the local path to the Manager as the Migration

Options profile of the file system online migration.

Related Links Download-DAFileSystemMigrationOnlineMigrationOptionsProfile

Livelink Migration


Get-DALivelinkMigrationOnlinePlan

Gets the plan settings of the specified Livelink online migration plan(s).

237


Syntax Get-DALivelinkMigrationOnlinePlan [[-Name] <String[]>]


Description

The Get-DALivelinkMigrationOnlinePlan cmdlet gets the configurations of the specified Livelink online

migration plan(s).


Specifies the name(s) of the existing Livelink online migration plan(s) that you want to get


If no values are entered here, the information of all of the existing Livelink online migration





true

<CommonParameters>




Examples

Example 1

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

ConnectionName : Livelink


AREPOINT_CONFIG)



UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

238


ONFIG)


ion.LivelinkMigra

tion.LivelinkMigr

ationSourceTree


ion.LivelinkMigra

tion.LivelinkMigr

ationDestinationT

ree

ProjectMigrationSelection : MigrateProjectAsS

ite


UseSpecifiedMigrationDatabaseToStoreTheJobData : True

Schedules : {}

Name : plan1

Description :




Description


Related Links New-DALivelinkMigrationOnlinePlan

Update-DALivelinkMigrationOnlinePlan

Remove-DALivelinkMigrationOnlinePlan

239


Get-DALivelinkMigrationBlankOnlinePlan

Gets a blank Livelink online migration plan without any plan settings.

Syntax Get-DALivelinkMigrationBlankOnlinePlan [<CommonParameters>]

Description The Get-DALivelinkMigrationBlankOnlinePlan cmdlet gets a blank Livelink online migration plan for

creating a new plan.





Examples Example 1

PS C:\>$plan = Get-DALivelinkMigrationBlankOnlinePlan

PS C:\>$plan

ConnectionName :





ion.LivelinkMigra

tion.LivelinkMigr

ationSourceTree


ion.LivelinkMigra

240


tion.LivelinkMigr

ationDestinationT

ree

ProjectMigrationSelection : None



Schedules : {}

Name :

Description :

ProfileName :

NotificationName :

NotificationName :


Description

This command gets a blank Livelink online migration plan that has no plan settings configured.

Related Links New-DALivelinkMigrationOnlinePlan

New-DALivelinkMigrationOnlinePlan

Creates a new Livelink online migration plan.

Syntax New-DALivelinkMigrationOnlinePlan [-Plan]

<LivelinkMigrationOnlinePlan> [<CommonParameters>]

Description

The New-DALivelinkMigrationOnlinePlan cmdlet creates a new Livelink online migration plan.

Parameters -Plan<LivelinkMigrationOnlinePlan>

Specifies a Livelink Migration online plan object. About the structure and attribute of

LivelinkMigrationOnlinePlan, please refer to the SDK documentation for more information.

241








Examples

Example 1



PS C:\>$plan.Description = 'this is a livelink plan'

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

PS C:\>$plan.AssociatedPlanGroup.Add('PlanGroup01')

PS C:\>$plan.ConnectionName = 'livelink'


DocAve.API.Migration.LivelinkMigration.LivelinkItem('Admin','item01','

EnterpriseWorkspace')

PS C:\>$path = 'Folder', 'Folder01', ' Folder02'

PS C:\>$container1 = New-Object

DocAve.API.Migration.LivelinkMigration.LivelinkContainer('Admin',$path

,'EnterpriseWorkspace')


DocAve.API.Migration.LivelinkMigration.LivelinkContainer('DomainA/user

01',$null,'PersonalWorkspace')

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

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

PS C:\>$plan.SourceTree.Exclude($container2)

PS C:\>$webapp10 = New-Object



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

242


PS C:\>$plan.ProjectMigrationSelection =

'MigrateProjectAsSiteCollection'




DocAve.API.Migration.LivelinkMigration.LivelinkMigrationSchedule

PS C:\>$scheduleForIncrementalJob.JobOption = 'Incremental'

PS C:\>$scheduleForIncrementalJob.ConflictResolution =

'MergeAndOverwrite'

PS C:\>$scheduleForIncrementalJob.RemigrateObjectsWithException =

$true

PS C:\>$scheduleForIncrementalJob.Interval = '2hour'


PS C:\>$scheduleForIncrementalJob.NumberOfOccurrence = 3



PS C:\>New-DALivelinkMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Livelink online migration plan by getting a blank plan.

Example 2










243












PS C:\>$onlineWeb = New-Object

DocAve.API.Objects.SharePointOnlineWeb('Farm(SP2010_DB:SHAREPOINT_CONF

IG)','http://SharePoint2010:10001/','')

PS C:\>$plan.DestinationTree.SelectSPOnlineObject($onlineWeb)





PS C:\>New-DALivelinkMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Livelink online migration plan by getting a blank plan.And the

destination is from registered sites.

Related Links Get-DALivelinkMigrationBlankOnlinePlan

Get-DALivelinkMigrationOnlinePlan




Updates an existing Livelink online migration plan.

244


Syntax Update-DALivelinkMigrationOnlinePlan [-Plan]

<LivelinkMigrationOnlinePlan> [<CommonParameters>]

Description

The Update-DALivelinkMigrationOnlinePlan cmdlet updates an existing Livelink online migration plan.

Parameters -Plan<LivelinkMigrationOnlinePlan>

Specifies a plan name to get an existing Livelink online migration plan for editing.







Examples

Example 1

PS C:\>$plan = Get-DALivelinkMigrationOnlinePlan -Name 'plan1'













245















PS C:\>Update-DALivelinkMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified Livelink online migration plan.

Related Links Get-DALivelinkMigrationOnlinePlan




Deletes the specified Livelink online migration plan.

Syntax Remove-DALivelinkMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DALivelinkMigrationOnlinePlan deletes the specified Livelink online migration plan.


246


Specifies the name of a Livelink online migration plan that you want to delete.





command.











Examples

Example 1

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

Description


Related Links Get-DALivelinkMigrationOnlinePlan



Run-DALivelinkMigrationOnlineJob

Runs a Livelink online migration plan.

247


Syntax Run-DALivelinkMigrationOnlineJob [-PlanName] <String> -Options

<String> -ConflictResolution <LivelinkMigrationConflictResolution> [-

TestRun] [-RemigrateObjectsWithException] [-

IgnoreMetadataAndSecurityExceptions] [-WaitForJobComplete]


Description

The Run-DALivelinkMigrationOnlineJob cmdlet runs a Livelink online migration plan.


Specifies the name of an existing Livelink online migration plan that you want to run.








true named false false -ConflictResolution<LivelinkMigrationConflictResolution>










false named false false -RemigrateObjectsWithException[<SwitchParameter>]




248







job status.













Examples

Example 1

PS C:\>Run-DALivelinkMigrationOnlineJob -PlanName 'plan1' -Options

Full -ConflictResolution Skip -WaitForJobComple

te -IgnoreMetadataAndSecurityExceptions

ID : LL20121101191218743406

PlanName : plan1

Module : LivelinkMigration

Status : InProgress

StartTime : 11/1/2012 7:12:18 PM

249


FinishTime :

Progress : 0

Description

This command runs the specified Livelink online migration plan in full.

Related Links Get-DALivelinkMigrationBlankOnlinePlan

Download-DALivelinkMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the Livelink online migration.

Syntax Download-DALivelinkMigrationOnlineMappingOptionsProfile [-Name]


Description

The Download-DALivelinkMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of the Livelink online migration to an XML file in the specified local path.














250





Examples

Example 1

PS C:\>Download-DALivelinkMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the Livelink online migration to an XML file in

the specified local path.

Related Links Upload-DALivelinkMigrationOnlineMappingOptionsProfile

Upload-DALivelinkMigrationOnlineMappingOptionsProfile


Livelink online migration.

Syntax Upload-DALivelinkMigrationOnlineMappingOptionsProfile [-Path] <String>

[-Overwrite] [<CommonParameters>]

Description

The Upload-DALivelinkMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Mapping Options profile of the Livelink online migration.










251


<CommonParameters>




Examples

Example 1

PS C:\>Upload-DALivelinkMigrationOnlineMappingOptionsProfile -Path


Description

This command uploads the specified XML file from the local path to the Manager as the Mapping

Options profile of the Livelink online migration.

Related Links Download-DALivelinkMigrationOnlineMappingOptionsProfile

Download-DALivelinkMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the Livelink online migration.

Syntax Download-DALivelinkMigrationOnlineMigrationOptionsProfile [-Name]


Description

The Download-DALivelinkMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration

Options profile of the Livelink online migration to an XML file in the specified local path.







252












Examples

Example 1

PS C:\>Download-DALivelinkMigrationOnlineMigrationOptionsProfile -Name

'migrationOptionsProfile' -Path 'C:\profile.xml' -Overwrite

Description

This command downloads the Migration Options profile of the Livelink online migration to an XML file in


Related Links Upload-DALivelinkMigrationOnlineMigrationOptionsProfile

Upload-DALivelinkMigrationOnlineMigrationOptionsProfile


the Livelink online migration.

Syntax Upload-DALivelinkMigrationOnlineMigrationOptionsProfile [-Path]


Description

The Upload-DALivelinkMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Migration Options profile of the Livelink online migration.


253













Examples

Example 1

PS C:\>Upload-DALivelinkMigrationOnlineMigrationOptionsProfile -Path


Description


Options profile of the Livelink online migration.

Related Links Download-DALivelinkMigrationOnlineMigrationOptionsProfile

eRoom Migration


Get-DAERoomMigrationOnlinePlan

Gets the plan settings of the specified eRoom online migration plan(s).

Syntax Get-DAERoomMigrationOnlinePlan [[-Name] <String[]>]


254


Description

The Get-DAERoomMigrationOnlinePlan cmdlet gets the configurations of the specified eRoom online

migration plan(s).


Specifies the name(s) of the existing eRoom online migration plan(s) that you want to get


If no values are entered here, The information of all of the existing eRoom online migration





true

<CommonParameters>




Examples Example 1

PS C:\>Get-DAERoomMigrationOnlinePlan -Name 'plan01'

SourceAgentName : agent-eroom


AREPOINT_CONFIG)



UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)


255


ion.ERoomMigratio

n.ERoomMigrationS

ourceTree


ion.ERoomMigratio

n.ERoomMigrationD

estinationTree



Schedules : {}

Name : plan01

Description : this is an eRoom

migration online

plan.




Description


Related Links New-DAERoomMigrationOnlinePlan

Update-DAERoomMigrationOnlinePlan

Remove-DAERoomMigrationOnlinePlan

Get-DAERoomMigrationBlankOnlinePlan

Gets a blank eRoom online migration plan without any plan settings.

Syntax Get-DAERoomMigrationBlankOnlinePlan [<CommonParameters>]

256


Description

The Get-DAERoomMigrationBlankOnlinePlan cmdlet gets a blank eRoom online migration plan for






Examples

Example 1

PS C:\>$plan = Get-DAERoomMigrationBlankOnlinePlan

PS C:\>$plan

SourceAgentName :





ion.ERoomMigratio

n.ERoomMigrationS

ourceTree


ion.ERoomMigratio

n.ERoomMigrationD

estinationTree



257


Schedules :

Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a blank eRoom online migration plan with no plan settings configured.

Related Links New-DAERoomMigrationOnlinePlan

New-DAERoomMigrationOnlinePlan

Creates a new eRoom online migration plan.

Syntax New-DAERoomMigrationOnlinePlan [-Plan] <ERoomMigrationOnlinePlan>


Description

The New-DAERoomMigrationOnlinePlan cmdlet creates a new eRoom online migration plan.

Parameters -Plan<ERoomMigrationOnlinePlan>

Specifies an eRoom online migration plan object. About the structure and attribute of

ERoomMigrationOnlinePlan, please refer to the SDK documentation for more information.







Examples

Example 1

258




PS C:\>$plan.Description = 'this is an eRoom plan'

PS C:\>$plan.SourceAgentName = 'agent-eroom'

PS C:\>$item = New-Object

DocAve.API.Migration.ERoomMigration.ERoomItem('Community01','Facility0

1','Room01','0_9f7')

PS C:\>$room = New-Object

DocAve.API.Migration.ERoomMigration.ERoomRoom('Community01','Facility0

1','Room02')

PS C:\>$facility = New-Object

DocAve.API.Migration.ERoomMigration.ERoomFacility('Community01','Facil

ity02')

PS C:\>$community = New-Object

DocAve.API.Migration.ERoomMigration.ERoomCommunity('Community02')

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

PS C:\>$plan.SourceTree.IncludeHomeFolder($room)

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

PS C:\>$plan.SourceTree.Exclude($community)






PS C:\>$plan.AssociatedPlanGroup.Add('plan01')




DocAve.API.Migration.ERoomMigration.ERoomMigrationSchedule

PS C:\>$scheduleForFullJob.ConflictResolution = 'skip'

PS C:\>$scheduleForFullJob.Interval = '1day'

259


PS C:\>$scheduleForFullJob.TimeZoneId = 'Taipei Standard Time'

PS C:\>$scheduleForFullJob.StartTime = '2013-12-01 15:40'


PS C:\>$scheduleForFullJob.SetNoEnd()

PS C:\>$scheduleForFullJob.IgnoreMetadataAndSecurityExceptions = $true


PS C:\>New-DAERoomMigrationOnlinePlan -Plan $plan

Description

These commands show how to create an eRoom online migration plan by getting a blank plan.

Example 2







1','Room01','0_9f7')



1','Room02')



ity02')


DocAve.API.Migration.ERoomMigration.ERoomCommunity('Community02')





260










PS C:\>New-DAERoomMigrationOnlinePlan -Plan $plan

Description

These commands show how to create an eRoom online migration plan by getting a blank plan.And the

destination is from registered sites.

Related Links Get-DAERoomMigrationBlankOnlinePlan




Updates an existing eRoom online migration plan.

Syntax Update-DAERoomMigrationOnlinePlan [-Plan] <ERoomMigrationOnlinePlan>


Description

The Update-DAERoomMigrationOnlinePlan cmdlet updates an existing eRoom online migration plan.

Parameters -Plan<ERoomMigrationOnlinePlan>

Specifies an existing eRoom online migration plan for editing.




261





Examples

Example 1

PS C:\>$plan = Get-DAERoomMigrationOnlinePlan -Name 'plan1'






1','Room01','0_9f7')



1','Room02')



ity02')


DocAve.API.Migration.ERoomMigration.ERoomCommunity('Community02)











PS C:\>Update-DAERoomMigrationOnlinePlan -Plan $plan

262


Description

These commands update the plan settings of the specified eRoom online migration plan.

Related Links Get-DAERoomMigrationOnlinePlan




Deletes the specified eRoom online migration plan.

Syntax Remove-DAERoomMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DAERoomMigrationOnlinePlan cmdlet deletes the specified eRoom online migration plan.


Specifies the name of an eRoom online migration plan that you want to delete.





command.








263





Examples

Example 1

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

Description





Run-DAERoomMigrationOnlineJob

Runs an eRoom online migration plan.

Syntax Run-DAERoomMigrationOnlineJob [-PlanName] <String> -Options <String> -

ConflictResolution <ERoomMigrationConflictResolution> [-

RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions]

[-TestRun] [-WaitForJobComplete] [<CommonParameters>]

Description

The Run-DAERoomMigrationOnlineJob cmdlet runs an eRoom online migration plan.


Specifies the name of an existing eRoom online migration plan that you want to run.






264




true named false false -ConflictResolution<ERoomMigrationConflictResolution>















job status.














265





Examples

Example 1

PS C:\>Run-DAERoomMigrationOnlineJob -PlanName 'plan1' -Options Full -

ConflictResolution Skip -IgnoreMetadataAndSecurityExceptions

ID : EM20121005170817366951

PlanName : plan1

Module : ERoomMigration

Status : Waiting

StartTime : 10/5/2012 5:08:17 PM

FinishTime :

Progress : 0

Description

This command runs the specified eRoom online migration plan in full.


Download-DAERoomMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the eRoom online Migration.

Syntax Download-DAERoomMigrationOnlineMappingOptionsProfile [-Name] <String>

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

Description

The Download-DAERoomMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of the eRoom online migration to an XML file in the specified local path.

266


















Examples

Example 1

PS C:\>Download-DAERoomMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the eRoom online migration to an XML file in


Related Links Upload-DAERoomMigrationOnlineMappingOptionsProfile

Upload-DAERoomMigrationOnlineMappingOptionsProfile


eRoom online migration.

267


Syntax Upload-DAERoomMigrationOnlineMappingOptionsProfile [-Path] <String> [-


Description

The Upload-DAERoomMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Mapping Options profile of the eRoom online migration.













Examples

Example 1

PS C:\>Upload-DAERoomMigrationOnlineMappingOptionsProfile -Path


Description


Options profile of the eRoom online migration.

Related Links Download-DAERoomMigrationOnlineMappingOptionsProfile

Download-DAERoomMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the eRoom online migration.

268


Syntax Download-DAERoomMigrationOnlineMigrationOptionsProfile [-Name]


Description

The Download-DAERoomMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration

Options profile of the eRoom online migration to an XML file in the specified local path.

















Examples

Example 1

PS C:\>Download-DAERoomMigrationOnlineMigrationOptionsProfile -Name


Description

This command downloads the Migration Options profile of the eRoom online migration to an XML file in


269


Related Links Upload-DAERoomMigrationOnlineMigrationOptionsProfile

Upload-DAERoomMigrationOnlineMigrationOptionsProfile


the eRoom online migration.

Syntax Upload-DAERoomMigrationOnlineMigrationOptionsProfile [-Path] <String>


Description The Upload-DAERoomMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Migration Options profile of the eRoom online migration.













Examples

Example 1

PS C:\>Upload-DAERoomMigrationOnlineMigrationOptionsProfile -Path


Description

270



Options profile of the eRoom online migration.

Related Links Download-DAERoomMigrationOnlineMigrationOptionsProfile

Exchange Public Folder Migration


Get-DAExchangePublicFolderMigrationOnlinePlan

Gets the plan settings of the specified Exchange Public Folder online migration plan(s).

Syntax Get-DAExchangePublicFolderMigrationOnlinePlan [[-Name] <String[]>]


Description

The Get-DAExchangePublicFolderMigrationOnlinePlan cmdlet gets the configurations of the specified

Exchange Public Folder online migration plan(s).


Specifies the name(s) of the existing Exchange Public Folder online migration plan(s) you want


commas. If no values are entered here, the information of all of the existing Exchange Public

Folder online migration plan(s) will be obtained.




true

<CommonParameters>




Examples

Example 1

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

271


SourceTree : DocAve.API.Migration.

ExchangePublicFolderM

igration.ExchangePubl

icFolderMigrationSour

ceTree

ConnectionName : Connection1

SourceAgentName : Agent1

DestinationTree : DocAve.API.Migration.

ExchangePublicFolderM

igration.ExchangePubl

icFolderMigrationDest

inationTree

DestinationFarmName : Farm(SP2010_DB:SHAREP

OINT_CONFIG)


DestinationAgentGroupName : DEFAULT_AGENT_GROUP_F

OR_Farm(SP2010_DB:SHA

REPOINT_CONFIG)


Schedules : {}


Name : plan1

Description : Description




272


Description


Related Links New-DAExchangePublicFolderMigrationOnlinePlan

Update-DAExchangePublicFolderMigrationOnlinePlan

Remove-DAExchangePublicFolderMigrationOnlinePlan

Get-DAExchangePublicFolderMigrationBlankOnlinePlan

Gets a blank Exchange Public Folder online migration plan without any plan settings.

Syntax Get-DAExchangePublicFolderMigrationBlankOnlinePlan


Description

The Get-DAExchangePublicFolderMigrationBlankOnlinePlan cmdlet gets a blank Exchange Public Folder

online migration plan for creating a new plan.





Examples

Example 1

PS C:\>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan

PS C:\>$plan


ion.ExchangePubli

cFolderMigration.

273


ExchangePublicFol

derMigrationSourc

eTree

ConnectionName :

SourceAgentName :


ion.ExchangePubli

cFolderMigration.

ExchangePublicFol

derMigrationDesti

nationTree





Schedules : {}


Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a blank Exchange Public Folder online migration plan that has no plan settings

configured.

Related Links New-DAExchangePublicFolderMigrationOnlinePlan

274


New-DAExchangePublicFolderMigrationOnlinePlan

Creates a new Exchange Public Folder online migration plan.

Syntax New-DAExchangePublicFolderMigrationOnlinePlan [-Plan]

<ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>]

Description

The New-DAExchangePublicFolderMigrationOnlinePlan cmdlet creates a new Exchange Public Folder


Parameters -Plan<ExchangePublicFolderMigrationOnlinePlan>

Specifies an Exchange Public Folder Migration online plan object. About the structure and

attribute of Exchange Public Folder migration online plan, please refer to the SDK

documentation for more information.







Examples

Example 1




PS C:\>$plan.ProfileName = "Default Profile"

PS C:\>$planGroup = New-Object System.Collections.Generic.List[string]

PS C:\>$planGroup.Add('PlanGroup1')

PS C:\>$plan.AssociatedPlanGroup = $planGroup

PS C:\>$plan.ConnectionName = "Connection1"

275



PS C:\>$sourceNode = New-Object

DocAve.API.Migration.ExchangePublicFolderMigration.ExchangeFolder("Mai

lFolder1")

PS C:\>$farmName = "Farm(SP2010_DB:SHAREPOINT_CONFIG)"

PS C:\>$destinationNode = new-object

docave.api.objects.sharepointweb($farmName,

"http://SharePoint2010:10001/sites/site1", "")

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

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



DocAve.API.Migration.ExchangePublicFolderMigration.ExchangePublicFolde

rMigrationSchedule










rMigrationSchedule







276




PS C:\>New-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan

Description

These commands show how to create an Exchange Public Folder online migration plan by getting a blank

plan.

Example 2












lFolder1")



Sites_Group',







rMigrationSchedule

277











rMigrationSchedule









PS C:\>New-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Exchange Public Folder online migration plan. The destination is

from My Registered Sites.

Related Links Get-DAExchangePublicFolderMigrationBlankOnlinePlan

Get-DAExchangePublicFolderMigrationOnlinePlan



278



Updates an existing Exchange Public Folder online migration plan.

Syntax Update-DAExchangePublicFolderMigrationOnlinePlan [-Plan]

<ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>]

Description

The Update-DAExchangePublicFolderMigrationOnlinePlan cmdlet updates an existing Exchange Public

Folder online migration plan.

Parameters -Plan<ExchangePublicFolderMigrationOnlinePlan>

Specifies an existing Exchange Public Folder online migration plan for editing.







Examples

Example 1

PS C:\>$plan = Get-DAExchangePublicFolderMigrationOnlinePlan -Name

'plan1'








279




lFolder1")

PS C:\>$farmName = "Farm(SP2010_DB:SHAREPOINT_CONFIG)"

PS C:\>$destinationNode = new-object

docave.api.objects.sharepointweb($farmName,

"http://SharePoint2010:10001/sites/site1", "")


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

PS C:\>Update-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified Exchange Public Folder online migration plan.

Related Links Get-DAExchangePublicFolderMigrationOnlinePlan




Deletes the specified Exchange Public Folder online migration plan.

Syntax Remove-DAExchangePublicFolderMigrationOnlinePlan [-Name] <String> [-

WhatIf] [-Confirm] [<CommonParameters>]

Description

The Remove-DAExchangePublicFolderMigrationOnlinePlan cmdlet deletes the specified Exchange Public

Folder online migration plan.


Specifies the name of an Exchange Public Folder online migration plan that you want to delete.




280











Examples

Example 1

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

Description





Run-DAExchangePublicFolderMigrationOnlineJob

Runs an Exchange Public Folder online migration plan.

Syntax Run-DAExchangePublicFolderMigrationOnlineJob [-PlanName] <String> -

Options <String> -ConflictResolution

<ExchangePublicFolderMigrationConflictResolution> [-TestRun] [-


[-WaitForJobComplete] [<CommonParameters>]

281


Description

The Run-DAExchangePublicFolderMigrationOnlineJob cmdlet runs an Exchange Public Folder online

migration plan.


Specifies the name of an existing Exchange Public Folder online migration plan that you want to

run.




Specifies to run a full or an incremental job of the selected migration plan. Valid values are "Full"

and "Incremental".



true named false false -ConflictResolution<ExchangePublicFolderMigrationConflictResolution>


"Skip", "SkipAndSkip", "SkipAndOverwrite", "MergeAndSkip", "MergeAndOverwrite".







false named false false -RemigrateObjectsWithException[<SwitchParameter>]







282




job status.













Examples

Example 1

PS C:\>Run-DAExchangePublicFolderMigrationOnlineJob -PlanName 'plan1'

-Options Incremental -ConflictResolution Skip -WaitForJobComplete -

RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions

ID : LM20121009125536049056

PlanName : plan1

Module : ExchangePublicFolderMigration

Status : Finished

StartTime : 9/10/2012 12:55:36 PM

FinishTime : 9/10/2012 1:19:44 PM

Progress : 100

Description

This command runs the specified Exchange Public Folder online migration plan in full.

283



Download-

DAExchangePublicFolderMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the Exchange Public Folder online migration.

Syntax Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [-

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

Description The Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile cmdlet downloads the

Mapping Options profile of the Exchange Public Folder online migration to an XML file in the specified

local path.

















284


Examples

Example 1

PS C:\>Download-

DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the Exchange Public Folder online migration

to an XML file in the specified local path.

Related Links Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile

Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile


Exchange Public Folder online migration.

Syntax Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [-

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

Description

The Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile cmdlet uploads the

specified XML file from the local path to the Manager as the Mapping Options profile of Exchange Public

Folder online migration.










285





Examples

Example 1

PS C:\>Upload-

DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Path


Description


Options profile of the Exchange Public Folder online migration.

Related Links Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile

Download-

DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the Exchange Public Folder online migration.

Syntax Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile

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

Description The Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile cmdlet downloads the

Migration Options profile of the Exchange Public Folder online migration to an XML file in the specified

local path.







286












Examples

Example 1

PS C:\>Download-

DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Name


Description

This command downloads the Migration Options profile of the Exchange Public Folder online migration

to an XML file in the specified local path.

Related Links Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile

Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile


the Exchange Public Folder online migration.

Syntax Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile [-

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

Description

The Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile cmdlet uploads the

specified XML file from the local path to the Manager as the Migration Options profile of the Exchange

Public Folder online migration.

287














Examples

Example 1

PS C:\>Upload-

DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Path


Description


Options profile of the Exchange Public Folder online migration.

Related Links Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile

EMC Documentum Migration


Get-DADocumentumMigrationOnlinePlan

Gets the plan settings of the specified Documentum online migration plans.

288


Syntax Get-DADocumentumMigrationOnlinePlan [[-Name] <String[]>]


Description

The Get-DADocumentumMigrationOnlinePlan cmdlet gets the configurations of the specified

Documentum online migration plans.


Specifies the names of the existing Documentum online migration plans whose configurations

you want to get.Wildcards and multiple values are allowed, which are separated by commas. If

no values are entered here, The information of all of the existing Documentum online migration

plans will be obtained.




false

<CommonParameters>




Examples

Example 1

PS C:\>Get-DADocumentumMigrationOnlinePlan -Name 'plan01'


ion.DocumentumMig

ration.Documentum

MigrationSourceTr

ee

ConnectionName : emc connection

SourceAgentName : agent-emc

289



AREPOINT_CONFIG)



UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)


ion.DocumentumMig

ration.Documentum

MigrationDestinat

ionTree



Schedules : {}

Name : plan01

Description :




Description


Related Links New-DADocumentumMigrationOnlinePlan

Update-DADocumentumMigrationOnlinePlan

Remove-DADocumentumMigrationOnlinePlan

290


Get-DADocumentumMigrationBlankOnlinePlan

Gets a blank Documentum online migration plan with no plan settings configured.

Syntax Get-DADocumentumMigrationBlankOnlinePlan [<CommonParameters>]

Description The Get-DADocumentumMigrationBlankOnlinePlan cmdlet gets a blank Documentum online migration

plan for creating a new plan.





Examples Example 1

PS C:\>$plan = Get-DADocumentumMigrationBlankOnlinePlan

PS C:\>$plan


ion.DocumentumMig

ration.Documentum

MigrationSourceTr

ee

ConnectionName :

SourceAgentName :




291



ion.DocumentumMig

ration.Documentum

MigrationDestinat

ionTree



Schedules : {}

Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a blank Documentum online migration plan with no plan settings configured.

Related Links New-DADocumentumMigrationOnlinePlan

New-DADocumentumMigrationOnlinePlan

Creates a new Documentum online migration plan.

Syntax New-DADocumentumMigrationOnlinePlan [-Plan]

<DocumentumMigrationOnlinePlan> [<CommonParameters>]

Description

The New-DADocumentumMigrationOnlinePlan cmdlet creates a new Documentum online migration

plan.

Parameters -Plan<DocumentumMigrationOnlinePlan>

292


Specifies a Documentum online migration plan object. About the structure and attributes of

DocumentumMigrationOnlinePlan, refer to the SDK Documentation for more information.







Examples

Example 1

PS C:\>$plan = Get-DADocumentumMigrationBlankOnlinePlan


PS C:\>$plan.Description = 'this is a documentum plan'

PS C:\>$plan.ConnectionName = 'emc connection'

PS C:\>$cabinet1 = New-Object

DocAve.API.Migration.DocumentumMigration.DocumentumCabinet('cabinet1')




DocAve.API.Migration.DocumentumMigration.DocumentumFolder('cabinet1/fo

lder1')

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


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







293





DocAve.API.Migration.DocumentumMigration.DocumentumMigrationSchedule

PS C:\>$scheduleForIncrementalJob.JobOption = 'incremental'

PS C:\>$scheduleForIncrementalJob.ConflictResolution = 'MergeAndSkip'

PS C:\>$scheduleForIncrementalJob.Interval = '15minute'

PS C:\>$scheduleForIncrementalJob.TimeZoneId = 'Tokyo Standard Time'


PS C:\>$scheduleForIncrementalJob.EndTime = '2013-11-02 0:00'


PS C:\>New-DADocumentumMigrationOnlinePlan -Plan $plan

Description

These commands create a Documentum online migration plan.

Example 2

PS C:\>$plan = Get-DADocumentumMigrationOnlinePlan









DocAve.API.Migration.DocumentumMigration.DocumentumFolder('cabinet1/fo

lder1')



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

294










PS C:\>New-DADocumentumMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a documentum online migration plan. And the destination is from

registered sites.

Related Links Get-DADocumentumMigrationBlankOnlinePlan




Updates an existing Documentum online migration plan.

Syntax Update-DADocumentumMigrationOnlinePlan [-Plan]

<DocumentumMigrationOnlinePlan> [<CommonParameters>]

Description

Specifies an existing Documentum online migration plan you are about to update.

Parameters -Plan<DocumentumMigrationOnlinePlan>

Specifies an existing Documentum online migration plan for editing.




295





Examples

Example 1

PS C:\>$plan = Get-DADocumentumMigrationOnlinePlan -Name 'plan1'




PS C:\>$virtualDocument = New-Object

DocAve.API.Migration.DocumentumMigration.DocumentumVirtualDocument('Ca

binet01','09de75d180008765')

PS C:\>$snapshot = New-Object

DocAve.API.Migration.DocumentumMigration.DocumentumSnapShot('Cabinet01

','09de75d180008767')

PS C:\>$simpleDocument = New-Object

DocAve.API.Migration.DocumentumMigration.DocumentumSimpleDocument('Cab

inet01','09de75d180008768')

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

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

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


'Farm(SQL:SHAREPOINT_CONFIG)', 'http://sp2010', '', 'shared documents'

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



PS C:\>Update-DAEMCDocumentumMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified Documentum online migration plan.

296


Related Links Get-DADocumentumMigrationOnlinePlan




Deletes the specified Documentum online migration plan.

Syntax Remove-DADocumentumMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DADocumentumMigrationOnlinePlan cmdlet deletes the specified Documentum online

migration plan.


Specifies the name of a Documentum online migration plan that you want to delete.





command.











297


Examples

Example 1

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

Description

This command deletes the specified Documentum online migration plan.




Run-DADocumentumMigrationOnlineJob

Runs a Documentum online migration plan.

Syntax Run-DADocumentumMigrationOnlineJob [-PlanName] <String> -Options

<String> -ConflictResolution <DocumentumMigrationConflictResolution>




Description

The Run-DADocumentumMigrationOnlineJob cmdlet runs a Documentum online migration plan.


Specifies the name of an existing Documentum online migration plan that you want to run.








true named false false -ConflictResolution<DocumentumMigrationConflictResolution>

298
















job status.






job status.










299





Examples

Example 1

PS C:\>Run-DADocumentumMigrationOnlineJob -PlanName 'plan1' -Options

Full -ConflictResolution Skip -IgnoreMetadataAndSecurityExceptions

ID : MC20130822174646205917

PlanName : plan1

Module : DocumentumMigration

Status : waiting

StartTime : 8/22/2013 5:46:46 PM

FinishTime : 8/22/2013 5:46:46 PM

Progress : 0

Description

This command runs the specified Documentum online migration plan in full.


Download-DADocumentumMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the Documentum online Migration.

Syntax Download-DADocumentumMigrationOnlineMappingOptionsProfile [-Name]


Description

The Download-DADocumentumMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of the Documentum online migration from the Manager to an XML file in the specified

local path.

300


















Examples

Example 1

PS C:\>Download-DADocumentumMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the documentum online migration to an XML


Related Links Upload-DADocumentumMigrationOnlineMappingOptionsProfile

Upload-DADocumentumMigrationOnlineMappingOptionsProfile


Documentum online migration.

301


Syntax Upload-DADocumentumMigrationOnlineMappingOptionsProfile [-Path]


Description

The Upload-DADocumentumMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML

file from the local path to the Manager as the Mapping Options profile of the Documentum online

migration.













Examples Example 1

PS C:\>Upload-DADocumentumMigrationOnlineMappingOptionsProfile -Path


Description


Options profile of the Documentum online migration.

Related Links Download-DADocumentumMigrationOnlineMappingOptionsProfile

302


Download-DADocumentumMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the documentum online migration.

Syntax Download-DADocumentumMigrationOnlineMigrationOptionsProfile [-Name]


Description

The Download-DADocumentumMigrationOnlineMigrationOptionsProfile cmdlet downloads the

Migration Options profile of the Documentum online migration from the Manager to an XML file in the

specified local path.

















Examples

Example 1

PS C:\>Download-DADocumentumMigrationOnlineMigrationOptionsProfile -


303


Description

This command downloads the Migration Options profile of the documentum online migration to an XML


Related Links Upload-DADocumentumMigrationOnlineMigrationOptionsProfile

Upload-DADocumentumMigrationOnlineMigrationOptionsProfile


the Documentum online migration.

Syntax Upload-DADocumentumMigrationOnlineMigrationOptionsProfile [-Path]


Description

The Upload-DADocumentumMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML

file from the local path to the Manager as the Migration Options profile of the Documentum online

migration.













Examples

Example 1

304


PS C:\>Upload-DADocumentumMigrationOnlineMigrationOptionsProfile -Path


Description


Options profile of the documentum online migration.

Related Links Download-DADocumentumMigrationOnlineMigrationOptionsProfile

Quickr Migration


Get-DAQuickrMigrationOnlinePlan

Gets the plan settings of the specified Quickr online migration plans.

Syntax Get-DAQuickrMigrationOnlinePlan [[-Name] <String[]>]


Description The Get-DAQuickrMigrationOnlinePlan cmdlet gets the configurations of the specified Quickr online

migration plans.


Specifies the names of the existing Quickr online migration plans whose configurations you want

to get. 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 Quickr online

migration plans will be obtained.




false

<CommonParameters>




305


Examples

Example 1

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


Schedules : {}



ion.QuickrMigrati

on.QuickrMigratio

nDestinationTree


AREPOINT_CONFIG)



UP_FOR_Farm(SP201

0_DB:SHAREPOINT_C

ONFIG)


ion.QuickrMigrati

on.QuickrMigratio

nSourceTree

SourceAgentName : Agent-QuickrMigra

tion

ConnectionName : Connection-Quickr

Migration

306


QuickrServerName : QuickrServer

Name : plan1

Description : Descritpion


NotificationName :


Description


Related Links New-DAQuickrMigrationOnlinePlan

Update-DAQuickrMigrationOnlinePlan

Get-DAQuickrMigrationBlankOnlinePlan

Gets a blank Quickr online migration plan without any plan settings.

Syntax Get-DAQuickrMigrationBlankOnlinePlan [<CommonParameters>]

Description

The Get-DAQuickrMigrationBlankOnlinePlan cmdlet gets a blank Quickr online migration plan for






Examples

Example 1

PS C:\>$plan = Get-DAQuickrMigrationBlankOnlinePlan

PS C:\>$plan

307



Schedules : {}


DestinationTree : DocAve.API.Migra

tion.QuickrMigra

tion.QuickrMigra

tionDestinationT

ree




SourceTree : DocAve.API.Migra

tion.QuickrMigra

tion.QuickrMigra

tionSourceTree

SourceAgentName :

ConnectionName :

QuickrServerName :

Name :

Description :

ProfileName :

NotificationName :


Description

This command gets a blank Quickr online migration plan that has no plan settings configured.

Related Links New-DAQuickrMigrationOnlinePlan

308


New-DAQuickrMigrationOnlinePlan

Creates a new Quickr online migration plan.

Syntax New-DAQuickrMigrationOnlinePlan [-Plan] <QuickrMigrationOnlinePlan>


Description

The New-DAQuickrMigrationOnlinePlan cmdlet creates a new Quickr online migration plan.

Parameters -Plan<QuickrMigrationOnlinePlan>

Specifies a Quickr online Migration plan object. About the structure and attributes of

QuickrMigrationOnlinePlan, please refer to the SDK Documentation for more information.







Examples

Example 1







DocAve.API.Objects.SharePointSite('Farm(SP2010_DB

:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1')


PS C:\>$plan.SetSourceInformation('Connection-QuickrMigration',

'QuickrServer')

309


PS C:\>$QuickrObject = New-Object

DocAve.API.Migration.QuickrMigration.QuickrMigrationPlace("QuickPlace/

Place1/Main.nsf")

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


DocAve.API.Migration.QuickrMigration.QuickrMigrationSchedule


















PS C:\>New-DAQuickrMigrationOnlinePlan -Plan $plan

Description

These commands create a Quickr online migration plan.

Example 2


310








Sites_Group',




'QuickrServer')



Place1/Main.nsf")
















311







PS C:\>New-DAQuickrMigrationOnlinePlan -Plan $plan

Description

These commands show how to create a Quickr online migration plan. The destination is from My

Registered Sites.

Related Links Get-DAQuickrMigrationBlankOnlinePlan


Get-DAQuickrMigrationOnlinePlan


Updates an existing Quickr online migration plan.

Syntax Update-DAQuickrMigrationOnlinePlan [-Plan] <QuickrMigrationOnlinePlan>


Description

The Update-DAQuickrMigrationOnlinePlan cmdlet updates an existing Quickr online migration plan.

Parameters -Plan<QuickrMigrationOnlinePlan>

Specifies a plan name to get an existing Quickr online migration plan for editing.







312


Examples

Example 1

PS C:\>$plan = Get-DAQuickrMigrationOnlinePlan -Name 'plan1'





DocAve.API.Objects.SharePointSite('Farm(SP2010_DB

:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1')



'QuickrServer')



Place1/Main.nsf")


PS C:\>Update-DAQuickrMigrationOnlinePlan -Plan $plan

Description

These commands update the plan settings of the specified Quickr online migration plan.

Related Links Get-DAQuickrMigrationOnlinePlan


Remove-DAQuickrMigrationOnlinePlan

Deletes the specified Quickr online migration plan.

Syntax Remove-DAQuickrMigrationOnlinePlan [-Name] <String> [-WhatIf] [-


Description

The Remove-DAQuickrMigrationOnlinePlan deletes the specified Quickr online migration plan.

313



Specifies the name of a Quickr online migration plan that you want to delete.





command.











Examples

Example 1

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

Description





Run-DAQuickrMigrationOnlineJob

Runs a Quickr online migration plan.

314


Syntax Run-DAQuickrMigrationOnlineJob [-PlanName] <String> -Options <String>

-ConflictResolution <QuickrMigrationConflictResolution> [-


[-TestRun] [-WaitForJobComplete] [<CommonParameters>]

Description

The Run-DAQuickrMigrationOnlineJob cmdlet runs a Quickr online migration plan.


Specifies the name of an existing Quickr online migration plan that you want to run.








true named false false -ConflictResolution<QuickrMigrationConflictResolution>













315




job status.

















Examples

Example 1

PS C:\>Run-DAQuickrMigrationOnlineJob -PlanName 'plan1' -Options

Incremental -ConflictResolution MergeAndAppend -RemigrateObjectsWit

hException -IgnoreMetadataAndSecurityExceptions -WaitForJobComplete

ID : QM20130813162751917507

PlanName : plan1

Module : QuickrMigration

Status : Finished

StartTime : 8/13/2013 4:27:51 PM

316


FinishTime : 8/13/2013 4:28:43 PM

Progress : 100

Description

This command runs the specified Quickr online migration plan in incremental.


Download-DAQuickrMigrationOnlineMappingOptionsProfile

Downloads the Mapping Options profile of the Quickr online migration.

Syntax Download-DAQuickrMigrationOnlineMappingOptionsProfile [-Name] <String>

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

Description

The Download-DAQuickrMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping

Options profile of the Quickr online migration from the Manager to an XML file in the specified local

path.














317





Examples

Example 1

PS C:\>Download-DAQuickrMigrationOnlineMappingOptionsProfile -Name


Description

This command downloads the Mapping Options profile of the Quickr online migration to an XML file in


Related Links Upload-DAQuickrMigrationOnlineMappingOptionsProfile

Upload-DAQuickrMigrationOnlineMappingOptionsProfile


Quickr online migration.

Syntax Upload-DAQuickrMigrationOnlineMappingOptionsProfile [-Path] <String>


Description

The Upload-DAQuickrMigrationOnlineMappingOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Mapping Options profile of the Quickr online migration.










318


<CommonParameters>




Examples

Example 1

PS C:\>Upload-DAQuickrMigrationOnlineMappingOptionsProfile -Path


Description

This command uploads the specified XML file from the local path to Manager as the Mapping Options

profile of Quickr online migration.

Related Links Download-DAQuickrMigrationOnlineMappingOptionsProfile

Download-DAQuickrMigrationOnlineMigrationOptionsProfile

Downloads the Migration Options profile of the Quickr online migration.

Syntax Download-DAQuickrMigrationOnlineMigrationOptionsProfile [-Name]


Description

The Download-DAQuickrMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration

Options profile of the Quickr online migration from the Manager to an XML file in the specified local

path.







319












Examples

Example 1

PS C:\>Download-DAQuickrMigrationOnlineMigrationOptionsProfile -Name


Description

This command downloads the Migration Options profile of the Quickr online migration to an XML file in


Related Links Upload-DAQuickrMigrationOnlineMigrationOptionsProfile

Upload-DAQuickrMigrationOnlineMigrationOptionsProfile


the Quickr online migration.

Syntax Upload-DAQuickrMigrationOnlineMigrationOptionsProfile [-Path] <String>


Description

The Upload-DAQuickrMigrationOnlineMigrationOptionsProfile cmdlet uploads the specified XML file

from the local path to the Manager as the Migration Options profile of the Quickr online migration.


320













Examples

Example 1

PS C:\>Upload-DAQuickrMigrationOnlineMigrationOptionsProfile -Path


Description

online migration.

Related Links Download-DAQuickrMigrationOnlineMigrationOptionsProfile

Granular Backup and Restore


Get-DAGranularBackupPlan

Gets the Granular Backup plan(s).

Syntax Get-DAGranularBackupPlan [[-Name] <String[]>] [<CommonParameters>]

Description

The Get-DAGranularBackupPlan cmdlet gets the Granular Backup plan(s) according to the name you

specified, if you do not set any value for the parameter, all the Granular Backup plans will be returned.

321



Specifies one or more plans' names. You can type multiple plan names (separated by commas).

Wildcards are supported.




true

<CommonParameters>




Examples Example 1

PS C:\>$plan = Get-DAGranularBackupPlan -Name 'plan1'

PS C:\>$plan

Name : plan1


Description :

RestoreLevel : ItemLevel

StoragePolicyName : storagepolicy

DataCompressionType : None

DataCompressionMethod : None

DataEncryption : SharePointAgent

SecurityProfile : DocAveDefaultProfile

AgentGroupName :

DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)


322



IncludeUserProfile : True

Tree : DocAve.API.Objects.SharePointTree

PS C:\>$includedSPObjects = $plan.Tree.GetIncludedSPObject()

PS C:\>$includedSPObjects | ForEach-Object -Process {$_.ToString()}

Web application: Farm(SP2010_DB:SHAREPOINT_CONFIG),

http://SharePoint2010:10001/

Site collection: Farm(SP2010_DB:SHAREPOINT_CONFIG),

http://SharePoint2010:10001/sites/site1

Site: Farm(SP2010_DB:SHAREPOINT_CONFIG),

http://SharePoint2010:10001/sites/site1, /sites/site1

List: Farm(SP2010_DB:SHAREPOINT_CONFIG),

http://SharePoint2010:10001/sites/site1, /sites/site1, Shared

Documents

Folder: Farm(SP2010_DB:SHAREPOINT_CONFIG),

http://SharePoint2010:10001/sites/site1, /sites/site1, Shared

Documents, Folder1

Description

This command retrieves the plan named 'plan1'.

Related Links New-DAGranularBackupPlan

Remove-DAGranularBackupPlan

Update-DAGranularBackupPlan

Get-DAGranularBackupBlankPlan

Gets a blank Granular Backup plan.

323


Syntax Get-DAGranularBackupBlankPlan [<CommonParameters>]

Description

The Get-DAGranularBackupBlankPlan cmdlet gets a blank plan with the default settings and then you

can configure it to create a plan.





Examples

Example 1

PS C:\>Get-DAGranularBackupBlankPlan

Name :

FarmName :

Description :

RestoreLevel : ItemLevel

StoragePolicyName :

DataCompressionType : None

DataCompressionMethod : None

DataEncryption : None

SecurityProfile :

AgentGroupName :



IncludeUserProfile : False

NotificationName :

324


Tree :

Description

This command retrieves a blank plan.


New-DAGranularBackupPlan

Creates a new Granular Backup plan.

Syntax New-DAGranularBackupPlan [-Plan] <GranularBackupPlan>


Description

The New-DAGranularBackupPlan cmdlet creates a new Granular Backup plan. You can use the Get-

DAGranularBackupBlankPlan to get a blank plan, and then construct the plan.

Parameters -Plan<GranularBackupPlan>

Specifies a Granular Backup plan object. About the structure and attribute of

GranularBackupPlan,please refer to the DocAve SDK documentation for more information.



true 0 false false <CommonParameters>




Examples Example 1

PS C:\>$plan = Get-DAGranularBackupBlankPlan


PS C:\>$plan.Description = 'description'

PS C:\>$plan.StoragePolicyName = 'storage policy1'

325


PS C:\>$plan.AgentGroupName =

"DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)"




s/site1')

PS C:\>$plan.Tree.IncludeSPObject($site1)

PS C:\>$fullJobSchedule = New-Object

DocAve.API.DataProtection.GranularBackupAndRestore.GranularBackupSched

ule

PS C:\>$fullJobSchedule.JobOption = "Full"

PS C:\>$fullJobSchedule.StartTime = "2013-10-11 14:00"

PS C:\>$fullJobSchedule.TimeZoneId = "Pacific Standard Time"

PS C:\>$fullJobSchedule.AutoAdjustForDST = true

PS C:\>$fullJobSchedule.Interval = "3D"

PS C:\>$fullJobSchedule.NumberOfOccurrence = 1

PS C:\>$plan.Schedules.Add($fullJobSchedule)

PS C:\>$incrementalJobSchedule = New-Object

DocAve.API.DataProtection.GranularBackupAndRestore.GranularBackupSched

ule

PS C:\>$incrementalJobSchedule.JobOption = "Incremental"

PS C:\>$incrementalJobSchedule.StartTime = "2013-10-11 14:00"

PS C:\>$incrementalJobSchedule.TimeZoneId = "Pacific Standard Time"

PS C:\>$incrementalJobSchedule.AutoAdjustForDST = true

PS C:\>$incrementalJobSchedule.Interval = "2D"

PS C:\>$incrementalJobSchedule.EndTime = "2013-12-31 20:00"

PS C:\>$plan.Schedules.Add($incrementalJobSchedule)

PS C:\>New-DAGranularBackupPlan -Plan $plan

Description

326


These commands show how to create a granular backup plan. First get a blank granular backup plan,

and then construct the plan, finally use the constructed plan object to create a plan.

Related Links Get-DAGranularBackupBlankPlan





Updates the Granular Backup plan.

Syntax Update-DAGranularBackupPlan [-Plan] <GranularBackupPlan>


Description The Update-DAGranularBackupPlan cmdlet updates an existing Granular Backup plan.

Parameters -Plan<GranularBackupPlan>

Specifies a Granular Backup plan object.







Examples

Example 1

PS C:\>$plan = Get-DAGranularBackupPlan -Name 'plan1'


PS C:\>Update-DAGranularBackupPlan -Plan $plan

Description

327


These commands show how to change the plan name from 'plan1' to 'plan2'.





Removes the specified Granular Backup plan.

Syntax Remove-DAGranularBackupPlan [-Name] <String> [-WhatIf] [-Confirm]


Description

The Remove-DAGranularBackupPlan cmdlet removes the specified Granular Backup plan.


Specifies the name of plan to be removed.





command.








328





Examples

Example 1

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

Description

This command removes a Granular Backup plan named plan1.

Related Links Get-DAGranularBackupPlan


New-DAGranularBackupPlan

Run-DAGranularBackupJob

Runs Granular Backup job.

Syntax Run-DAGranularBackupJob [-PlanName] <String> -BackupJobType

<RunGranularBackupPlanType> -JobReportType <String> [-TestRun] [-


Description

The Run-DAGranularBackupJob cmdlet runs Granular Backup job.





true 0 false false -BackupJobType<RunGranularBackupPlanType>

Specifies the type of backup. Valid values are "Full", "Incremental" and "Differential".




329


-JobReportType<String>

Specifies the job report level. Valid values are "Simplified" and "Detailed".




Whether to run the test job.




Whether to wait for the completion of the job. If you select to wait for the completion, it will








Examples

Example 1

PS C:\>Run-DAGranularBackupJob -PlanName 'plan1' -BackupJobType full -

JobReportType Detailed -WaitForJobComplete

ID : FB20120710150349246927

PlanName : plan1

Module : GranularBackup

Status : Finished

StartTime : 7/10/2012 3:03:49 PM

FinishTime : 7/10/2012 3:08:54 PM

Progress : 100

330


Description

This command runs Granular Backup job based on plan1.

Related Links

Platform Backup and Restore


Run-DAPlatformBackupJob

Runs Platform Backup job.

Syntax Run-DAPlatformBackupJob [-PlanName] <String> -BackupType

<PRBackupType> [-CopyDataFromSnapshotToMediaServer] [-

DeferCopyingDataFromPersistentSnapshot] [-

DeferGeneratingInstaMountMapping] -RestoreGranularityLevel

<PlatformRestoreGranularityLevel> [-

DeferGeneratingGranularRestoreIndex] [-WaitForJobComplete]


Run-DAPlatformBackupJob [-PlanName] <String> [-FullJobConfiguration]

<PlatformBackupFullJobConfiguration> [-WaitForJobComplete]


Run-DAPlatformBackupJob [-PlanName] <String> [-

DifferentialJobConfiguration]

<PlatformBackupDifferentialJobConfiguration> [-WaitForJobComplete]


Run-DAPlatformBackupJob [-PlanName] <String> [-

IncrementalJobConfiguration]

<PlatformBackupIncrementalJobConfiguration> [-WaitForJobComplete]


Description

The Run-DAplatformBackupJob cmdlet runs a Platfrom Backup job based on the specified plan.



331




true 0 false false -BackupType<PRBackupType>

Specifies the type of backup. Valid values are "Full", "Incremental" and "Differential".



true named false false -CopyDataFromSnapshotToMediaServer[<SwitchParameter>]

Specifies whether to copy data from snapshot to media server.



false named false false -DeferCopyingDataFromPersistentSnapshot[<SwitchParameter>]

Specifies whether to defer copy data from persistent snapshot.



false named false false -DeferGeneratingInstaMountMapping[<SwitchParameter>]

Specifies whether to defer generate InstaMount mapping.



false named false false -RestoreGranularityLevel<PlatformRestoreGranularityLevel>

Specifies the restore granularity level. Valid values are "SiteCollectionLevel", "SiteLevel",

"FolderLevel", "ItemLevel", "ItemVersionLevel" and "None".



true named false false -DeferGeneratingGranularRestoreIndex[<SwitchParameter>]

Specifies whether to defer generate granular restore index.




332






false named false false -FullJobConfiguration<PlatformBackupFullJobConfiguration>

Specifies the configurations of the Platform Full Backup job.



true 1 false false -

DifferentialJobConfiguration<PlatformBackupDifferentialJobConfiguratio

n>

Specifies the configurations of the Platform Differential Backup job.



true 1 false false -

IncrementalJobConfiguration<PlatformBackupIncrementalJobConfiguration>

Specifies the configurations of the Platform Incremental Backup job.







Examples

Example 1

PS C:\>$FullJobConfiguration = New-Object

DocAve.API.DataProtection.PlatformBackupAndRestore.PlatformBackupFullJ

obConfiguration

PS C:\>$FullJobConfiguration.TransferDataFromSnapshotToMediaServer =

$True

333


PS

C:\>$FullJobConfiguration.DeferTransferringDataFromPersistentSnapshot

= $true

PS C:\>$FullJobConfiguration.DeferGeneratingInstaMountMapping = $true

PS C:\>$FullJobConfiguration.RestoreGranularityLevel = 'ItemLevel'

PS C:\>$FullJobConfiguration.DeferGeneratingGranularRestoreIndex =

$true

PS C:\>$FullJobConfiguration.BackupStubDatabase = $true

PS C:\>$FullJobConfiguration.BackupStorageManagerBLOB = $true

PS C:\>$FullJobConfiguration.BackupConnectorBLOB = $true

PS C:\>$FullJobConfiguration.GenerateDetailedReport = $true

PS C:\>Run-DAPlatformBackupJob -PlanName 'plan1' -FullJobConfiguration

$FullJobConfiguration -WaitForJobComplete

ID : FB20120710150349246927

PlanName : plan1

Module : PlatformBackup

Status : Finished

StartTime : 7/10/2012 3:03:49 PM

FinishTime : 7/10/2012 3:08:54 PM

Progress : 100

Description

This command runs a platform backup job based on plan1.

Example 2

PS C:\>$DifferentialJobConfiguration = New-Object

DocAve.API.DataProtection.PlatformBackupAndRestore.PlatformBackupDiffe

rentialJobConfiguration

334


PS

C:\>$DifferentialJobConfiguration.TransferDataFromSnapshotToMediaServe

r = $True

PS

C:\>$DifferentialJobConfiguration.DeferTransferringDataFromPersistentS

napshot = $true

PS C:\>$DifferentialJobConfiguration.DeferGeneratingInstaMountMapping

= $true

PS C:\>$DifferentialJobConfiguration.RestoreGranularityLevel =

'ItemLevel'

PS

C:\>$DifferentialJobConfiguration.DeferGeneratingGranularRestoreIndex

= $true

PS C:\>$DifferentialJobConfiguration.BackupStubDatabase = $true

PS C:\>$DifferentialJobConfiguration.BackupStorageManagerBLOB = $true

PS C:\>$DifferentialJobConfiguration.BackupConnectorBLOB = $true

PS C:\>$DifferentialJobConfiguration.GenerateDetailedReport = $true

PS C:\>Run-DAPlatformBackupJob -PlanName 'plan1' -

DifferentialJobConfiguration $DifferentialJobConfiguration -

WaitForJobComplete

ID : FB20120811150349246928

PlanName : plan1


Status : Finished

StartTime : 8/11/2012 3:03:49 PM

FinishTime : 8/11/2012 3:08:54 PM

Progress : 100

Description


335


Example 3

PS C:\>$IncrementalJobConfiguration = New-Object

DocAve.API.DataProtection.PlatformBackupAndRestore.PlatformBackupIncre

mentalJobConfiguration

PS C:\>$IncrementalJobConfiguration.RestoreGranularityLevel =

'ItemLevel'

PS

C:\>$IncrementalJobConfiguration.DeferGeneratingGranularRestoreIndex =

$true

PS C:\>$IncrementalJobConfiguration.BackupStubDatabase = $true

PS C:\>$IncrementalJobConfiguration.BackupStorageManagerBLOB = $true

PS C:\>$IncrementalJobConfiguration.BackupConnectorBLOB = $true

PS C:\>$IncrementalJobConfiguration.GenerateDetailedReport = $true

PS C:\>Run-DAPlatformBackupJob -PlanName 'plan1' -

IncrementalJobConfiguration $IncrementalJobConfiguration -

WaitForJobComplete

ID : FB20120711150349246928

PlanName : plan1


Status : Finished

StartTime : 7/11/2012 3:03:49 PM

FinishTime : 7/11/2012 3:08:54 PM

Progress : 100

Description


Related Links

336


Obtain a Date Time Object


Get-DADate

Gets an instance of Date, which represents year, month or day.

Syntax Get-DADate [-Year] <Int32> [-Month] <Int32> [-Day] <Int32> [-

TimeZoneId] <SupportedTimeZoneId> [<CommonParameters>]

Description

The Get-DADate cmdlet gets an instance of Date, which represents year, month or day. The instance

returned also includes the time zone information.

Parameters -Year<Int32>

Specifies the year that is displayed. Valid value is between 1 and 9999.



true 0 false false -Month<Int32>

Specifies the month that is displayed. Valid value is between 1 and 12.



true 1 false false -Day<Int32>

Specifies the day that is displayed. Valid value is between 1 and 31.



true 2 false false -TimeZoneId<SupportedTimeZoneId>

Specifies the time zone ID.




337





Examples

Example 1



PS C:\>Get-DADate -Year 2012 -Month 03 -Day 20 -TimeZoneId $TimeZoneID

Year : 2012

Month : 3

Day : 20

TimeZone :

DocAve.API.Common.TimeZoneInfo

AutomaticallyAdjustClockForDaylightSavingTime : False

Description

This command shows how to get Date instance.

Related Links Get-DADateTime

Get-DADateTime

Gets a instance of DateTime, represents year, month, day, hour and minute.

Syntax Get-DADateTime [-Year] <Int32> [-Month] <Int32> [-Day] <Int32> [-Hour]

<Int32> [-Minute] <Int32> [-TimeZoneId] <SupportedTimeZoneId>


Description

The Get-DADate cmdlet gets an instance of DateTime, which represents year, month, day, hour or

minute. The instance returned also includes the time zone information.

338


Parameters -Year<Int32>

Specifies the year that is displayed. Valid value is between 1 and 9999.



true 0 false false -Month<Int32>

Specifies the month that is displayed. Valid value is between 1 and 12.



true 1 false false -Day<Int32>

Specifies the day that is displayed. Valid value is between 1 and 31.



true 2 false false -Hour<Int32>

Specifies the hour that is displayed. Valid value is between 0 and 23.



true 3 false false -Minute<Int32>

Specifies the minute that is displayed. Valid value is between 0 and 59.



true 4 false false -TimeZoneId<SupportedTimeZoneId>

Specifies the time zone ID.







339


Examples

Example 1



PS C:\>Get-DADateTime -Year 2012 -Month 03 -Day 20 -Hour 14 -Minute 30

-TimeZoneId $TimeZoneID

Year : 2012

Month : 3

Day : 20

Hour : 14

Minute : 30

TimeZone :

DocAve.API.Common.TimeZoneInfo

AutomaticallyAdjustClockForDaylightSavingTime : False

Description

This command shows how to get DateTime instance.

Related Links Get-DADate

Agent Monitor


Get-DAAgentService

Gets the Agent services.

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

Description

The Get-DAAgentService cmdlet gets the Agent services.

340



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.




true

<CommonParameters>




Examples

Example 1

PS C:\>Get-DAAgentService

Name Status AccountName

---- ------ -----------

agent1 Down

mydomain\account1

agent2 Up

mydomain\account2

agent3 Down

mydomain\account3

Description

This command gets the Agent services.

Related Links

Update-DAAgentService

Updates an existing Agent service.

341


Syntax Update-DAAgentService [-AgentService] <AgentService>


Description

The Update-DAAgentService cmdlet updates an existing Agent service.

Parameters -AgentService<AgentService>

Specifies an Agent service for updating.




false

<CommonParameters>




Examples

Example 1

PS C:\>$agent = Get-DAAgentService -Name 'agent1'

PS C:\>$pwd = Read-Host -AsSecureString

*****

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

PS C:\>Update-DAAgentService -AgentService $agent

Description

These commands update the account settings of the specified Agent service.

Related Links

Account Manager


342


Get-DALocalUser

Gets the information of the existing local user(s).

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

Description The Get-DALocalUser cmdlet gets the information of the existing local user(s).


Specifies the name(s) of the local user(s) you want to get. Wildcards and multiple values are

supported, which are separated by commas. If no values are entered, all the existing local users

will be gotten.




true

<CommonParameters>




Examples

Example 1

PS C:\>Get-DALocalUser

Name : user1

Email : [email protected]

Password :

SecuritySettings :

DocAve.API.ControlPanel.AccountManager.SecuritySettings

SecuritySettingsType : Customized

Type : Local User

343


Description : this is a user.

Mode : Active

UserGroupType : System Group

SystemGroups : {system group 01}

TenantGroup :

InAdministratorsGroup : False

Description

This command gets the information of all the existing local users.

Related Links Update-DAUser

Get-DABlankLocalUser

Gets a blank local user for adding a new local user.

Syntax Get-DABlankLocalUser [<CommonParameters>]

Description

The Get-DABlankLocalUser cmdlet gets a blank local user for adding a new local user.





Examples

Example 1

PS C:\>Get-DABlankLocalUser

Name :

Email :

344


Password :

SecuritySettings :

DocAve.API.ControlPanel.AccountManager.SecuritySettings

SecuritySettingsType : Default

Type : Local User

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

TenantGroup :


Description

This command retrieves a blank Local User.

Related Links New-DAUser

Get-DAActiveDirectoryUser

Gets the information of the existing active directory user(s).

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

Description

The Get-DAActiveDirectoryUser cmdlet gets the information of the existing active directory user(s).


Specifies the name(s) of the active directory user(s) you want to get. Wildcards and multiple

values are supported, which are separated by commas. If no values are entered, all the existing

active directory users will be got.

345





true

<CommonParameters>




Examples

Example 1

PS C:\>$user = Get-DAActiveDirectoryUser

PS C:\>$user

Name : example.com\user1


Type : Active Directory User

Description :

Mode : Active

UserGroupType : System Group

SystemGroups : {system group 01}

TenantGroup :


Description

This command gets the information of all the existing active directory users.


Get-DABlankActiveDirectoryUser

Gets a blank active directory user for creating an AD user.

346


Syntax Get-DABlankActiveDirectoryUser [<CommonParameters>]

Description

The Get-DABlankActiveDirectoryUser cmdlet gets a blank active directory user for creating an AD user.





Examples

Example 1

PS C:\>Get-DABlankActiveDirectoryUser

Name :

Email :

Type : Active Directory User

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

TenantGroup :


Description

This command gets a blank active directory user.


347


Get-DAActiveDirectoryGroup

Gets the information of the existing active directory group(s).

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

Description The Get-DAActiveDirectoryGroup cmdlet gets the information of the existing active directory group(s).


Specifies the name(s) of the active directory group(s) you want to get. Wildcards and multiple

values are supported, which are separated by commas. If no values are entered, all the existing

active directory groups will be got.




true

<CommonParameters>




Examples

Example 1

PS C:\>$user = Get-DAActiveDirectoryGroup

PS C:\>$user

Name : example.com\group1


Type : Active Directory Group

Description : this is an active directory group.

Mode : Active

348


UserGroupType : Tenant Group

SystemGroups : {}

TenantGroup : tenant group 01


Description

This command gets the information of all the existing active directory groups.


Get-DABlankActiveDirectoryGroup

Gets a blank active directory group for creating an AD group.

Syntax Get-DABlankActiveDirectoryGroup [<CommonParameters>]

Description

The Get-DABlankActiveDirectoryGroup cmdlet gets a blank active directory group for creating an AD

group.





Examples

Example 1

PS C:\>$user = Get-DABlankActiveDirectoryGroup

PS C:\>$user

Name :

Email :

349


Type : Active Directory Group

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

TenantGroup :


Description

This command gets a blank active directory group.


New-DAUser

Creates a new user according to the user object that you specified.

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

Description

The New-DAUser cmdlet creates a new user according to the specified user object.

Parameters -User<UserBase>

Specifies a user object to create a new user. For the structure and attributes of user, please

refer to the DocAve 6 SDK documentation for more information.







350


Examples

Example 1

PS C:\>$user = Get-DABlankLocalUser

PS C:\>$user.Name = 'user1'

PS C:\>$user.Email = '[email protected]'

PS C:\>$user.Password = Read-Host -AsSecureString

*********

PS C:\>$user.Description = 'This is a Local User'

PS C:\>

PS C:\>$groups = New-Object System.Collections.Generic.List[string]

PS C:\>$groups.Add('system group 01')

PS C:\>$user.SetSystemGroups($groups)

PS C:\>

PS C:\>$user.SetSecuritySettingsType('Customized')

PS C:\>$user.SecuritySettings.AccountIsInactive = $false

PS C:\>$user.SecuritySettings.UserMustChangePasswordAtNextLogon =

$true

PS C:\>New-DAUser -User $user

Description

These commands create a new local user.

Example 2

PS C:\>$user = Get-DABlankActiveDirectoryUser

PS C:\>$user.Name = 'example.com\user1'

PS C:\>$user.SetTenantGroup('tenant group 01')

PS C:\>New-DAUser -User $user

Description

These commands create a new active directory user.

351


Related Links Get-DABlankActiveDirectoryUser

Get-DABlankLocalUser

Update-DAUser

Get-DABlankActiveDirectoryGroup

Update-DAUser

Updates an existing user according to the user object that you specified.

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

Description

The Update-DAUser cmdlet updates an existing user according to the user object that you specified.

Parameters -User<UserBase>

Specifies a user object where you want to edit the user.







Examples

Example 1

PS C:\>$user = Get-DALocalUser -Name 'user1'

PS C:\>$user.Email = '[email protected]'

PS C:\>Update-DAUser -User $user

Description

These commands update the e-mail information of the specified local user.

352


Related Links Get-DAActiveDirectoryUser

Get-DALocalUser

New-DAUser

Get-DAActiveDirectoryGroup

Remove-DAActiveDirectoryGroup

Deletes an existing active directory group according to the group's name.

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


Description The Remove-DAActiveDirectoryGroup cmdlet deletes an existing active directory group according to the

group's name.


Specifies the name of an active directory group that you want to delete.





command.








353





Examples

Example 1

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

Description

This command deletes the specified active directory group.

Related Links Get-DAActiveDirectoryGroup

Remove-DAActiveDirectoryUser

Deletes an existing active directory user according to the user's name.

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


Description

The Remove-DAActiveDirectoryUser cmdlet deletes an existing active directory user according to the

user's name.


Specifies the name of an active directory user that you want to delete.





command.




354









Examples

Example 1

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

Description

This command deletes the specified active directory user.

Related Links Get-DAActiveDirectoryUser

Remove-DALocalUser

Deletes an existing local user according to the user's name.

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


Description

The Remove-DALocalUser cmdlet deletes an existing local user according to the user's name.


Specifies the name of a local user that you want to delete.





command.

355












Examples

Example 1

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

Description

This command deletes the specified local user.

Related Links Get-DALocalUser

Security Information Manager


Backup-DADatabaseEncryptionKey

Backs up DocAve database encryption key.

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


Description

The Backup-DADatabaseEncryptionKey cmdlet backs up the DocAve database encryption key to a file

under the specified path.


356


Specifies a path to store the backup file.




Overwrites the backup file if it already exists at the specified path.







Examples

Example 1

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

Description

This command shows how to back up DocAve database encryption key.

Related Links Restore-DADatabaseEncryptionKey

Restore-DADatabaseEncryptionKey

Restores DocAve database encryption key.

Syntax Restore-DADatabaseEncryptionKey [-Path] <String> [-OutPut] <String> [-

Overwrite] [[-Passphrase] <String>] [<CommonParameters>]

Description

The Restore-DADatabaseEncryptionKey cmdlet loads DocAve database encryption key and generates a

SQL script from the backup file under the specified path, you can restore DocAve database encryption

key by executing this SQL script.


357


Specifies a path to load the backup file.



true 0 false false -OutPut<String>





Overwrites the output file if it already exists at the specified path.



false named false false -Passphrase<String>

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. Please ensure that the

passphrases are matched between the local machine and the DocAve database, otherwise the

DocAve system will not work.



false 2 false false <CommonParameters>




Examples

Example 1

PS C:\>Restore-DADatabaseEncryptionKey -Path 'C:\backup' -OutPut

'C:\sql'

Description

This command shows how to restore DocAve database encryption key.

Example 2

358


PS C:\>Restore-DADatabaseEncryptionKey -Path 'C:\backup' -OutPut

'C:\sql' -Passphrase passphrase

Description

This command shows how to restore DocAve database encryption key with a passphrase.

Related Links Backup-DADatabaseEncryptionKey

Backup-DADataEncryptionProfile

Backs up DocAve data encryption profile.

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


Description The Backup-DADataEncryptionProfile cmdlet exports all of the DocAve security profiles that can be

accessed by the system users to a compressed file under the specified path.


Specifies a path to store the backup file.




Overwrites the backup file if it already exists at the specified path.







Examples

Example 1

359


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

Description

This command shows how to back up DocAve data encryption profile.

Related Links Restore-DADataEncryptionProfile

Restore-DADataEncryptionProfile

Restores the DocAve data encryption profile.

Syntax Restore-DADataEncryptionProfile [-Path] <String> [<CommonParameters>]

Description

The Restore-DADataEncryptionProfile cmdlet imports the exported DocAve security profiles from the

compressed file under the specified path.


Specifies a path to load the backup file.







Examples

Example 1

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

Description

This command shows how to restore DocAve data encryption profile.

Related Links Backup-DADataEncryptionProfile

360


Set-DAPassPhrase

Sets up a new value for the passphrase.

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

<SecureString> [<CommonParameters>]

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


Description The Set-DAPassPhrase cmdlet sets up a new value for the passphrase. If the LocalServerOnly parameter

is not used, the DocAve database encryption key will be re-encrypted with the new value and attempts

to propagate this value to all other servers in this DocAve system. If the LocalServerOnly parameter is

used, this is updated on the local machine only, and the DocAve database encryption key is not changed.

The passphrase value must be same on all servers in DocAve system if the DocAve system is to function

correctly. So if the passphrase fails to propagate to all servers, the LocalServerOnly parameter can be

used to set the remaining servers to a new passphrase value manually.

Parameters -PassPhrase<SecureString>

Specifies a new passphrase value.



true 0 false false -ConfirmPassPhrase<SecureString>

Confirms the new passphrase value.



true 1 false false -LocalServerOnly[<SwitchParameter>]

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 DocAve system.




361





Examples

Example 1

PS C:\>$passphrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText

-Force

PS C:\>$ConfirmPassPhrase = ConvertTo-SecureString 'PassPhrase' -

AsPlainText -Force

PS C:\>Set-DAPassPhrase -PassPhrase $passphrase -ConfirmPassPhrase

$ConfirmPassPhrase

Description

This command shows how to set up a new value for the passphrases of all the servers in DocAve system.

Example 2

PS C:\>$passphrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText

-Force

PS C:\>Set-DAPassPhrase -PassPhrase $passphrase -LocalServerOnly

Description

This command shows how to set up a new value for the passphrase of the local machine in DocAve

system.

Related Links

Set-DAFipsAlgorithmPolicy

Sets up the status of FipsAlgorithmPolicy.

Syntax Set-DAFipsAlgorithmPolicy [[-Disabled] <SwitchParameter>]


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


362


Description

The Set-DAFipsAlgorithmPolicy cmdlet sets up the status of FipsAlgorithmPolicy. The status of the

FipsAlgorithmPolicy on all of DocAve servers must be the same. After setting up the status, you must

restart all the DocAve services on each server.

Parameters -Disabled[<SwitchParameter>]

Enters this parameter to disable the FipsAlgorithmPolicy.



false 1 false false -Enabled[<SwitchParameter>]

Enters this parameter to enable the FipsAlgorithmPolicy.



false 0 false false <CommonParameters>




Examples Example 1

PS C:\>Set-DAFipsAlgorithmPolicy -Enabled

Description

This command shows how to enable the FipsAlgorithmPolicy.

Example 2

PS C:\>Set-DAFipsAlgorithmPolicy -Disabled

Description

This command shows how to disable the FipsAlgorithmPolicy.

Related Links

363


Physical Device


Get-DAPhysicalDevice

Gets the detailed information of the specified physical device(s).

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

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

Description

The Get-DAPhysicalDevice cmdlet gets the detailed information of the physical device(s).


Specifies one or more physical device names. Multiple physical device names must be separated

by commas. Wildcards are supported. If you do not type any value for the parameter, the

information of all the physical devices will be returned.




true

-Type<StorageType>

Specifies the physical device type. Valid values are "NetShare", "FTP", "TSM", "EMCCentera",

"CloudStorage", "DELLDXStorage", "CaringoStorage", "HDSHitachiContentPlatform",

"DataONTAPLUN" and "DataONTAPCIFSShare".







Examples Example 1

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

364


StorageType : DataONTAPCIFSShare

StorageSystemProfile : storage system profile1

ShareName : FilerA: sharename1

UNCPath : \\10.0.0.1\sharename2

FreeSpace : 2.06105G

TotalSize : 7G

IsSnapLock : False

Username : example.com\user1

Password :

ExtendedParameters :

Farms : {Farm(SP2010_DB:SHAREPOINT_CONFIG)}

SpaceThreshold : 1024MB

Name : physical device1

Description : this is a CIFS Share physical device

SpaceUsage : 2.06GB free of 7.00GB

Description

This command gets the detailed information of the physical device whose name is 'physical device1'.

Example 2

PS C:\>Get-DAPhysicalDevice




365




TotalSize : 7G

IsSnapLock : False


Password :


Farms : {}



Description : this is a physical device







TotalSize : 4G

IsSnapLock : True


Password :

ExtendedParameters : SnapLockEnabled = True

Farms : {Farm(SP2010_DB:SHAREPOINT_CONFIG)}



Description :

366



Description

This command gets the detailed information of all the physical devices.

Example 3

PS C:\>Get-DAPhysicalDevice -Type DataONTAPCIFSShare






TotalSize : 4G

IsSnapLock : False


Password :


Farms : {}



Description :


Description

This command gets the detailed information of the physical device whose storage type is

DataONTAPCIFSShare.

Related Links New-DAPhysicalDevice

367


Get-DABlankPhysicalDevice

Gets a blank physical device for creating a new physical device.

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

Description The Get-DABlankPhysicalDevice cmdlet gets a blank physical device for creating a new physical device.

Parameters -Type<String>

Specifies a storage type for the physical device. Valid values are "DataONTAPCIFSShare" and

"NetShare".







Examples

Example 1

PS C:\>Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare


StorageSystemProfile :

ShareName :

UNCPath :

FreeSpace :

TotalSize :

IsSnapLock : False

368


Username :

Password :


Farms : {}


Name :

Description :

SpaceUsage :

Description

This command gets a blank Data ONTAP (CIFS Share) physical device.

Related Links New-DAPhysicalDevice

New-DAPhysicalDevice

Creates a new physical device.

Syntax New-DAPhysicalDevice [-PhysicalDevice] <PhysicalDeviceBase>


Description

The New-DAPhysicalDevice cmdlet creates a new physical device.

Parameters -PhysicalDevice<PhysicalDeviceBase>

Specifies a physical device object. About the structure and attributes of the physical device,

refer to the DocAve SDK Documentation for more information.







369


Examples

Example 1

PS C:\>$device = Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare

PS C:\>$device.Name = 'physical device1'

PS C:\>$device.StorageSystemProfile = 'storage system profile1'

PS C:\>$device.ShareName = 'FilerA: sharename1'

PS C:\>$device.AccountProfile = 'example.com\user1'

*********

PS C:\>$device.SpaceThreshold = '1300MB'

PS C:\>$device.ExtendedParameters = 'SnapLockEnabled = True'

PS C:\>$device.Farms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

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

PS C:\>

Description

These commands create a Data ONTAP (CIFS Share) physical device.

Example 2

PS C:\>$device = Get-DABlankPhysicalDevice -Type NetShare


PS C:\>$device.Description = 'Description'

PS C:\>$device.SpaceThreshold = '1024MB'

PS C:\>$device.ExtendedParameters.Add("AuthMethod=NetUse")

PS C:\>$device.ExtendedParameters.Add("IsRetry=true")

PS C:\>$device.UNCPath = '\\admin-PC\c$\data'

PS C:\>$device.AccountProfile = 'example.com\user1'

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

PS C:\>

Description

370


These commands create a Net Share physical device.

Related Links Get-DABlankPhysicalDevice

Update-DAPhysicalDevice

Updates an existing physical device.

Syntax Update-DAPhysicalDevice [-PhysicalDevice] <PhysicalDeviceBase>


Description

The Update-DAPhysicalDevice cmdlet updates an existing physical device.

Parameters -PhysicalDevice<PhysicalDeviceBase>

Specifies an existing physical device object to be updated.







Examples

Example 1

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



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

PS C:\>

Description

These commands update the specified physical device.

371


Related Links Get-DAPhysicalDevice

Remove-DAPhysicalDevice

Deletes an existing physical device.

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


Description

The Remove-DAPhysicalDevice cmdlet deletes an existing physical device.


Specifies the name of an existing physical device that you want to delete.





command.











Examples

Example 1

372


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

Description

This command deletes the specified physical device.

Related Links Get-DAPhysicalDevice

Logical Device


Get-DALogicalDevice

Gets the information of the specified logical devices.

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

Description

The Get-DALogicalDevice cmdlet gets the information of the specified logical devices.


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.




true

<CommonParameters>




Examples

Example 1

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

373


Name : logical device1

Description : this is a logical device.

StorageType : FTP

PhysicalDeviceList : {physical device1}

Description

This command gets the information of the logical device whose name is logical device1.

Example 2

PS C:\>Get-DALogicalDevice


Description : this is a logical device.

StorageType : FTP



Description :

StorageType : NetShare


Description

This command gets the information of all the logical devices.

Related Links Update-DALogicalDevice

Get-DABlankLogicalDevice

Gets a blank logical device for creating a new logical device

374


Syntax Get-DABlankLogicalDevice [<CommonParameters>]

Description

The Get-DABlankLogicalDevice cmdlet gets a blank logical device for creating a new physical device.





Examples

Example 1

PS C:\>Get-DALogicalDevice

Name :

Description :


PhysicalDeviceList :

Description

This command gets a blank logical device.

Related Links New-DALogicalDevice

New-DALogicalDevice

Creates a new logical device.

Syntax New-DALogicalDevice [-LogicalDevice] <LogicalDevice>


Description

The New-DALogicalDevice cmdlet creates a new logical device.

375


Parameters -LogicalDevice<LogicalDevice>

Specifies a logical device object. About the structure and attribute of Logical Device, please refer

to the DocAve SDK documentation for more information.







Examples Example 1

PS C:\>$device = Get-DABlankLogicalDevice

PS C:\>$device.name = 'Logical Device'


PS C:\>$device.StorageType = 'NetShare'

PS C:\>$entity1 = New-Object

Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('phy

sical device 1')



sical device 2')



sical device 3')

PS C:\>$entity1.StorageData = $true

PS C:\>$entity1.StorageIndex = $false

PS C:\>$entity2.StorageData = $false

PS C:\>$entity2.StorageIndex =$true

PS C:\>$entity3.StorageData =$true

PS C:\>$entity3.StorageIndex =$true

376


PS C:\>$device.AddPhysicalDevice($entity1)



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

PS C:\>

Description

These commands show how to create a logical device.

Related Links Get-DABlankLogicalDevice

Update-DALogicalDevice

Updates an existing logical device.

Syntax Update-DALogicalDevice [-LogicalDevice] <LogicalDevice>


Description

The Update-DALogicalDevice cmdlet updates an existing logical device.

Parameters -LogicalDevice<LogicalDevice>

Specifies a logical device object to be updated.







Examples Example 1

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

377


PS C:\>$device | fl


Description : description



PS C:\>$device.RemovePhysicalDevice('physical device1')

PS C:\>$entity = New-Object


sical device 2')

PS C:\>$entity.StorageIndex =$true

PS C:\>$entity.StorageData =$true

PS C:\>$device.AddPhysicalDevice($entity)

PS C:\>$device.PhysicalDeviceList | fl


StorageData : True

StorageIndex : True

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

378


PS C:\>

Description

These commands update an existing logical device.

Related Links Get-DALogicalDevice

Remove-DALogicalDevice

Deletes an existing logical device.

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


Description

The Remove-DALogicalDevice cmdlet deletes an existing logical device.


Specifies the name of the logical device that you want to delete.





command.








379





Examples

Example 1

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

Description

This command deletes the specified logical device.

Related Links Get-DALogicalDevice

Storage Policy


Get-DAStoragePolicy

Gets the information of the specified storage policies.

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

Description

The Get-DAStoragePolicy cmdlet gets the information of the specified storage policies.


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.




true

<CommonParameters>

380





Examples

Example 1

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

Name : storage policy

Description : this is a storage policy.

PrimaryStorage : logical device 1

MediaServiceUseStrategy : DefaultPriority

MediaServiceNames : {service1}

EnableRetentionRule : False

StoragePolicyType : None

Description

This command gets the information of the storage policy whose name is 'storage policy'.

Related Links Update-DAStoragePolicy

Get-DABlankStoragePolicy

Gets a blank storage policy for creating a new storage policy.

Syntax Get-DABlankStoragePolicy [<CommonParameters>]

Description

The Get-DABlankStoragePolicy cmdlet gets a blank storage policy for creating a new storage policy.


381





Examples

Example 1

PS C:\>Get-DABlankStoragePolicy

Name :

Description :

PrimaryStorage :

MediaServiceUseStrategy : DefaultPriority

MediaServiceNames : {}

EnableRetentionRule : False

StoragePolicyType : None

Description

This command gets a blank storage policy.

Related Links New-DAStoragePolicy

New-DAStoragePolicy

Creates a new storage policy.

Syntax New-DAStoragePolicy [-StoragePolicy] <StoragePolicy>


Description

The New-DAStoragePolicy cmdlet creates a new storage policy.

Parameters -StoragePolicy<StoragePolicy>

382


Specifies a storage policy object. About the structure and attributes of the storage policy, refer

to the DocAve SDK Documentation for more information.







Examples

Example 1

PS C:\>$policy = Get-DABlankStoragePolicy

PS C:\>$policy.Name = 'storage policy 01'

PS C:\>$policy.Description = 'This is a new storage policy'

PS C:\>$policy.PrimaryStorage = 'logical device 01'

PS C:\>$policy.MediaServiceUseStrategy = 'CustomPriority'

PS C:\>$policy.MediaServiceNames.Add('service1')

PS C:\>$policy.MediaServiceNames.Add('service2')

PS C:\>New-DAStoragePolicy -StoragePolicy $policy

PS C:\>

Description

These commands create a storage policy.

Related Links Get-DABlankStoragePolicy

Update-DAStoragePolicy

Updates an existing storage policy.

Syntax Update-DAStoragePolicy [-StoragePolicy] <StoragePolicy>


383


Description

The Update-DAStoragePolicy cmdlet updates an existing storage policy.

Parameters -StoragePolicy<StoragePolicy>

Specifies an existing storage policy to be updated.







Examples

Example 1

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

PS C:\>$policy.Name = 'storage policy 2'

PS C:\>$policy.Description = 'updates the storage policy'

PS C:\>$policy.MediaServiceUseStrategy ='DefaultPriority'

PS C:\>Update-DAStoragePolicy -StoragePolicy $policy

PS C:\>

Description

These commands update an existing storage policy.

Related Links New-DAStoragePolicy

Get-DAStoragePolicy

Remove-DAStoragePolicy

Deletes an existing storage policy.

384


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


Description

The Remove-DAStoragePolicy cmdlet deletes an existing storage policy.


Specifies the name of the storage policy that you want to delete.





command.











Examples

Example 1

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

Description

This command deletes the specified storage policy.

Related Links Get-DAStoragePolicy

385


New-DAStoragePolicy

Update Manager


Upload-DAUpdate

Uploads the update to manager.

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

Description

The Upload-DAUpdate cmdlet uploads the upate to manager.


Specifies the path of the update file.




Allows the cmdlet to overwrite an existing update.







Examples

Example 1

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

Description

This command uploads the update to manager and will overwrite the update if existed.

386


Related Links Get-DAUpdate

Get-DAUpdate

Gets the update(s) information.

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

Description

The Get-DAUpdate cmdlet gets the update(s) according to the name you specified, if you do not set any

value for the parameter, all the updates will be returned.


Specifies one or more updates' names. You can type multiple update names (separated by

commas). Wildcards are supported.




true

<CommonParameters>




Examples

Example 1

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

Name : HotFix_6.0.0.51008601

Type : Optional

Size : 52812417

Status : ReadyForInstall

387


PublishTime : 11/3/2011 5:29:37 PM

Description

This command retrieves the update named 'HotFix_6.0.0.51008601'.

Related Links Install-DAUpdate

Get-DAUpdateConfiguration

Gets an update configuration.

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


Description

The Get-DAUpdateConfiguration cmdlet gets a configuration with the update.

Parameters -UpdateName<String[]>

Specifies one or more udpates' names. You can type multiple update names(separated by

commas).







Examples

Example 1

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

UpdateNames : {Hotfix_6.0.0.51008601}

UpdateManager : False

UpdateFarms : {}

388


UpdateSQLAgents : {}

UpdateNonFarmRelatedAgent : False

Description

This command retrieves the update configuration base on update 'Hotfix_6.0.0.51008601'.


Test-DAUpdate

Test-DAUpdate

Tests whether the update is valid.

Syntax Test-DAUpdate [-Configuration] <UpdateConfiguration>


Description

The Test-DAUpdate cmdlet tests whether the update is valid. It returns TRUE ($true) if there is no

warning and no error.

Parameters -Configuration<UpdateConfiguration>

Specifies an update configuration object.







Examples

Example 1

PS C:\>$config = Get-DAUpdateConfiguration -UpdateName

'Hotfix_6.0.0.51008601'

PS C:\>$config.UpdateManager = $true

389


PS C:\>$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.

PS C:\>$config.UpdateNonFarmRelatedAgent = $true

PS C:\>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

PS C:\>$config.UpdateSQLAgents.Add('SQL Agent')

PS C:\>$config.RestartIIS = $true

PS C:\>$config.UpdateGovernanceAutomations.Add("Governance Automation

Host");

PS C:\>Test-DAUpdate -Configuration $config

True

Description

This command tells whether there are warnings. If no warning returns True, Otherwise, it writes the

warning messages.


Install-DAUpdate

Installs update.

Syntax Install-DAUpdate [-Configuration] <UpdateConfiguration> [-WhatIf] [-


390


Description

The Install-DAUpdate cmdlet installs update basing on the update configuration.

Parameters -Configuration<UpdateConfiguration>

Specifies an update configuration object.





command.











Examples

Example 1

PS C:\>$config = Get-DAUpdateConfiguration -UpdateName

'Hotfix_6.0.0.51008601'

PS C:\>$config.UpdateManager = $true

PS C:\>$config.ViewServiceForUpdate()

Category : 127.0.0.1

WillUpdate : True

391


Name : Control Service

Status : Up

Version : 6.0.0.51008601

Type : Control

Message : Ready for installing.

......

PS C:\>$config.UpdateNonFarmRelatedAgent = $true

PS C:\>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

PS C:\>$config.UpdateSQLAgents.Add('SQL Agent')

PS C:\>$config.RestartIIS = $true

PS C:\>$config.UpdateGovernanceAutomations.Add("Governance Automation

Host");

PS C:\>Install-DAUpdate -Configuration $config

Description

This command retrieves the update configuration base on update 'Hotfix_6.0.0.51008601'.

Related Links Test-DAUpdate

Get-DAUpdate

Job Monitor


Get-DAJob

Gets job information in the Job Monitor.

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

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

StartTimeRangeEnding <DateTime>] [<CommonParameters>]

392


Description

The Get-DAJob cmdlet gets job information in the Job Monitor.






false

-Module<Module>

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".

Note: If you specify to get all of the jobs of Connector module, all of the Connector and Cloud

Connect jobs will be obtained.



true 0 false false -StartTimeRangeBeginning<DateTime>

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, it will not filter the job information according to job start

time.




393


-StartTimeRangeEnding<DateTime>

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.







Examples

Example 1

PS C:\>Get-DAJob -Id CA20120710105416471063

ID : CA20120710105416471063



Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

Progress : 100

Description

This command retrieves the job whose id is CA20120710105416471063.

Example 2

PS C:\>Get-DAJob -Module Administrator

394


ID : CA20120710105416471063



Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

Progress : 100

ID : CA20120710105904343484



Status : Finished

StartTime : 2012/7/10 10:59:04

FinishTime : 2012/7/10 11:00:26

Progress : 100

Description

This command searches all Administrator jobs.

Example 3

PS C:\>Get-DAJob -Module Administrator -StartTimeRangeBeginning

"7/10/2012 10:10" -StartTimeRangeEnding "7/10/2012 10:58"

ID : CA20120710105416471063



Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

395


Progress : 100

Description

This command searches Administrator jobs in the specified start time range.

Related Links Get-DAJobDetail

Get-DAJobSummary

Get-DAJobDetail

Gets job detailed report.

Syntax Get-DAJobDetail [-ID] <String> [-JobReportDetailStatus

<JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>]


Description The Get-DAJobDetail cmdlet gets job details of the specified job.






false



"Filtered". If the job is a Deployment Manager job, this parameter will be ignored.



false named false false -StartIndex<Int32>

Specifies the start number of the details that you want to get. If the job is a Deployment

Manager job, this parameter will be ignored.

396




false named false false -Length<Int32>

Specifies the total number of details in the result. If the job is a Deployment Manager job, this

parameter will be ignored.







Examples

Example 1

PS C:\>Get-DAJobDetail -ID CM20111011115232293242

Key Value

--- -----




Agent

Size 0Bytes

Status Success

Description

This command retrieves all the details of the job whoes id is CM20111011115232293242.

Example 2

PS C:\>Get-DAJobDetail -ID CM20111011115233293432 -

JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1

397


Key Value

--- -----




Agent

Size 0Bytes

Status Success

Description

This command retrieves the first detail of the job.

Related Links Get-DAJob

Get-DAJobSummary

Get-DAArchiverJobDetailForDeletion

Get-DAArchiverJobDetailForBackup

Get-DAJobSetting

Gets the job settings.

Syntax Get-DAJobSetting [-ID] <String> [<CommonParameters>]

Description

The Get-DAJobSetting cmdlet gets the settings of the specified job.






false

<CommonParameters>

398





Examples

Example 1

PS C:\>Get-DAJobSetting -ID cm20131028111320255224

Key Value

--- -----

Common Settings-Method Copy

Common Settings-Action Attach

Common Settings-Backup the Destinati... No

Advanced Settings-Filter Policy None

Advanced Settings-Configuration Copy/Move configuration

Advanced Settings-Security Copy/Move security

Advanced Settings-Content Copy/Move content

Advanced Settings-Include List Attac... Yes

Advanced Settings-Include User Profile No

Advanced Settings-Include Workflow D... No

Advanced Settings-Include Workflow I... No

Advanced Settings-Managed Metadata S... Copy Managed Metadata Service

Advanced Settings-Copy Managed Metad... Term set

Advanced Settings-Preserve the Null ... Yes

Advanced Settings-Collapse Folder St... No

Advanced Settings-Data Compression No

Advanced Settings-Data Encryption No

Advanced Settings-Column Mapping None

399


Advanced Settings-Content Type Mapping None

Advanced Settings-Template Mapping None

Advanced Settings-User Mapping None

Advanced Settings-Domain Mapping None

Advanced Settings-Language Mapping None

Advanced Settings-List Name Mapping None

Advanced Settings-Container Level Co... Skip

Advanced Settings-Check Lower Objects Yes

Advanced Settings-Content Level Conf... Skip

Advanced Settings-Apps Conflict Reso... Skip

Advanced Settings-Notification None

Advanced Settings-Associated Plan Group None

Description

This command gets the settings of the job whose Job ID is CM20131028111320255224.


Get-DAJobSummary

Get-DAJobDetail

Get-DAJobSummary

Gets job summary.

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

Description The Get-DAJobSummary cmdlet gets the summary of the specified job. The summary includes the

general information of the job.


400






false

<CommonParameters>




Examples

Example 1

PS C:\>Get-DAJobSummary -ID CA20120710105416471063

Key Value

--- -----

Job Information-Plan Name

DeadAccountCleaner_PLAN20120710105504

Job Information-Description

Job Information-Plan Type Dead

Account Cleaner

Job Information-Job ID

CA20120710105416471063

Job Information-Start Time 2012-07-10

10:54:16 (UTC+08:00) Beijing, Chongqing, Hong...

Job Information-Finish Time 2012-07-10

10:55:01 (UTC+08:00) Beijing, Chongqing, Hong...

Job Information-Job Operated By admin

Job Information-Plan Modified By admin

Environment Information-Farm Name

Farm(SP2010_DB:SHAREPOINT_CONFIG)

Environment Information-Agent Host SP2010

Environment Information-Manager Version 6.1.0.1101

Environment Information-Agent Version 6.1.0.3005

401


Statistics-Status Finished

Statistics-Comment

Statistics-The Number of Successful Objects 0

Statistics-The Number of Failed Objects 0

Statistics-The Number of Skipped Objects 4

Description

This command retrieves the summary of the job whose job id is CA20120710105416471063.


Get-DAJobDetail

Download-DAJobReport

Downloads the job report.

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


Description

The Download-DAJobReport cmdlet downloads the report of the specified job.






false

-Format<JobReportFormat>

Specifies the format of the report. Valid values are "XLS","CSV" and "TXT". If the job is a Log

Manager job, this parameter will be ignored.



false named XLS false false -Path<String>

402


Specifies the path of the report file.



true named false false -Overwrite[<SwitchParameter>]








Examples

Example 1

PS C:\>Download-DAJobReport -ID FB20120627174730343482 -Path

'C:\Report.zip' -Format txt -Overwrite

Description

This command downloads the job report to C:\Report.zip. The report format is txt.


Health Analyzer


Export-DAHealthAnalyzerReport

Exports the Health Anallyzer report.

Syntax Export-DAHealthAnalyzerReport -JobId <String> -File <String> [-


Description

The Export-DAHealthAnalyzerReport cmdlet exports the Health Analyzer report.

403


Parameters -JobId<String>




true named false false -File<String>

Specifies the path of the report file. The reprot format should be txt xls or csv.



true named false false -Overwrite[<SwitchParameter>]








Examples

Example 1

PS C:\>Export-DAHealthAnalyzerReport -JobId HAR20131118012748724634 -

File 'C:\Report.txt' -Overwrite

Description

This command exports the Health Analyzer report to C:\Report.txt. The report file format is .txt.


404


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-2014 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

SDK and Management Shell User Guide - AvePoint · 2017-05-01 · SDK and Management Shell User...

Documents

Transcript of SDK and Management Shell User Guide - AvePoint · 2017-05-01 · SDK and Management Shell User...