DocAve 6 SDK and Management Shell

Transcription

1 DocAve 6 SDK and Management Shell User Guide Service Pack 4, Cumulative Update 2 Revision L Issued July 2014

2 Table of Contents About SDK and Management Shell Configuration Agents Getting Started Environment Requirement DocAve 6 SDK Supported Features in DocAve SDK Breaking Changes in DocAve SDK Implementing DocAve API for Granular Backup Functions Logging into DocAve Invoking the Granular Backup Service Creating a New Plan Getting Plans Getting all of the Granular Backup plans Getting a Granular Backup Plan with Specified Plan Name Updating an Existing Granular Backup Plan Running a Granular Backup Plan Getting Job Information Downloading Job Report Completing a Granular Backup Process DocAve 6 Management Shell Installation Access DocAve 6 Management Shell Upgrading DocAve SDK and Management Shell DocAve Management Shell Cmdlet Reference Log Into DocAve Manager Login-DAManager Log Out of DocAve Manager Logout-DAManager

3 Administrator Get-DASPBlankSecuritySearchSetting Search-DASPPermission Get-DASPBlankCloneUserPermissionSetting Clone-DASPUserPermission Get-DASPBlankCloneGroupPermissionSetting Clone-DASPGroupPermission Scan-DASPDeadAccount Remove-DASPDeadAccount Check-DASPInheritingPermissions Stop-DASPInheritingPermissions Content Manager Get-DAContentManagerOnlinePlan Get-DAContentManagerBlankOnlinePlan New-DAContentManagerOnlinePlan Update-DAContentManagerOnlinePlan Remove-DAContentManagerOnlinePlan Run-DAContentManagerCopyJob Run-DAContentManagerExportJob Run-DAContentManagerImportJob Run-DAContentManagerMoveJob Get-DAContentManagerJobConfigurationDetail Get-DAContentManagerJobSecurityDetail Deployment Manager Get-DADeploymentManagerPlan Get-DADeploymentManagerBlankPlan New-DADeploymentManagerPlan Update-DADeploymentManagerPlan Remove-DADeploymentManagerPlan Run-DADeploymentManagerJob Replicator Run-DAReplicatorOnlineJob

4 Run-DAReplicatorExportJob Run-DAReplicatorImportJob BLOB Provider Get-DABLOBProviderBinariesInfo Get-DAStubDBConfiguration Configure-DAStubDB Get-DABLOBProviderConfiguration Save-DABLOBProviderConfiguration Archiver Run-DAArchiverJob Run-DAArchiverIndexJob Get-DAArchiverIndexDataInfo Get-DAArchiverJobDetailForBackup Get-DAArchiverJobDetailForDeletion Set-DAArchiverIndexDataInfo Storage Manager Export-DABLOBTraceOfStub New-DARemapStorageManagerLogicalDeviceConfiguration Remap-DAStorageManagerLogicalDevice Real-Time Storage Manager Get-DARealtimeStorageManagerRule Get-DARealtimeStorageManagerBlankRule New-DARealtimeStorageManagerRule Update-DARealtimeStorageManagerRule Remove-DARealtimeStorageManagerRule Reuse-DARealtimeStorageManagerRule Retract-DARealtimeStorageManagerRule SharePoint Migration Get-DASPMigrationJobObjectsDetail Get-DASPMigrationJobConfigurationDetail Get-DASPMigrationJobPermissionDetail SharePoint 2007 to 2010 Migration

5 Get-DASP07To10MigrationOnlinePlan Get-DASP07To10MigrationBlankOnlinePlan New-DASP07To10MigrationOnlinePlan Update-DASP07To10MigrationOnlinePlan Remove-DASP07To10MigrationOnlinePlan Run-DASP07To10MigrationOnlineJob Get-DASP07To10MigrationJobConfigurationDetail Get-DASP07To10MigrationJobObjectsDetail Get-DASP07To10MigrationJobPermissionDetail Download-DASP07To10MigrationOnlineProfile Upload-DASP07To10MigrationOnlineProfile SharePoint 2007 to 2013 Migration Get-DASP07To13MigrationOnlinePlan Get-DASP07To13MigrationBlankOnlinePlan New-DASP07To13MigrationOnlinePlan Update-DASP07To13MigrationOnlinePlan Remove-DASP07To13MigrationOnlinePlan Run-DASP07To13MigrationOnlineJob Download-DASP07To13MigrationOnlineProfile Upload-DASP07To13MigrationOnlineProfile SharePoint 2010 to 2013 Migration Get-DASP10To13MigrationOnlinePlan Get-DASP10To13MigrationBlankOnlinePlan New-DASP10To13MigrationOnlinePlan Update-DASP10To13MigrationOnlinePlan Remove-DASP10To13MigrationOnlinePlan Run-DASP10To13MigrationOnlineJob Download-DASP10To13MigrationOnlineProfile Upload-DASP10To13MigrationOnlineProfile Lotus Notes Migration Get-DALotusNotesMigrationOnlinePlan Get-DALotusNotesMigrationBlankOnlinePlan

6 New-DALotusNotesMigrationOnlinePlan Update-DALotusNotesMigrationOnlinePlan Remove-DALotusNotesMigrationOnlinePlan Run-DALotusNotesMigrationOnlineJob Download-DALotusNotesMigrationOnlineMappingOptionsProfile Upload-DALotusNotesMigrationOnlineMappingOptionsProfile Download-DALotusNotesMigrationOnlineMigrationOptionsProfile Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile File System Migration Get-DAFileSystemMigrationOnlinePlan Get-DAFileSystemMigrationBlankOnlinePlan New-DAFileSystemMigrationOnlinePlan Generate-DAFileSystemMigrationMetadataFile Update-DAFileSystemMigrationOnlinePlan Remove-DAFileSystemMigrationOnlinePlan Run-DAFileSystemMigrationOnlineJob Download-DAFileSystemMigrationOnlineMappingOptionsProfile Upload-DAFileSystemMigrationOnlineMappingOptionsProfile Download-DAFileSystemMigrationOnlineMigrationOptionsProfile Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile Livelink Migration Get-DALivelinkMigrationOnlinePlan Get-DALivelinkMigrationBlankOnlinePlan New-DALivelinkMigrationOnlinePlan Update-DALivelinkMigrationOnlinePlan Remove-DALivelinkMigrationOnlinePlan Run-DALivelinkMigrationOnlineJob Download-DALivelinkMigrationOnlineMappingOptionsProfile Upload-DALivelinkMigrationOnlineMappingOptionsProfile Download-DALivelinkMigrationOnlineMigrationOptionsProfile Upload-DALivelinkMigrationOnlineMigrationOptionsProfile eroom Migration

7 Get-DAERoomMigrationOnlinePlan Get-DAERoomMigrationBlankOnlinePlan New-DAERoomMigrationOnlinePlan Update-DAERoomMigrationOnlinePlan Remove-DAERoomMigrationOnlinePlan Run-DAERoomMigrationOnlineJob Download-DAERoomMigrationOnlineMappingOptionsProfile Upload-DAERoomMigrationOnlineMappingOptionsProfile Download-DAERoomMigrationOnlineMigrationOptionsProfile Upload-DAERoomMigrationOnlineMigrationOptionsProfile Exchange Public Folder Migration Get-DAExchangePublicFolderMigrationOnlinePlan Get-DAExchangePublicFolderMigrationBlankOnlinePlan New-DAExchangePublicFolderMigrationOnlinePlan Update-DAExchangePublicFolderMigrationOnlinePlan Remove-DAExchangePublicFolderMigrationOnlinePlan Run-DAExchangePublicFolderMigrationOnlineJob Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile EMC Documentum Migration Get-DADocumentumMigrationOnlinePlan Get-DADocumentumMigrationBlankOnlinePlan New-DADocumentumMigrationOnlinePlan Update-DADocumentumMigrationOnlinePlan Remove-DADocumentumMigrationOnlinePlan Run-DADocumentumMigrationOnlineJob Download-DADocumentumMigrationOnlineMappingOptionsProfile Upload-DADocumentumMigrationOnlineMappingOptionsProfile Download-DADocumentumMigrationOnlineMigrationOptionsProfile Upload-DADocumentumMigrationOnlineMigrationOptionsProfile

8 Quickr Migration Get-DAQuickrMigrationOnlinePlan Get-DAQuickrMigrationBlankOnlinePlan New-DAQuickrMigrationOnlinePlan Update-DAQuickrMigrationOnlinePlan Remove-DAQuickrMigrationOnlinePlan Run-DAQuickrMigrationOnlineJob Download-DAQuickrMigrationOnlineMappingOptionsProfile Upload-DAQuickrMigrationOnlineMappingOptionsProfile Download-DAQuickrMigrationOnlineMigrationOptionsProfile Upload-DAQuickrMigrationOnlineMigrationOptionsProfile Granular Backup and Restore Get-DAGranularBackupPlan Get-DAGranularBackupBlankPlan New-DAGranularBackupPlan Update-DAGranularBackupPlan Remove-DAGranularBackupPlan Run-DAGranularBackupJob Platform Backup and Restore Run-DAPlatformBackupJob Obtain a Date Time Object Get-DADate Get-DADateTime Agent Monitor Get-DAAgentService Update-DAAgentService Account Manager Get-DALocalUser Get-DABlankLocalUser Get-DAActiveDirectoryUser Get-DABlankActiveDirectoryUser Get-DAActiveDirectoryGroup

9 Get-DABlankActiveDirectoryGroup New-DAUser Update-DAUser Remove-DAActiveDirectoryGroup Remove-DAActiveDirectoryUser Remove-DALocalUser Security Information Manager Backup-DADatabaseEncryptionKey Restore-DADatabaseEncryptionKey Backup-DADataEncryptionProfile Restore-DADataEncryptionProfile Set-DAPassPhrase Set-DAFipsAlgorithmPolicy Physical Device Get-DAPhysicalDevice Get-DABlankPhysicalDevice New-DAPhysicalDevice Update-DAPhysicalDevice Remove-DAPhysicalDevice Logical Device Get-DALogicalDevice Get-DABlankLogicalDevice New-DALogicalDevice Update-DALogicalDevice Remove-DALogicalDevice Storage Policy Get-DAStoragePolicy Get-DABlankStoragePolicy New-DAStoragePolicy Update-DAStoragePolicy Remove-DAStoragePolicy Update Manager

10 Upload-DAUpdate Get-DAUpdate Get-DAUpdateConfiguration Test-DAUpdate Install-DAUpdate Job Monitor Get-DAJob Get-DAJobDetail Get-DAJobSetting Get-DAJobSummary Download-DAJobReport Health Analyzer Export-DAHealthAnalyzerReport Notices and Copyright Information

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

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

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 Create a new plan Restore Update the settings of an existing plan Delete a plan Get all of the existing plans Run a plan Platform Backup and Run a plan Restore 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 13

14 DocAve Version Module/Area Supported Features 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 Real-time Storage Manager Scheduled Storage Manager SharePoint 2007 to 2010 migration (online mode) 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 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 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 Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Update Manager Get all of the available update Upload an update Test an update Install an update Storage Configuration Get all of the existing physical devices Create a physical device of the CIFS Share type Get all of the existing logical devices 14

15 DocAve Version Module/Area Supported Features 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 Download a profile Migration Upload a profile SharePoint 2007 to 2013 Migration SharePoint 2010 to 2013 Migration Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Download profile Upload profile Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Download profile Upload profile File System Migration Generate the metadata file(s) for the migrated contents Get a blank plan Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Update a plan eroom Migration Get a blank plan Get all of the existing plans Create a new plan Update the settings of an existing plan 15

16 DocAve Version Module/Area Supported Features Delete a plan Run a plan Lotus Notes Migration Get a blank plan Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan DocAve 6 SP3 File System Migration Upload/download a migration options profile Upload/download a mapping options profile Lotus Notes Migration Upload/download a migration options profile Upload/download a mapping options profile eroom Migration Upload/download a migration options profile Upload/download a mapping options profile Livelink Migration Get a blank plan Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Upload/download a migration options profile Upload/download a mapping options profile Exchange Public Folder Migration Get a blank plan Get all of the existing plans Create a new plan Update the settings of an existing plan Delete a plan Run a plan Upload/download a migration options profile Upload/download a mapping options profile Physical Device Get a blank net share physical device Get all of the existing net share physical devices Create a new net share physical device Update the settings of an existing net share physical device Delete a net share physical device Logical Device Get a blank logical device Get all of the existing logical devices Create a new logical device Update the settings of an existing logical device Delete a logical device Storage Policy Get a blank storage policy Get all of the existing storage policies Create a new storage policy 16

17 DocAve Version Module/Area Supported Features 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 Log into Manager Export a report 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. 17

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 18

19 apping class and add these two properties to the DocAve.API.Administration.DeploymentManager.DeploymentManagerDesignElementIm portmapping or DocAve.API.Administration.DeploymentManager.DeploymentManagerDesignElementO nlinemapping class derived from DeploymentManagerDesignElementMapping. 19

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 20

21 Logging into DocAve To log into DocAve, refer to the following example: string docavehost = " "; 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. = "The plan is for demo"; granularbackupplan.storagepolicyname = "Storage Policy 1"; granularbackupplan.restorelevel = GranularBackupRestoreLevel.ItemLevel; granularbackupplan.includeuserprofile = true; granularbackupplan.includeworkflowdefinition = true; 21

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)", " 3. Add the object to the tree. granularbackupplan.tree.includespobject(site1); 4. Use CreatePlan Method to create a plan. granularbackupservice.createplan(granularbackupplan); 22

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. = "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. SharePointSite site2 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", " GranularBackup"); 23

24 3. Add the new object to the tree. granularbackupplan.tree.includespobject(site2); 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, false); 24

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 = " "; 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 25

26 GranularBackupPlan granularbackupplan = granularbackupservice.getblankplan(); granularbackupplan.name = "Plan1"; granularbackupplan. = "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)"; SharePointSite site1 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", " #endregion #region granularbackupplan.tree.includespobject(site1); granularbackupservice.createplan(granularbackupplan); List<GranularBackupPlan> allplans = granularbackupservice.getplans(); GranularBackupPlan plan = granularbackupservice.getplan("plan1"); #endregion #region 26

27 plan.name = "Plan2"; plan. = "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"; SharePointSite site2 = new SharePointSite("Farm(SP2010_DB:SHAREPOINT_CONFIG)", " GranularBackup"); #endregion #region granularbackupplan.tree.includespobject(site2); granularbackupservice.updateplan(plan); 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); 27

28 } while (job.status == JobStatus.InProgress job.status == JobStatus.Pausing); docave.jobmonitorservice.downloadjobreport(jobid, false); #endregion } } } 28

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

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

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

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>] [<CommonParameters>] 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. true named false false 32

33 -ControlPort<Int32> Specifies the control port. true named false false -Credential<PSCredential> Specifies the credential. true named false false -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. true named false false -Password<SecureString> Specifies the password in the form of secure string. true named false false -PlainTextPassword<String> 33

34 Specifies the password in the form of plain text string. true named false false <CommonParameters> Examples PS C:\>$Credential = Get-Credential PS C:\>Login-DAManager -ControlHost localhost -ControlPort Credential $credential Logins manager according to the credential. Example 2 PS C:\>$SecurePassword = Read-Host -AsSecureString ***** PS C:\>Login-DAManager -ControlHost localhost -ControlPort Username admin -Password $SecurePassword Logs into manager according to the username and the secure string password. Example 3 PS C:\>Login-DAManager -ControlHost localhost -ControlPort Username admin -PlainTextPassWord admin Logs into manager according to the username and the plain text password. 34

35 Example 4 PS C:\>Login-DAManager -ControlHost localhost -ControlPort Username example.com\user1 -PlainTextPassword admin -ADGroupName example.com\group1 This command logs into Manager using the specified Active Directory user. Related Links Logout-DAManager Log Out of DocAve Manager Refer to the following sections for more information. Logout-DAManager Logs out the DocAve Manager. Syntax Logout-DAManager [<CommonParameters>] The Logout-DAManager cmdlet logs out the DocAve Manager. Parameters <CommonParameters> Examples PS C:\>Logout-DAManager This command logs out the DocAve Manager. Related Links Login-DAManager 35

36 Administrator Refer to the following sections for more information. Get-DASPBlankSecuritySearchSetting Gets a blank security search setting. Syntax Get-DASPBlankSecuritySearchSetting [<CommonParameters>] The Get-DASPBlankSecuritySearchSetting cmdlet gets a blank security search setting. Parameters <CommonParameters> Examples PS C:\>$setting = Get-DASPBlankSecuritySearchSetting PS C:\>$setting UserAndGroup : {} LimitedPermissions PermissionPolicy : AnyPermission : ExactPermission IncludeSharePointUsersAndGroupsWithNoPermissions : False OnlySearchForExplicitPermissions IncludeSharePointGroupMembers IncludeADGroupMembersOrFBARoleMembers : False : False : False SearchLevels : WebApplication, SiteCollection, Site, List, Folder, Item, Document 36

37 SearchFilterRules : DocAve.API.Administration.Administrator.Security.SecuritySearchFilterR ules 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>] 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. true 1 true (ByValue) false -PlanName<String> Specifies a plan name. 37

38 false named false false -FarmName<String> Specifies a farm name. true 0 true (ByValue, ByPropertyName) false <CommonParameters> Examples PS C:\>$setting = Get-DASPBlankSecuritySearchSetting 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 = ' Documents' PS C:\>$rule01.CombineMode = 'Or' PS C:\> PS C:\>$rule02 = New-Object DocAve.API.Administration.Administrator.Security.ListOrLibraryUrlFilte rrule 38

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)',' PS C:\>$webapplication2 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\> PS C:\>$setting.SearchLevels = 'List, Folder, Item' PS C:\> PS C:\>Search-DASPPermission -Scope $webapplication1,$webapplication2 -Setting $setting These commands show how to search permissions within a specified scope. Example 2 PS C:\>$setting = Get-DASPBlankSecuritySearchSetting 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' 39

40 PS C:\>Search-DASPPermission -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -Setting $setting -PlanName 'plan1' 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>] The Get-DocAveSPBlankCloneUserPermissionSetting cmdlet gets the settings list which allows you to configure the Clone User Permission settings. Parameters <CommonParameters> Examples PS C:\>Get-DASPBlankCloneUserPermissionSetting FilterPolicy : PermissionOption : Append AdditionalOption : AddTargetUsersToSourceUsersGroup RemoveSourceUsersExplicitPermissionsOrGroupPermissions : False 40

41 RemoveSourceUserFromSharePointGroups DeleteSourceUserOrGroupFromSiteCollection SendSourceUserAlertsToDestinationUsers : False : False : False MetadataToChange : { } IncludeDetailedReport : False 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>] 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. true 0 true (ByValue, ByPropertyName) false 41

42 -SourceUser<String> Specifies a username as the source account whose permissions will be cloned. true 1 true (ByValue, ByPropertyName) false -Destination<List`1[String]> Specifies the username(s) or group name(s) as the destination account(s) that you can clone permissions to. true 2 true (ByValue, ByPropertyName) false -Setting<CloneUserPermissionSetting> Configures the settings for cloning user permissions. true 3 true (ByValue, ByPropertyName) false -FarmName<String> Specifies the farm where you wish search for the source user. true 0 true (ByValue, ByPropertyName) false <CommonParameters> 42

43 Examples 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 PlanName Module Status : CA : CloneUserPermission_PLAN : Administrator : Finished StartTime : 7/10/ :59:04 AM FinishTime : 7/10/ :00:26 AM Progress : 100 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.PermissionOption = 'Append' PS C:\>$setting.AdditionalOption = 'AddTargetUsersToSourceUsersGroup' PS C:\>$setting.IncludeDetailedReport = $true PS C:\> PS C:\>$webapplication1= New-Object DocAve.API.Objects.SharePointWebApplication ('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 43

44 PS C:\>Clone-DASPUserPermission -Scope $webapplication1 -SourceUser 'user1' -Destination 'user2' -Setting $setting ID PlanName Module Status : CA : CloneUserPermission_PLAN : Administrator : Finished StartTime : 7/10/ :59:54 AM FinishTime : 7/10/ :01:26 AM Progress : 100 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>] The Get-DASPBlankCloneGroupPermissionSetting cmdlet gets the settings list which allows you to configure the Clone Group Permission settings. Parameters <CommonParameters> 44

45 Examples PS C:\>Get-DASPBlankCloneGroupPermissionSetting FilterPolicy : PermissionOption : Append RemoveSourceUsersExplicitPermissionsOrGroupPermissions : False DeleteSourceUserOrGroupFromSiteCollection SendSourceUserAlertsToDestinationUsers : False : False MetadataToChange : {} IncludeDetailedReport : False 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>] 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. 45

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. true 0 true (ByValue, ByPropertyName) false -SourceGroup<String> Specifies a group as the source whose permissions will be cloned. true 1 true (ByValue, ByPropertyName) false -Destination<List`1[String]> Specifies the username(s) or group name(s) as the destination that you can clone permissions to. true 2 true (ByValue, ByPropertyName) false -Setting<CloneGroupPermissionSetting> Configures the settings for cloning group permissions. true 3 true (ByValue, ByPropertyName) false 46

47 -FarmName<String> Specifies the farm where you wish search for the source group. true 0 true (ByValue, ByPropertyName) <CommonParameters> false Examples PS C:\>$setting = Get-DASPBlankCloneGroupPermissionSetting PS C:\>$setting.PermissionOption = 'Append' PS C:\>$setting.IncludeDetailedReport = $true PS C:\> PS C:\>$webapplication1= New-Object DocAve.API.Objects.SharePointWebApplication ('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' PS C:\>Clone-DASPGroupPermission -Scope $webapplication1 - SourceGroup 'group1' -Destination 'user1' -Setting $setting ID PlanName Module Status : CA : CloneUserPermission_PLAN : Administrator : Finished StartTime : 7/10/ :59:04 AM FinishTime : 7/10/ :00:26 AM Progress :

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:\>$setting.PermissionOption = 'Append' PS C:\>$setting.IncludeDetailedReport = $true PS C:\> PS C:\>Clone-DASPGroupPermission -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -SourceGroup 'group1' - Destination 'user1' -Setting $setting ID PlanName Module Status : CA : CloneUserPermission_PLAN : Administrator : Finished StartTime : 7/10/ :59:54 AM FinishTime : 7/10/ :01:26 AM Progress : 100 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 Stop-DASPInheritingPermissions Scan-DASPDeadAccount Scans the dead accounts. 48

49 Syntax Scan-DASPDeadAccount [-Scope] <SharePointObject[]> [<CommonParameters>] Scan-DASPDeadAccount [-FarmName] <String> [<CommonParameters>] 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. true 0 true (ByValue) false -FarmName<String> Specifies a farm name. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site1') PS C:\>$site2 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site2') PS C:\>$result = Scan-DASPDeadAccount -Scope $site1,$site2 49

50 PS C:\>$result fl UserName Type Site : dead account1 : Disabled : PermissionLevels : Contribute 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 UserName Type Site : dead account2 : Disabled : PermissionLevels : Contribute UserName Type Site : dead account1 : Disabled : PermissionLevels : Contribute This command scans the dead accounts in the specified farm. Related Links Remove-DASPDeadAccount Stop-DASPInheritingPermissions 50

51 Remove-DASPDeadAccount Removes the dead accounts. Syntax Remove-DASPDeadAccount [-DeadAccount] <DeadAccount[]> [-DeleteMySite] [-DeleteUserProfiles] [<CommonParameters>] The Remove-DASPDeadAccount cmdlet removes the dead accounts. Parameters -DeadAccount<DeadAccount[]> Specifies the dead accounts to remove. true 0 true (ByValue) false -DeleteMySite[<SwitchParameter>] Specifies whether to delete the My Site or not. false named false false -DeleteUserProfiles[<SwitchParameter>] Specifies whether to delete the user profiles or not. false named false false <CommonParameters> 51

52 Examples PS C:\>$result = Scan-DASPDeadAccount -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$result fl UserName Type Site : dead account1 : Disabled : PermissionLevels : Contribute UserName Type Site : dead account2 : Disabled : PermissionLevels : Contribute UserName Type Site : dead account3 : Disabled : PermissionLevels : Contribute PS C:\>$deadAccountForRemoving = $result[0],$result[2] PS C:\>Remove-DASPDeadAccount -DeadAccount $deadaccountforremoving - DeleteMySite -DeleteUserProfiles ID PlanName Module 52 : CA : DeadAccountCleaner_PLAN : Administrator

53 Status : Finished StartTime : 7/10/2012 1:35:24 PM FinishTime : 7/10/2012 1:35:43 PM Progress : 100 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> [<CommonParameters>] Check-DASPInheritingPermissions [-SharePointList] <SharePointList> [<CommonParameters>] Check-DASPInheritingPermissions [-SharePointFolder] <SharePointFolder> [<CommonParameters>] Check-DASPInheritingPermissions [-SharePointItem] <SharePointItem> [<CommonParameters>] 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. true 0 true (ByValue) false 53

54 -SharePointList<SharePointList> Specifies a SharePoint list object to check whether or not it is inheriting permissions from its parent. true 0 true (ByValue) false -SharePointFolder<SharePointFolder> Specifies a SharePoint folder object to check whether or not it is inheriting permissions from its parent. true 0 true (ByValue) false -SharePointItem<SharePointItem> Specifies a SharePoint item object to check whether or not it is inheriting permissions from its parent. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$web1 = New-Object DocAve.API.Objects.SharePointWeb ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' te1','/sites/site1/web1') PS C:\>Check-DASPInheritingPermissions -SharePointWeb $web1 True 54

55 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 ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site1','/sites/site1/web1','list1') PS C:\>Check-DASPInheritingPermissions -SharePointList $list1 True 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) ',' ','folder1') PS C:\>Check-DASPInheritingPermissions -SharePointFolder $folder1 True 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('ea8d9fe c eca0c117ccb4') PS C:\>$item1 = New-Object DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 'folder1',$itemguid) 55

56 PS C:\>Check-DASPInheritingPermissions -SharePointItem $item1 True These commands check whether or not the specified SharePoint item object is inheriting permissions from its parent. Related Links Stop-DASPInheritingPermissions Stop-DASPInheritingPermissions Stops the permission inheritance of the specified SharePoint object(s). Syntax Stop-DASPInheritingPermissions [-SharePointWeb] <SharePointWeb[]> [<CommonParameters>] Stop-DASPInheritingPermissions [-SharePointList] <SharePointList[]> [<CommonParameters>] Stop-DASPInheritingPermissions [-SharePointFolder] <SharePointFolder[]> [<CommonParameters>] Stop-DASPInheritingPermissions [-SharePointItem] <SharePointItem[]> [<CommonParameters>] 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. true 0 true (ByValue) false 56

57 -SharePointList<SharePointList[]> Specifies the SharePoint list object(s) to stop its permission inheritance. true 0 true (ByValue) false -SharePointFolder<SharePointFolder[]> Specifies the SharePoint folder object(s) to stop its permission inheritance. true 0 true (ByValue) false -SharePointItem<SharePointItem[]> Specifies the SharePoint item object(s) to stop its permission inheritance. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$web = New-Object DocAve.API.Objects.SharePointWeb ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site1','/sites/site1/web1') PS C:\>Stop-DASPInheritingPermissions -SharePointWeb $web These commands stop the permission inheritance of the specified SharePoint site object. 57

58 Example 2 PS C:\>$list = New-Object DocAve.API.Objects.SharePointList ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site1','/sites/site1/web1','list1') PS C:\>Stop-DASPInheritingPermissions -SharePointList $list 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) ',' ','folder1') PS C:\>Stop-DASPInheritingPermissions -SharePointFolder $folder1 These commands stop the permission inheritance of the specified SharePoint folder object. Example 4 PS C:\>$itemGuid = New-Object System.Guid('ea8d9fe c eca0c117ccb4') PS C:\>$item1 = New-Object DocAve.API.Objects.SharePointItem('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 'folder1',$itemguid) PS C:\>Stop-DASPInheritingPermissions -SharePointItem $item1 These commands stop the permission inheritance of the specified SharePoint item object. Related Links Scan-DASPDeadAccount Check-DASPInheritingPermissions 58

59 Content Manager Refer to the following sections for more information. Get-DAContentManagerOnlinePlan Gets the plan settings of the specified online content manager plan(s). Syntax Get-DAContentManagerOnlinePlan [[-Name] <String[]>] [<CommonParameters>] 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 PS C:\>Get-DAContentManagerOnlinePlan -Name plan1 Type Name : Copy : plan1 59

60 : this is a content manager plan. MethodSettings : DocAve.API.Administration.ContentManager.ContentManagerCopySettings Action PromoteMethod : Attach : PromoteTopLevelSiteToSiteCollection ManagedPathForDestination : FilterPolicy : filter policy 01 NotificationName AssociatedPlanGroup Configuration Security Content UserProfile IncludeWorkflowDefinition IncludeWorkflowInstance : Notification1 : {PlanGroup1} : ConfigurationOption6 : SecurityOption3 : ContentOption3 : False : True : False IncludeCompletedWorkflowInstance : False RunningWorkflowInstanceSetting MetadataServiceSetting PreserveNullColumnValues CollapseFolderStructure ColumnName DataCompression DataEncryption SecurityProfile : None : None : True : True : foldername : Level7 : True : Default Security Profile ColumnMapping : column mapping 01 ContentTypeMapping : TemplateMapping : 60

61 UserMapping : user mapping 01 DomainMapping : LanguageMapping : ConflictResolution AppsConflictResolution : ConflictResolutionOption7 : Skip SourceTree : DocAve.API.Administration.ContentManager.ContentManagerSourceTree DestinationTree : DocAve.API.Administration.ContentManager.ContentManagerDestinationTree SourceFarmName : DestinationFarmName Level ModifiedTime SourceSPSitesGroupName : Farm(SP2010_DB1:SHAREPOINT_CONFIG) : Lateral : 7/11/ :41:04 AM : Default_SharePoint Sites_ Group DestinationSPSitesGroupName : 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>] The Get-DAContentManagerBlankOnlinePlan cmdlet gets a blank online content manager plan without any plan settings for creating a new plan. 61

62 Parameters <CommonParameters> Examples PS C:\>Get-DAContentManagerBlankOnlinePlan Type : Copy Name : : MethodSettings : DocAve.API.Administration.ContentManager.ContentManagerCopySettings Action PromoteMethod ManagedPathForDestination : Attach : PromoteTopLevelSiteToSiteCollection : sites FilterPolicy : NotificationName : AssociatedPlanGroup : {} Configuration Security Content UserProfile IncludeWorkflowDefinition IncludeWorkflowInstance : ConfigurationOption1 : SecurityOption3 : ContentOption2 : False : False : False IncludeCompletedWorkflowInstance : False 62

63 RunningWorkflowInstanceSetting MetadataServiceSetting PreserveNullColumnValues CollapseFolderStructure : None : TermSets : True : False ColumnName : DataCompression DataEncryption : None : False SecurityProfile : ColumnMapping : ContentTypeMapping : TemplateMapping : UserMapping : DomainMapping : LanguageMapping : ConflictResolution AppsConflictResolution : ConflictResolutionOption2 : Skip SourceTree : DestinationTree : SourceFarmName : DestinationFarmName : Level : ModifiedTime : SourceSPSitesGroupName : DestinationSPSitesGroupName : This command gets a blank online content manager blank plan without any plan settings. 63

64 Related Links New-DAContentManagerOnlinePlan New-DAContentManagerOnlinePlan Creates a new online content manager plan. Syntax New-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan> [<CommonParameters>] 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 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, ' 64

65 PS C:\>$sitecollection02 = New-Object DocAve.API.Objects.SharePointOnlineSite($plan.DestinationSPSitesGroupN ame,' 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' 65

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 = ' :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 These commands create an online content manager plan by getting a blank plan. Related Links Get-DAContentManagerBlankOnlinePlan Update-DAContentManagerOnlinePlan Remove-DAContentManagerOnlinePlan Update-DAContentManagerOnlinePlan Updates an existing online content manager plan. 66

67 Syntax Update-DAContentManagerOnlinePlan [-Plan] <ContentManagerOnlinePlan> [<CommonParameters>] The Update-DAContentManagerOnlinePlan cmdlet updates an existing online content manager plan. Parameters -Plan<ContentManagerOnlinePlan> Specifies a content manager online plan object for updating. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAContentManagerOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>Update-DAContentManagerOnlinePlan -Plan $plan These commands update the plan settings of the specified online content manager plan. Related Links New-DAContentManagerOnlinePlan Get-DAContentManagerOnlinePlan Remove-DAContentManagerOnlinePlan Remove-DAContentManagerOnlinePlan Deletes the specified online content manager plan. 67

68 Syntax Remove-DAContentManagerOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] 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. true 0 true (ByValue, ByPropertyName) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DAContentManagerOnlinePlan -Name 'plan1' 68

69 This command deletes the specified online content manager plan. Related Links New-DAContentManagerOnlinePlan Update-DAContentManagerOnlinePlan Get-DAContentManagerOnlinePlan Run-DAContentManagerCopyJob Runs an existing content manager copy plan. Syntax Run-DAContentManagerCopyJob [-PlanName] <String> [-TestRun] [- WaitForJobComplete] [<CommonParameters>] 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. false named false false -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. 69

70 false named false false <CommonParameters> Examples PS C:\>Run-DAContentManagerCopyJob -PlanName 'plan1' -TestRun - WaitForJobComplete ID PlanName Module Status : CM : plan1 : ContentManager : Finished StartTime : 7/10/ :37:30 AM FinishTime : 7/10/ :39:24 AM Progress : 100 This command runs a content manager copy plan. Related Links Run-DAContentManagerMoveJob Run-DAContentManagerImportJob Run-DAContentManagerExportJob Run-DAContentManagerExportJob Runs an existing content manager export plan. 70

71 Syntax Run-DAContentManagerExportJob [-PlanName] <String> [- WaitForJobComplete] [<CommonParameters>] The Run-DAContentManagerExportJob cmdlet runs an existing content manager export plan. Parameters -PlanName<String> Specifies the name of an existing content manager export plan that you want to run. true 0 false false -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. false named false false <CommonParameters> Examples PS C:\>Run-DAContentManagerExportJob -PlanName 'plan1' - WaitForJobComplete ID PlanName Module Status : CM : plan1 : ContentManager : Finished 71

72 StartTime : 7/10/ :37:30 AM FinishTime : 7/10/ :39:24 AM Progress : 100 This command runs a content manager export plan. Related Links Run-DAContentManagerImportJob Run-DAContentManagerCopyJob Run-DAContentManagerMoveJob Run-DAContentManagerImportJob Runs an existing content manager import plan. Syntax Run-DAContentManagerImportJob [-PlanName] <String> [- WaitForJobComplete] [<CommonParameters>] The Run-DAContentManagerImportJob cmdlet runs an existing content manager import plan. Parameters -PlanName<String> Specifies the name of an existing content manager import plan that you want to run. true 0 false false -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. false named false false 72

73 <CommonParameters> Examples PS C:\>Run-DAContentManagerImportJob -PlanName 'plan1' - WaitForJobComplete ID PlanName Module Status : CM : plan1 : ContentManager : Finished StartTime : 7/10/ :37:30 AM FinishTime : 7/10/ :39:24 AM Progress : 100 This command runs a content manager import plan. Related Links Run-DAContentManagerExportJob Run-DAContentManagerCopyJob Run-DAContentManagerMoveJob Run-DAContentManagerMoveJob Runs a content manager move plan. Syntax Run-DAContentManagerMoveJob [-PlanName] <String> [-TestRun] [- WaitForJobComplete] [<CommonParameters>] 73

74 The Run-DAContentManagerMoveJob cmdlet runs a content manager move plan. Parameters -PlanName<String> Specifies the name of an existing content manager move plan that you want to run. true 0 false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false named false false -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. false named false false <CommonParameters> Examples PS C:\>Run-DAContentManagerMoveJob -PlanName 'plan1' -TestRun - WaitForJobComplete 74

75 ID PlanName Module Status : CM : plan1 : ContentManager : Finished StartTime : 7/10/ :37:30 AM FinishTime : 7/10/ :39:24 AM Progress : 100 This command runs a content manager move plan. Related Links Run-DAContentManagerCopyJob Run-DAContentManagerExportJob Run-DAContentManagerImportJob Get-DAContentManagerJobConfigurationDetail Gets the configuration details of a Content Manager job. Syntax Get-DAContentManagerJobConfigurationDetail [-ID] <String> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] 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. true 0 true (ByValue, ByPropertyName) false 75

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". false named false false -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". false named false false -Length<Int32> Specifies how many object's job details will be displayed. false named false false <CommonParameters> Examples PS C:\>Get-DAContentManagerJobConfigurationDetail -ID CM Key Value Date :16:40 (UTC+08:00) 76

77 Beij... Property Type Name Site Column Site Enterprise Keywords Related Object Title smoke 01 Source URL Target URL Status Successful Comment Date :16:40 (UTC+08:00) Beij... Property Type Name Site Column Site HashTags Related Object Title smoke 01 Source URL Target URL Status Successful Comment This command gets the configuration details of the specified Content Manager job. 77

78 Example 2 PS C:\>Get-DAContentManagerJobConfigurationDetail -ID cm JobReportDetailStatus Success -StartIndex 0 -Length 1 Key Value Date :16:40 (UTC+08:00) Beij... Property Type Name Site Column Site Enterprise Keywords Related Object Title smoke 01 Source URL Target URL Status Successful Comment 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. 78

79 Syntax Get-DAContentManagerJobSecurityDetail [-ID] <String> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] The Get-DAContentManagerJobSecurityDetail cmdlet gets the security details of a Content Manager job according to the specified Job ID. Parameters -ID<String> Specifies a Job ID. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> 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". false named false false -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". false named false false -Length<Int32> Specifies how many object's job details will be displayed. false named false false 79

80 <CommonParameters> Examples PS C:\>Get-DAContentManagerJobSecurityDetail -ID CM Key Value Date :16:40 (UTC+08:00) Beij... User/Group Type Name User Site NT AUTHORITY\LOCAL SERVICE Related Object Title smoke 01 Source URL Target URL Status of User/Groups Successful Comment Date :16:40 (UTC+08:00) Beij... 80

81 User/Group Type Name Group Site Excel Services Viewers Related Object Title smoke 01 Source URL Target URL Status of User/Groups Successful Comment This command gets the security details of the specified Content Manager job. Example 2 PS C:\>Get-DAContentManagerJobSecurityDetail -ID CM JobReportDetailStatus Success -StartIndex 0 -Length 1 Key Value Date :16:40 (UTC+08:00) Beij... User/Group Type Name User Site NT AUTHORITY\LOCAL SERVICE Related Object Title smoke 01 81

82 Source URL Target URL Status of User/Groups Successful Comment This command gets the first Successful security details object of the specified job. Related Links Get-DAContentManagerJobConfigurationDetail Deployment Manager Refer to the following sections for more information. Get-DADeploymentManagerPlan Gets the plan settings of the specified deployment manager plan(s). Syntax Get-DADeploymentManagerPlan [[-Name] <String[]>] [<CommonParameters>] The Get-DADeploymentManagerPlan cmdlet gets the plan settings of the specified deployment manager plan(s). Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) true <CommonParameters> 82

83 Examples PS C:\>$plan = Get-DADeploymentManagerPlan -Name plan01 PS C:\>$plan Format-List Name deployment manager plan. : plan01 : this is a StoragePolicyNameForBackingupDestinationEnvironment : storage policy01 NotificationName : 01 Mappings : {Farm(SP2010_DB1:SHAREPOINT_CONFIG)} Schedule : 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>] 83

84 The Get-DADeploymentManagerBlankPlan cmdlet gets a blank deployment manager plan without any plan settings for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DADeploymentManagerBlankPlan PS C:\>$plan Format-List Name : : StoragePolicyNameForBackingupDestinationEnvironment : NotificationName : Mappings : {} Schedule : 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> [<CommonParameters>] 84

85 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 PS C:\>$plan = Get-DADeploymentManagerBlankPlan PS C:\>$plan.Name = 'plan 01' PS C:\>$plan. = 'this is a deployment manager plan' PS C:\>$plan.StoragePolicyNameForBackingupDestinationEnvironment = 'storage policy 01' PS C:\>$plan.NotificationName = ' 01' PS C:\> PS C:\>$farmName = 'Farm(SP2010_DB1:SHAREPOINT_CONFIG)' PS C:\>$webapp = New-Object DocAve.API.Objects.SharePointWebApplication($farmName,' nt2010:10001/') PS C:\>$site = New-Object DocAve.API.Objects.SharePointSite($farmName,' 02') 85

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:\>$plan.AddMapping($mapping02) PS C:\> PS C:\>$mapping03 = $plan.getblanksolutionfromsolutionstoremapping() PS C:\>$solutionStoreName = 'storage policy 02' PS C:\>$mapping03.IncludeSolution($solutionStoreName,'farmsolution01.wsp' ) 86

87 PS C:\>$mapping03.IncludeSolution($solutionStoreName,'usersolution02.wsp' ) PS C:\>$mapping03.SelectDestinationFarm($farmName) PS C:\> PS C:\>$plan.AddMapping($mapping03) 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:\>$plan.AddMapping($mapping04) 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, " "", $guid) PS C:\>$sitecollection01 = New-Object docave.api.objects.sharepointsite($farm13name,' 0002') PS C:\>$sitecollection02 = New-Object docave.api.objects.sharepointsite($farm13name,' 0003') PS C:\> PS C:\>$mapping05 = $plan.getblankdesignelementonlinemapping() PS C:\>$mapping05.SourceTree.IncludeSPObject($app) 87

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:\>$plan.AddMapping($mapping05) PS C:\> PS C:\>$mapping06 = $plan.getblankdesignelementimportmapping() PS C:\>$mapping06.DestinationTree.SelectSPObject($sitecollection02) PS C:\>$mapping06.SelectExportJob("2013Location", "DM _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:\>$plan.AddMapping($mapping06) PS C:\> PS C:\>$plan.Schedule = New-Object DocAve.API.Administration.DeploymentManager.DeploymentManagerSchedule 88

89 PS C:\>$plan.Schedule.StartTime = ' :00' PS C:\>$plan.Schedule.TimeZoneId = 'Pacific Standard Time' PS C:\>$plan.Schedule.AutoAdjustForDST = $true PS C:\> PS C:\>New-DADeploymentManagerPlan -Plan $plan These commands create a deployment manager plan by getting a blank plan. Related Links Update-DADeploymentManagerPlan Get-DADeploymentManagerBlankPlan Remove-DADeploymentManagerPlan Update-DADeploymentManagerPlan Updates an existing deployment manager plan. Syntax Update-DADeploymentManagerPlan [-Plan] <DeploymentManagerPlan> [<CommonParameters>] 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> 89

90 Examples PS C:\>$plan = Get-DADeploymentManagerPlan -Name 'dpm plan' PS C:\>$plan.Name = 'dpm plan update' PS C:\>$plan. = '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 These commands update the plan settings of the specified deployment manager plan. Related Links New-DADeploymentManagerPlan Get-DADeploymentManagerPlan Update-DADeploymentManagerPlan Remove-DADeploymentManagerPlan Deletes the specified deployment manager plan. Syntax Remove-DADeploymentManagerPlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>] The Remove-DADeploymentManagerPlan cmdlet deletes the specified deployment manager plan. 90

91 Parameters -Name<String> Specifies the name of the deployment manager plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DADeploymentManagerPlan -Name 'plan1' This command deletes the specified deployment manager plan. Related Links New-DADeploymentManagerPlan Update-DADeploymentManagerPlan 91

92 Get-DADeploymentManagerPlan Run-DADeploymentManagerJob Runs a job based on a Deployment Manager plan. Syntax Run-DADeploymentManagerJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>] The Run-DADeploymentManagerJob cmdlet runs a Deployment Manager job based on the specified plan. Parameters -PlanName<String> Specifies the Deployment Manager plan name. true 0 false false -WaitForJobComplete[<SwitchParameter>] 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. false named false false <CommonParameters> Examples PS C:\>Run-DADeploymentManagerJob -PlanName 'plan1' - WaitForJobComplete 92

93 ID PlanName Module Status : DM : plan1 : DeploymentManager : Finished StartTime : 7/10/2012 2:10:30 PM FinishTime : 7/10/2012 2:12:12 PM Progress : 100 This command runs a Deployment Manager job based on the plan named plan1. Related Links Replicator Refer to the following sections for more information. Run-DAReplicatorOnlineJob Runs online Replicator job. Syntax Run-DAReplicatorOnlineJob [-PlanName] <String> -ReplicatorRunLevel <String> [-ReplicateModifications] [-ReplicateDeletions] [- SpecialReferenceTime <String>] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DAReplicatorOnlineJob cmdlet runs a online Replicator job based on the specified plan. Parameters -PlanName<String> Specifies the plan name, the job will run based on the plan. true 0 false false 93

94 -ReplicatorRunLevel<String> Specifies the job level. Valid values are "Full" and "Incremental". true named false false -ReplicateModifications[<SwitchParameter>] Specifies whether to replicate the modifications. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'. false named false false -ReplicateDeletions[<SwitchParameter>] Specifies whether to replicate the deletions. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'. false named false false -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'. false named false false -TestRun[<SwitchParameter>] Whether to run the test job. 94

95 false named false false -WaitForJobComplete[<SwitchParameter>] 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. false named false false <CommonParameters> Examples PS C:\>Run-DAReplicatorOnlineJob -PlanName 'plan1' -ReplicatorRunLevel Full -WaitForJobComplete -TestRun ID PlanName Module Status : RP : plan1 : Replicator : Finished StartTime : 11/18/2011 7:19:10 PM FinishTime : 11/18/2011 7:41:53 PM Progress : 100 This command runs a online Replicator job based on plan1 and the job is a full job. Example 2 95

96 PS C:\>Run-DAReplicatorOnlineJob -PlanName 'plan1' -ReplicatorRunLevel Incremental -ReplicateModifications -ReplicateDeletions -TestRun ID PlanName Module Status : RP : plan1 : Replicator : Finished StartTime : 11/18/2011 8:19:10 PM FinishTime : 11/18/2011 8:41:53 PM Progress : 100 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] [<CommonParameters>] The Run-DAReplicatorExportJob cmdlet runs a Replicator data export job based on the specified plan. Parameters -PlanName<String> Specifies the plan name, the job will run based on the plan. 96

97 true 0 false false -ReplicatorRunLevel<String> Specifies the job level. Valid values are "Full" and "Incremental". true named false false -ReplicateModifications[<SwitchParameter>] Specifies whether to replicate the modifications. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'. false named false false -ReplicateDeletions[<SwitchParameter>] Specifies whether to replicate the deletions. You cannot specify this parameter unless the value of parameter 'ReplicatorRunLevel' is 'Incremental'. false named false false -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'. false named false false -WaitForJobComplete[<SwitchParameter>] 97

98 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. false named false false <CommonParameters> Examples PS C:\>Run-DAReplicatorExportJob -PlanName 'plan1' -ReplicatorRunLevel Full -WaitForJobComplete ID PlanName Module Status : RP : plan1 : Replicator : Finished StartTime : 11/18/2011 7:27:20 PM FinishTime : 11/18/2011 7:37:39 PM Progress : 100 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 : RP

99 PlanName Module Status : plan1 : Replicator : Finished StartTime : 11/18/2011 8:27:20 PM FinishTime : 11/18/2011 8:37:39 PM Progress : 100 This command runs a Replicator export job based on plan1 and the job is an incremental job. Related Links Run-DAReplicatorOnlineJob Run-DAReplicatorImportJob Run-DAReplicatorImportJob Runs Replicator data import job. Syntax Run-DAReplicatorImportJob [-PlanName] <String> [-WaitForJobComplete] [<CommonParameters>] The Run-DAReplicatorImportJob cmdlet runs a Replicator data import job based on the specified plan. Parameters -PlanName<String> Specifies the plan name, the job will run based on the plan. true 0 false false -WaitForJobComplete[<SwitchParameter>] 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. 99

100 false named false false <CommonParameters> Examples PS C:\>Run-DAReplicatorImportJob -PlanName 'plan1' -WaitForJobComplete ID PlanName Module Status : RP : plan1 : Replicator : Finished StartTime : 11/18/2011 7:39:54 PM FinishTime : 11/18/2011 7:46:49 PM Progress : 100 This command runs a Replicator data import job based on plan1. Related Links Run-DAReplicatorExportJob Run-DAReplicatorOnlineJob BLOB Provider Refer to the following sections for more information. Get-DABLOBProviderBinariesInfo Gets the BLOB provider binaries information. 100

101 Syntax Get-DABLOBProviderBinariesInfo [[-FarmName] <String>] [<CommonParameters>] 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 PS C:\>Get-DABLOBProviderBinariesInfo -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' FarmName Server : Farm(SP2010_DB:SHAREPOINT_CONFIG) : Server1 Service : {Microsoft SharePoint Foundation Database, Managed Metadata Web Service, Business Data Connectivity Service, Search Administration Web Service...} AgentInstalled : True BLOBProviderBinariesInstalled : True 101

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>] 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. Parameters -FarmName<String> Specifies a farm name. true 0 true (ByValue, ByPropertyName) false <CommonParameters> Examples PS C:\>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$StubDBConfig.WebApplicationStubDBConfigurations FarmName 102 : Farm(SP2010_DB:SHAREPOINT_CONFIG)

103 WebApplicationUrl DatabaseServer : : Server\SharePoint DatabaseName : FailoverDatabaseServer : Authentication : Windows SQLAuthenticationAccount : FarmName WebApplicationUrl DatabaseServer : Farm(SP2010_DB:SHAREPOINT_CONFIG) : : Server\SharePoint DatabaseName : FailoverDatabaseServer : Authentication : Windows SQLAuthenticationAccount : 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> [<CommonParameters>] The Configure-DAStubDB cmdlet configures the stub database. 103

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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' 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) 104

105 PS C:\>$ContentDB2.FailoverDatabaseServer = 'FailoverDBServer' PS C:\>Configure-DAStubDB -Configuration $ContentDB2 These commands show how to configure stub database for a content database as Windows authentication or SQL authentication. Example 2 PS C:\>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration(' 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 These commands show how to configure stub database for a web application as SQL authentication. Example 3 PS C:\>$StubDBConfig = Get-DAStubDBConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration(' oint2010:10001/') PS C:\>$WebAppConfig.ConfigureByConnectionString('Data Source=myServerAddress;Failover Partner=myMirrorServerAddress;Initial Catalog=myDataBase;Integrated Security=true;') PS C:\>Configure-DAStubDB -Configuration $WebAppConfig 105

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> [<CommonParameters>] The Get-DABLOBProviderConfiguration cmdlet gets the BLOB provider configuration of a specified farm. Parameters -FarmName<String> Specifies a farm name. true 0 true (ByValue, ByPropertyName) false <CommonParameters> Examples PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$BLOB.WebApplicationLevelRBSConfigurations FarmName IncludeNewContentDBs WebApplicationUrl 106

107 Farm(SP2010_DB:SHAREPOI... False Farm(SP2010_DB:SHAREPOI... False Farm(SP2010_DB:SHAREPOI... False Farm(SP2010_DB:SHAREPOI... False PS C:\>$BLOB.ContentDBLevelRBSConfigurations FarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG) WebApplicationUrl : ContentDBID ContentDBName RBSEnabled : cee5aa66-2d6c c28-aadc14d06a4d : WSS_Content_10001 : False 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>] The Save-DABLOBProviderConfiguration cmdlet saves the BLOB provider configuration to Manager. 107

108 Parameters -Configuration<BLOBProviderConfiguration> Specifies the BLOB Provider configuration instance. true 0 true (ByValue) false -RunNow[<SwitchParameter>] Whether to run now after save the configuration. false named false false <CommonParameters> Examples PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' 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 FarmName 108 : Farm(SP2010_DB:SHAREPOINT_CONFIG)

109 WebApplicationUrl : ContentDBID ContentDBName RBSEnabled : 9c9ee869-a8c9-44b5-afb6-c1a632c602a1 : WSS_Content_10001 : True PS C:\>$ContentDB2 FarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG) WebApplicationUrl : ContentDBID ContentDBName RBSEnabled : 8c9be869-a839-4wb5-afb6-c1a732c602a5 : WSS_Content_10002 : True PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB These commands show how to configure RBS for two content databases and save the configuration. Example 2 PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$WebApp1 = $BLOB.GetWebApplicationLevelRBSConfiguration(' 001/') PS C:\>$WebApp1.IncludeNewContentDBs = $true PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>$StartTime = Get-DADateTime -Year Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID PS C:\>$BLOB.Schedule.Enable($StartTime, '34d') PS C:\>$BLOB.Schedule 109

110 Enabled StartTime Interval : True : 3/20/2012 2:30:00 PM (UTC-04:00) Santiago : 34D EndTime : NumberOfOccurrence : 0 PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB -RunNow These commands show how to configure "Include New Content Databases" for web application and run. Example 3 PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$BLOB.Schedule Enabled : False StartTime : Interval : EndTime : NumberOfOccurrence : 0 PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>$StartTime = Get-DADateTime -Year Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID PS C:\>$BLOB.Schedule.Enable($StartTime, '34d') PS C:\>$BLOB.Schedule 110

111 Enabled StartTime Interval : True : 3/20/2012 2:30:00 PM (UTC-04:00) Santiago : 34D EndTime : NumberOfOccurrence : 0 PS C:\> Save-DABLOBProviderConfiguration -Configuration $BLOB These commands show how to configure a no end schedule for BLOB Provider. Example 4 PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$BLOB.Schedule Enabled : False StartTime : Interval : EndTime : NumberOfOccurrence : 0 PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>$StartTime = Get-DADateTime -Year Month 03 -Day 20 -Hour 14 -M inute 30 -TimeZoneId $TimeZoneID PS C:\>$BLOB.Schedule.Enable($StartTime, '34d', 20) PS C:\>$BLOB.Schedule 111

112 Enabled StartTime Interval : True : 3/20/2012 2:30:00 PM (UTC-04:00) Santiago : 34D EndTime : NumberOfOccurrence : 20 PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB These commands show how to set an end for occurrence schedule of BLOB Provider. Example 5 PS C:\>$BLOB = Get-DABLOBProviderConfiguration -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$BLOB.Schedule Enabled : False StartTime : Interval : EndTime : NumberOfOccurrence : 0 PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>$StartTime = Get-DADateTime -Year Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID PS C:\>$EndTime = Get-DADateTime -Year Month 04 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID PS C:\>$BLOB.Schedule.Enable($StartTime,'34d',$EndTime) PS C:\>$blob.Schedule 112

113 Enabled StartTime Interval EndTime : True : 3/20/2012 2:30:00 PM (UTC-04:00) Santiago : 34D : 4/20/2012 2:30:00 PM (UTC-04:00) Santiago NumberOfOccurrence : 0 PS C:\>Save-DABLOBProviderConfiguration -Configuration $BLOB These commands show how to set an end for time schedule of BLOB Provider. Related Links Get-DABLOBProviderConfiguration Archiver Refer to the following sections for more information. Run-DAArchiverJob Runs Archiver job. Syntax Run-DAArchiverJob [-SPObject] <SharePointObject> [-WaitForJobComplete] [<CommonParameters>] 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. true 0 true (ByValue, ByPropertyName) false 113

114 -WaitForJobComplete[<SwitchParameter>] 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. false named false false <CommonParameters> Examples PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite ('Farm(SP2010_DB:SHAREPOINT_CONFIG)',' s/site1') PS C:\>Run-DAArchiverJob -SPObject $site1 ID : AR S PlanName : Module Status : Archiver : Waiting StartTime : 7/10/2012 1:54:06 PM FinishTime : Progress : 0 These commands show how to archive site1. 114

115 Related Links Run-DAArchiverIndexJob Runs an archiver index job according to the job ID. Syntax Run-DAArchiverIndexJob -JobId <String> [<CommonParameters>] 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. true named false false <CommonParameters> Examples PS C:\>Run-DAArchiverIndexJob -JobId AI 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. 115

116 Syntax Get-DAArchiverIndexDataInfo [-FarmName] <String> [-OutPut] <String> [- Overwrite] [<CommonParameters>] The Get-DAArchiverIndexDataInfo cmdlet gets the web application or the site collection whose archiver data has not been successfully indexed. Parameters -FarmName<String> 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. false named false false <CommonParameters> Examples PS C:\>Get-DAArchiverIndexDataInfo -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -OutPut C:\IndexInfo.xls 116

117 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> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] The Get-DAArchiverJobDetailForBackup cmdlet gets job details for backup of the specified Archiver job. Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> Specifies the detail status to filter the detail. Valid values are "Success", "Failed", "Skipped" and "Filtered". false named false false -StartIndex<Int32> Specifies the start number of the details that you want to get. false named false false 117

118 -Length<Int32> Specifies the total number of details in the result. false named false false <CommonParameters> Examples PS C:\>Get-DAArchiverJobDetailForBackup -ID AR A0 Key Value Type SiteCollection Source URL Media Agent Size Status Finish Time 08:00) Pacific Time (US & Canada) SP KB Successful :15:02 (UTC- Comment This command retrieves all backup details of the Archiver job. 118

119 Example 2 PS C:\>Get-DAArchiverJobDetailForBackup -ID AR A0 - JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1 Key Value Type SiteCollection Source URL Media Agent Size Status Finish Time 08:00) Pacific Time (US & Canada) SP KB Successful :15:02 (UTC- Comment 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> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] The Get-DAArchiverJobDetailForDeletion cmdlet gets details for deletion of the specified Archiver job. 119

120 Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> Specifies the detail status to filter the detail. Valid values are "Success", "Failed", "Skipped" and "Filtered". false named false false -StartIndex<Int32> Specifies the start number of the details that you want to get. false named false false -Length<Int32> Specifies the total number of details in the result. false named false false <CommonParameters> 120

121 Examples PS C:\>Get-DAArchiverJobDetailForDeletion -ID AR A0 Key Value Type Source URL Media Agent Size Status Finish Time 08:00) Pacific Time (US & Canada) Item Shared Documents\Case.xlsx 10MGRSHU 10SPSHU 25.00KB Successful :15:43 (UTC- Comment This command retrieves all deletion details of the Archiver job. Example 2 PS C:\>Get-DAArchiverJobDetailForDeletion -ID AR A0 -JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1 Key Value Type Source URL Media Agent Size Item Shared Documents\Case.xlsx 10MGRSHU 10SPSHU 25.00KB 121

122 Status Finish Time 08:00) Pacific Time (US & Canada) Successful :15:03 (UTC- Comment 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> [- Overwrite] [<CommonParameters>] 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> Specifies a path to store the output file. true 1 false false -Overwrite[<SwitchParameter>] 122 Overwrites the file if it already exists at the specified path.

123 false named false false <CommonParameters> Examples PS C:\>Set-DAArchiverIndexDataInfo -Path C:\IndexInfo.xls -OutPut C:\Result.xls This command shows how to set archiver data's index information in the loaded file. Related Links Get-DAArchiverIndexDataInfo Storage Manager Refer to the following sections for more information. Export-DABLOBTraceOfStub Exports the information of the item if the specified item is a stub. Syntax Export-DABLOBTraceOfStub -Configuration <ExportBlobInfoConfiguration> [<CommonParameters>] 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. 123

124 true named false false <CommonParameters> Examples PS C:\>$config=New-Object DocAve.Cmdlet.StorageOptimization.ExportBlobInfoConfiguration PS C:\>$config.FarmName='Farm(SP201X_DB:SHAREPOINT_CONFIG)' PS C:\>$config.URL.Add(' ') PS C:\>$result=Export-DABLOBTraceOfStub -Configuration $config PS C:\>$result.StubTraceInfomation ItemFullPath FileName : : b-b4bc-42cf-a476-cbb6a0c3d130 ItemSize : 2867 RBSId BlobId StubType : 0x : 0x444f4301xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx : Scheduled StubDBServer : StubDBName : StubDB StubInfoTable : StubInfo_83b53a95_f74c_4371_8bc4_91f071aad6ba StubId DeviceName 124 : b-b4bc-42cf-a476-cbb6a0c3d130 : DeviceName

125 FolderName : Data_Extender\Farm(SP201X_DB:SHAREPOINT_CONFIG)\webAppUrl\d8dcb342-50ef-4d9e-9 d9a-10ea929d4edb\7\8 BlobName ProviderType IsOrphanStub : b-b4bc-42cf-a476-cbb6a0c3d130 : RBS : False BSN : 671 LastAccessTime : The Export-DABLOBTraceOfStub cmdlet exports the information of the item if the specified item is a 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(' ') PS C:\>$result=Export-DABLOBTraceOfStub -Configuration $config PS C:\>$result.FailedType FarmNameNotExisting The Export-DABLOBTraceOfStub cmdlet exports the information of the item if the specified item is a stub. Related Links New-DARemapStorageManagerLogicalDeviceConfiguration Creates a Storage Manager logical device mapping configuration object. 125

126 Syntax New-DARemapStorageManagerLogicalDeviceConfiguration [<CommonParameters>] The New-DARemapStorageManagerLogicalDeviceConfiguration cmdlet creates a Storage Manager logical device mapping configuration object. Parameters <CommonParameters> Examples 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 126

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') 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>] 127

128 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. true named false false <CommonParameters> Examples PS C:\>$result =Remap-DAStorageManagerLogicalDevice -Configuration $config Finish PS C:\>$result.Succeeded PS C:\>$result.Failed 0 128

129 This command maps the source Storage Manager logical devices to the destination Storage Manager logical devices. Related Links New-DARemapStorageManagerLogicalDeviceConfiguration Real-Time Storage Manager Refer to the following sections for more information. 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>] [<CommonParameters>] Get-DARealtimeStorageManagerRule [-SPSite <SharePointSite>] [<CommonParameters>] 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. Parameters -Name<String> Specifies the name of the real-time storage manager rule whose configurations will be gotten. false named true (ByValue) false 129

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. false named true (ByValue) false -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. false named true (ByValue) false -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. false named true (ByValue) false <CommonParameters> Examples PS C:\>Get-DARealtimeStorageManagerRule Name : rule1 : 130

131 SizeThreshold LogicalDeviceName CompressionLevel DataEncryption : 2MB : logical device1 : Level1 : False SecurityProfileName : Name : rule2 : SizeThreshold LogicalDeviceName CompressionLevel DataEncryption : 512KB : logical device1 : None : True SecurityProfileName : security profile1 This command gets all the existing real-time storage manager rules. Example 2 PS C:\>Get-DARealtimeStorageManagerRule -Name 'rule2' Name : rule2 : SizeThreshold LogicalDeviceName CompressionLevel DataEncryption : 768KB : logical device1 : Level2 : True 131

132 SecurityProfileName : security profile1 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)',' 'wss_content_10001' PS C:\>Get-DARealtimeStorageManagerRule -SPContentDB $db Name : rule1 : SizeThreshold LogicalDeviceName CompressionLevel DataEncryption : 2MB : logical device1 : None : True SecurityProfileName : security profile1 Name : rule2 : SizeThreshold LogicalDeviceName CompressionLevel DataEncryption : 768KB : logical device1 : Level2 : False SecurityProfileName : 132

133 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>] The Get-DARealtimeStorageManagerBlankRule cmdlet gets a blank real-time storage manager rule without any configurations. Parameters <CommonParameters> Examples PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule PS C:\>$rule Name : : SizeThreshold : LogicalDeviceName : CompressionLevel : None 133

134 DataEncryption : False SecurityProfileName : This command gets a blank real-time storage manager rule where it allows you to configure a new realtime storage manager rule. Related Links New-DARealtimeStorageManagerRule Creates a new real-time storage manager rule. Syntax New-DARealtimeStorageManagerRule [-Rule] <RealtimeStorageManagerRule> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule PS C:\>$rule.Name = 'rule1' 134

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 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>] The Update-DARealtimeStorageManagerRule cmdlets updates the configurations of an existing realtime storage manager rule. Parameters -Rule<RealtimeStorageManagerRule> Specifies a real-time storage manager rule object whose configurations will be updated. true 0 true (ByValue) false <CommonParameters> Examples 135

136 PS C:\>$rule = Get-DARealtimeStorageManagerRule -Name 'rule1' PS C:\>$rule.Name = 'rule2' PS C:\>$rule.CompressionLevel = 'level7' PS C:\>Update-DARealtimeStorageManagerRule -Rule $rule 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> [<CommonParameters>] The Remove-DARealtimeStorageManagerRule cmdlet deletes an existing real-time storage manager rule according to the rule's name. Parameters -Name<String> Specifies the name of a real-time storage manager rule that you want to delete. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>Remove-DARealtimeStorageManagerRule -Name 'rule1' 136

137 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>] 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 -SPContentDB<SharePointContentDB> Specifies a SharePoint content database where the specified real-time storage manager rule will be applied. false named true (ByValue) false 137

138 -SPWebApplication<SharePointWebApplication> Specifies a SharePoint web application where the specified real-time storage manager rule will be applied. false named true (ByValue) false -SPSite<SharePointSite> Specifies a SharePoint site collection where the specified real-time storage manager rule will be applied. false named true (ByValue) false <CommonParameters> Examples PS C:\>$db = New-Object DocAve.API.Objects.SharePointContentDB 'Farm(SP2010_DB:SHAREPOINT_CONFIG)',' 'wss_content_10001' PS C:\>Reuse-DARealtimeStorageManagerRule -RuleName 'rule1' - SPContentDB $db 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. 138

139 Syntax Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPContentDB <SharePointContentDB>] [<CommonParameters>] Retract-DARealtimeStorageManagerRule -RuleName <String> [- SPWebApplication <SharePointWebApplication>] [<CommonParameters>] Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPSite <SharePointSite>] [<CommonParameters>] 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 -SPContentDB<SharePointContentDB> Specifies a SharePoint content database where the specified real-time storage manager rule will be retracted. false named true (ByValue) false -SPWebApplication<SharePointWebApplication> Specifies a SharePoint web application where the specified real-time storage manager rule will be retracted. false named true (ByValue) false 139

140 -SPSite<SharePointSite> Specifies a SharePoint site collection where the specified real-time storage manager rule will be retracted. false named true (ByValue) false <CommonParameters> Examples PS C:\>$db = New-Object DocAve.API.Objects.SharePointContentDB 'Farm(SP2010_DB:SHAREPOINT_CONFIG)',' 'wss_content_10001' PS C:\>Retract-DARealtimeStorageManagerRule -RuleName 'rule1' - SPContentDB $db 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 Refer to the following sections for more information. Get-DASPMigrationJobObjectsDetail Gets the detailed information of the objects in a SharePoint online migration job. Syntax Get-DASPMigrationJobObjectsDetail [-ID] <String> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] 140

141 The Get-DASPMigrationJobObjectsDetail cmdlet gets the detailed information of the objects in a SharePoint online migration job. Parameters -ID<String> Specifies a job ID to get the detailed object information. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> Specifies a status filter to only display the object details of the specified status. The valid values are "Success", "Failed", "Skipped" and "Filtered". false named false false -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. false named false false -Length<Int32> Specifies the number of object details to be displayed. false named false false 141

142 <CommonParameters> Examples PS C:\>Get-DASPMigrationJobObjectsDetail -ID MD Key Value Date Type Source URL Target URL Source Agent Target Agent Size Status Operation Web Application server1 server2 100Bytes Successful Skipped Comment Truncated Policy Target Owner Custom Metadata This command gets all the objects' detailed information of the specified Job. Example 2 PS C:\>Get-DASPMigrationJobObjectsDetail -ID MD JobReportDetailStatus Success -StartIndex 0 -Length 1 142

143 Key Value Date Type Source URL Target URL Source Agent Target Agent Size Status Operation Web Application server1 server2 100Bytes Successful Skipped Comment Truncated Policy Target Owner Custom Metadata 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> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] 143

144 The Get-DASPMigrationJobConfigurationDetail cmdlet gets the detailed configuration information of a SharePoint online migration job according to the specified Job ID. Parameters -ID<String> Specifies a Job ID to get the detailed job configurations. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> Specifies a status filter to only display the configuration details of the specified status. The valid values are "Success", "Failed", "Skipped" and "Filtered". false named false false -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 detailed information ranked with this number. false named false false -Length<Int32> Specifies the number of the configuration details to be displayed. false named false false 144

145 <CommonParameters> Examples PS C:\>Get-DASPMigrationJobConfigurationDetail -ID MD Key Value Date Property Type Name Related Object Title List Column List Content Type ID Form Templates Source URL Target URL Status Successful Comment This command gets the detailed job configurations of the specified SharePoint online migration job. Example 2 PS C:\>Get-DASPMigrationJobConfigurationDetail -ID MD JobReportDetailStatus Success -StartIndex 0 - Length 1 Key Value 145

146 Date Property Type Name Related Object Title List Column List Content Type ID Form Templates Source URL Target URL Status Successful Comment 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> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] TheGet-DASPMigrationJobPermissionDetail cmdlet gets the permission configurations of a SharePoint online migration job according to the specified Job ID. 146

147 Parameters -ID<String> Specifies a Job ID to get the detailed permission configurations. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> Specifies a status filter to only display the permission details of the specified status. The valid values are "Success", "Failed", "Skipped" and "Filtered". false named false false -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 detailed information ranked with this number. false named false false -Length<Int32> Specifies the number of the permission details to be displayed. false named false false <CommonParameters> 147

148 Examples PS C:\>Get-DASPMigrationJobPermissionDetail -ID MD Key Value Date User\Group Type Name Related Object Title User List example.com\user1 Form Templates Source URL Target URL Status of User\Groups Skipped Comment This command gets all the objects' security configuration information of the specified job. Example 2 PS C:\>Get-DASPMigrationJobPermissionDetail -ID MD JobReportDetailStatus Success -StartIndex 0 - Length 1 Key Value Date User\Group Type 148 User List

149 Name Related Object Title example.com\user1 Form Templates Source URL Target URL Status of User\Groups Skipped Comment This command only gets the permission details of the first successfully migrated object in the specified job. Related Links Get-DASPMigrationJobConfigurationDetail Get-DASPMigrationJobObjectsDetail SharePoint 2007 to 2010 Migration Refer to the following sections for more information. Get-DASP07To10MigrationOnlinePlan Gets the plan settings of the specified SharePoint 2007 to 2010 online migration plan(s). Syntax Get-DASP07To10MigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DASP07To10MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint 2007 to 2010 online migration plan(s). Parameters -Name<String[]> 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. 149

150 false 0 true (ByValue, ByPropertyName) true <CommonParameters> Examples 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 150

151 DestinationTree : DocAve.API.Migrat ion.sp07to10migra tion.sp07to10migr ationdestinationt ree Action MigrationDatabaseName : Merge : MigrationDB UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : plan1 : ProfileName NotificationName AssociatedPlanGroup : Default Profile : Notification1 : {PlanGroup1} 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>] The Get-DASP07To10MigrationBlankOnlinePlan cmdlet gets a blank SharePoint 2007 to 2010 online migration plan for creating a new plan. 151

152 Parameters <CommonParameters> Examples PS C:\>$plan = Get-DASP07To10MigrationBlankOnlinePlan PS C:\>$plan SourceFarmName : DestinationFarmName : SourceAgentGroupName : DestinationAgentGroupName : SourceTree : DocAve.API.Migrat ion.sp07to10migra tion.sp07to10migr ationsourcetree DestinationTree : DocAve.API.Migrat ion.sp07to10migra tion.sp07to10migr ationdestinationt ree Action : Merge MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : 152

153 : ProfileName : NotificationName : NotificationName : AssociatedPlanGroup : {} This command gets a blank SharePoint 2007 to 2010 online migration plan that has no plan settings configured. Related Links New-DASP07To10MigrationOnlinePlan New-DASP07To10MigrationOnlinePlan Creates a new SharePoint 2007 to 2010 online migration plan. Syntax New-DASP07To10MigrationOnlinePlan [-Plan] <SP07To10MigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> 153

154 Examples PS C:\>$plan = Get-DASP07To10MigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' 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:\>$plan.NotificationName = 'Notification1' PS C:\>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false) PS C:\>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.DestinationTree.SelectSPObject($list10) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') 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 = " :00" PS C:\>$scheduleForFullJob.TimeZoneId = "Pacific Standard Time" PS C:\>$scheduleForFullJob.Interval = "2Day" 154

155 PS C:\>$scheduleForFullJob.NumberOfOccurrence = 1 PS C:\>$plan.Schedules.Add($scheduleForFullJob) PS C:\>$scheduleForIncrementalJob = New-Object DocAve.API.Migration.SP07To10Migration.SP07To10MigrationSchedule PS C:\>$scheduleForIncrementalJob.JobOption = "Incremental" PS C:\>$scheduleForIncrementalJob.ConflictResolution = "Skip" PS C:\>$scheduleForIncrementalJob.StartTime = " :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 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 Update-DASP07To10MigrationOnlinePlan Updates an existing SharePoint 2007 to 2010 online migration plan. Syntax Update-DASP07To10MigrationOnlinePlan [-Plan] <SP07To10MigrationOnlinePlan> [<CommonParameters>] The Update-DASP07To10MigrationOnlinePlan cmdlet updates an existing SharePoint 2007 to 2010 online migration plan. 155

156 Parameters -Plan<SP07To10MigrationOnlinePlan> Specifies a plan name to get an existing SharePoint 2007 to 2010 online migration plan for editing. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DASP07To10MigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = 'New ' PS C:\>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.SourceAgentGroup = 'AgentGroup07' PS C:\>$plan.DestinationAgentGroup = 'AgentGroup10' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2007:10001/sites/site1','/sites/site1', 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false) PS C:\>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2010:10001/sites/site1','/sites/site1', 'list1') 156

157 PS C:\>$plan.DestinationTree.SelectSPObject($list10) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>Update-DASP07To10MigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified SharePoint 2007 to 2010 online migration plan. Related Links Get-DASP07To10MigrationOnlinePlan New-DASP07to10MigrationOnlinePlan Remove-DASP07To10MigrationOnlinePlan Remove-DASP07To10MigrationOnlinePlan Deletes the specified SharePoint 2007 to 2010 online migration plan. Syntax Remove-DASP07To10MigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DASP07To10MigrationOnlinePlan cmdlet deletes the specified SharePoint 2007 to 2010 online migration plan. Parameters -Name<String> Specifies the name of a SharePoint 2007 to 2010 online migration plan that you want to delete. true 0 true (ByValue) false 157

158 -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DASP07To10MigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DASP07To10MigrationOnlinePlan Update-DASP07To10MigrationOnlinePlan New-SP07To10MigrationOnlinePlan Run-DASP07To10MigrationOnlineJob Runs a SharePoint 2007 to 2010 online migration plan. Syntax Run-DASP07To10MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution 158

159 <SP07To10MigrationConflictResolution> -JobReportType <String> [- <String>] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DASP07To10MigrationOnlineJob cmdlet runs a SharePoint 2007 to 2010 online migration plan. Parameters -PlanName<String> Specifies the name of an existing SharePoint 2007 to 2013 online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. The valid values are "Full" and "Incremental". true named false false -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 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'. false named false false -ConflictResolution<SP07To10MigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". 159

160 true named false false -JobReportType<String> Specifies the job report level. The valid values are "Simplified" and "Detailed". true named false false -<String> Specifies the description of the SharePoint 2007 to 2010 online migration plan that you want to run. false named false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> 160

161 Examples PS C:\>Run-DASP07To10MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed - description -WaitForJobComplete ID PlanName Module Status : MD : plan1 : SharePointMigration : Finished StartTime : 7/10/2012 2:49:29 PM FinishTime : 7/10/2012 3:19:44 PM Progress : 100 This command runs the specified SharePoint 2007 to 2010 online migration plan in full. Example 2 PS C:\>Run-DASP07To10MigrationOnlineJob -PlanName 'plan2' -Options Incremental -IncrementalType 123hour -ConflictResolution Skip - JobReportType Detailed - description -WaitForJobComplete - TestRun ID PlanName Module Status : MD : plan2 : SharePointMigration : Finished StartTime : 7/10/2012 2:54:29 PM FinishTime : 7/10/2012 3:29:44 PM Progress :

162 This command simulates an incremental migration job of the specified SharePoint 2007 to 2010 online migration plan. Related Links Get-DASP07To10MigrationOnlinePlan Get-DASP07To10MigrationJobConfigurationDetail Gets the detailed information of a specified SharePoint 2007 to 2010 migration job. Syntax Get-DASP07To10MigrationJobConfigurationDetail [-ID] <String> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] The Get-DASP07To10MigrationJobConfigurationDetail cmdlet gets the detailed information of a SharePoint 2007 to 2010 migration job according to the specified Job ID. Parameters -ID<String> Specifies a Job ID to get the detailed job information. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> 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". false named false false 162

163 -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". false named false false -Length<Int32> Specifies how many object's job details will be displayed. false named false false <CommonParameters> Examples PS C:\>Get-DASP07To10MigrationJobConfigurationDetail -ID MD Key Value Date Property Type Name Related Object Title List Column List Content Type ID Form Templates Source URL 163

164 Target URL Status Successful Comment This command gets the detailed job configurations of the specified SharePoint 2007 to 2010 online migration plan. Example 2 PS C:\>Get-DASP07To10MigrationJobConfigurationDetail -ID MD JobReportDetailStatus Success -StartIndex 0 - Length 1 Key Value Date Property Type Name Related Object Title List Column List Content Type ID Form Templates Source URL Target URL Status Successful Comment This command gets the first successfully migrated configuration's detailed information of the specified job. Related Links Get-DASP07To10MigrationJobObjectsDetail 164

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> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] The Get-DASP07To10MigrationJobObjectsDetail cmdlet gets the detailed information of the objects in a SharePoint 2007 to 2010 online migration job. Parameters -ID<String> Specifies a job ID to get the object information. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> 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". false named false false -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". false named false false 165

166 -Length<Int32> Specifies how many object's security configuration will be displayed. false named false false <CommonParameters> Examples PS C:\>Get-DASP07To10MigrationJobObjectsDetail -ID MD Key Value Date Type Source URL Target URL Source Agent Target Agent Size Status Operation Web Application server1 server2 100Bytes Successful Skipped Comment Truncated Policy Target Owner 166

167 Custom Metadata This command gets all the objects' detailed information of the specified Job. Example 2 PS C:\>Get-DASP07To10MigrationJobObjectsDetail -ID MD JobReportDetailStatus Success -StartIndex 0 - Length 1 Key Value Date Type Source URL Target URL Source Agent Target Agent Size Status Operation Web Application server1 server2 100Bytes Successful Skipped Comment Truncated Policy Target Owner Custom Metadata This command gets the first successfully migrated object's detailed information of the specified job. Related Links Get-DASP07to10MigrationJobConfigurationDetail Get-SASP07To10MigrationJobPermissionDetail 167

168 Get-DASP07To10MigrationJobPermissionDetail Gets the permission configuration of a specified SharePoint 2007 to 2010 migration job. Syntax Get-DASP07To10MigrationJobPermissionDetail [-ID] <String> [- JobReportDetailStatus <JobReportDetailStatus[]>] [-StartIndex <Int32>] [-Length <Int32>] [<CommonParameters>] TheGet-DASP07To10MigrationJobPermissionDetail cmdlet gets the permission configuration of a SharePoint 2007 to 2010 migration job by specified Job ID. Parameters -ID<String> Specifies a Job ID to get the detailed security configuration information of the objects. true 0 true (ByValue, ByPropertyName) false -JobReportDetailStatus<JobReportDetailStatus[]> 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". false named false false -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". false named false false 168

169 -Length<Int32> Specifies how many object's security configuration will be displayed. false named false false <CommonParameters> Examples PS C:\>Get-DASP07To10MigrationJobPermissionDetail -ID MD Key Value Date User\Group Type Name Related Object Title User List example.com\user1 Form Templates Source URL Target URL Status of User\Groups Skipped Comment This command gets all the objects' security configuration information of the specified job. 169

170 Example 2 PS C:\>Get-DASP07To10MigrationJobPermissionDetail -ID MD JobReportDetailStatus Success -StartIndex 0 - Length 1 Key Value Date User\Group Type Name Related Object Title User List example.com\user1 Form Templates Source URL Target URL Status of User\Groups Skipped Comment 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>] 170

171 The Download-DASP07To10MigrationOnlineProfile cmdlet downloads the SharePoint 2007 to 2010 online migration profile to an XML file. Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DASP07To10MigrationOnlineProfile -Name 'SP07To10MigrationOnlineProfile1' -Path 'C:\SP07To10MigrationOnlineProfile1.xml' -Overwrite This command downloads the SharePoint 2007 to 2010 online migration profile to an XML file. Related Links Upload-DASP07To10MigrationOnlineProfile 171

172 Upload-DASP07To10MigrationOnlineProfile Uploads the SharePoint 2007 to 2010 online migration profile. Syntax Upload-DASP07To10MigrationOnlineProfile [-Path] <String> [-Overwrite] [<CommonParameters>] The Upload-DASP07To10MigrationOnlineProfile cmdlet uploads the SharePoint 2007 to 2010 online migration profile from an XML file. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DASP07To10MigrationOnlineProfile -Path 'C:\SP07To10MigrationOnlineProfile1.xml' -Overwrite This command uploads the SharePoint 2007 to 2010 online migration profile to manager. Related Links Download-DASP07To10MigrationOnlineProfile 172

173 SharePoint 2007 to 2013 Migration Refer to the following sections for more information. Get-DASP07To13MigrationOnlinePlan Gets the plan settings of the specified SharePoint 2007 to 2013 online migration plan(s). Syntax Get-DASP07To13MigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DASP07To13MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint 2007 to 2013 online migration plan(s). Parameters -Name<String[]> Specifies the name(s) of the existing SharePoint 2007 to 2013 online migration plan(s) you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing SharePoint 2007 to 2013 online migration plan(s) will be obtained. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DASP07To13MigrationOnlinePlan -Name 'plan1' SourceFarmName : Farm(SP2007_DB:SH AREPOINT_CONFIG) DestinationFarmName : Farm(SP2013_DB:SH 173

174 AREPOINT_CONFIG) DestinationSPSitesGroupName : SourceAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP200 7_DB:SHAREPOINT_C ONFIG) DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 3_DB:SHAREPOINT_C ONFIG) SourceTree : DocAve.API.Migrat ion.sp07to13migra tion.sp07to13migr ationsourcetree DestinationTree : DocAve.API.Migrat ion.sp07to13migra tion.sp07to13migr ationdestinationt ree Action MigrationDatabaseName : Merge : MigrationDB UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : plan1 : ProfileName NotificationName 174 : Default Profile : Notification1

175 AssociatedPlanGroup : {PlanGroup1} This command gets the plan settings of the specified plan. Related Links New-DASP07To13MigrationOnlinePlan Update-DASP07To13MigrationOnlinePlan Remove-DASP07To13MigrationOnlinePlan Get-DASP07To13MigrationBlankOnlinePlan Gets a blank SharePoint 2007 to 2013 online migration plan without any plan settings. Syntax Get-DASP07To13MigrationBlankOnlinePlan [<CommonParameters>] The Get-DASP07To13MigrationBlankOnlinePlan cmdlet gets a blank SharePoint 2007 to 2013 online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DASP07To13MigrationBlankOnlinePlan PS C:\>$plan SourceFarmName : DestinationFarmName : DestinationSPSitesGroupName : SourceAgentGroupName : 175

176 DestinationAgentGroupName : SourceTree : DocAve.API.Migrat ion.sp07to13migra tion.sp07to13migr ationsourcetree DestinationTree : DocAve.API.Migrat ion.sp07to13migra tion.sp07to13migr ationdestinationt ree Action : Merge MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : : ProfileName : Notification : AssociatedPlanGroup : {} This command gets a blank SharePoint 2007 to 2013 online migration plan that has no plan settings configured. Related Links New-DASP07To13MigrationOnlinePlan New-DASP07To13MigrationOnlinePlan Creates a new SharePoint 2007 to 2013 online migration plan. 176

177 Syntax New-DASP07To13MigrationOnlinePlan [-Plan] <SP07To13MigrationOnlinePlan> [<CommonParameters>] The New-DASP07To13MigrationOnlinePlan cmdlet creates a new SharePoint 2007 to 2013 online migration plan. Parameters -Plan<SP07To13MigrationOnlinePlan> Specifies a SharePoint 2007 to 2013 Migration online plan object. About the structure and attribute of SP07To13MigrationOnlinePlan, please refer to the SDK documentation for more information. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DASP07To13MigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationFarmName = 'Farm(SP2013_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.SourceAgentGroupName = 'AgentGroup07' PS C:\>$plan.DestinationAgentGroupName = 'AgentGroup13' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', ' 'list1') 177

178 PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false) PS C:\>$list13 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2013_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.DestinationTree.SelectSPObject($list13) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$scheduleForFullJob = New-Object DocAve.API.Migration.SP07To13Migration.SP07To13MigrationSchedule PS C:\>$scheduleForFullJob.JobOption = "Full" PS C:\>$scheduleForFullJob.ConflictResolution = "MergeAndOverwrite" PS C:\>$scheduleForFullJob.StartTime = " :00" PS C:\>$scheduleForFullJob.TimeZoneId = "Pacific Standard Time" PS C:\>$scheduleForFullJob.Interval = "2Day" PS C:\>$scheduleForFullJob.NumberOfOccurrence = 1 PS C:\>$plan.Schedules.Add($scheduleForFullJob) PS C:\>$scheduleForIncrementalJob = New-Object DocAve.API.Migration.SP07To13Migration.SP07To13MigrationSchedule PS C:\>$scheduleForIncrementalJob.JobOption = "Incremental" PS C:\>$scheduleForIncrementalJob.ConflictResolution = "Skip" PS C:\>$scheduleForIncrementalJob.StartTime = " :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-DASP07To13MigrationOnlinePlan -Plan $plan 178

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 = Get-DASP07To13MigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationSPSitesGroupName = 'Default_SharePoint Sites_Group' PS C:\>$plan.SourceAgentGroupName = 'AgentGroup07' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false) PS C:\>$listOnline = New-Object DocAve.API.Objects.SharePointOnlineList('Default_SharePoint Sites_Group', ' 'list1') PS C:\>$plan.DestinationTree.SelectSPOnlineObject($listOnline) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>New-DASP07To13MigrationOnlinePlan -Plan $plan These commands show how to create a SharePoint 2007 to SharePoint Online 2013 online migration plan. The destination is from My Registered Sites. Related Links Get-DASP07To13MigrationBlankOnlinePlan 179

180 Update-DASP07To13MigartionOnlinePlan Remove-DASP07To13MigartionOnlinePlan Get-DASP07To13MigartionOnlinePlan Update-DASP07To13MigrationOnlinePlan Updates an existing SharePoint 2007 to 2013 online migration plan. Syntax Update-DASP07To13MigrationOnlinePlan [-Plan] <SP07To13MigrationOnlinePlan> [<CommonParameters>] The Update-DASP07To13MigrationOnlinePlan cmdlet updates an existing SharePoint 2007 to 2013 online migration plan. Parameters -Plan<SP07To13MigrationOnlinePlan> Specifies a plan name to get an existing SharePoint 2007 to 2013 online migration plan for editing. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DASP07To13MigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = 'New ' PS C:\>$plan.SourceFarmName = 'Farm(SP2007_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationFarmName = 'Farm(SP2013_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.SourceAgentGroup = 'AgentGroup07' 180

181 PS C:\>$plan.DestinationAgentGroup = 'AgentGroup13' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$list07 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2007_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2007:10001/sites/site1','/sites/site1', 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list07, $true, $false) PS C:\>$list13 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2013_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2013:10001/sites/site1','/sites/site1', 'list1') PS C:\>$plan.DestinationTree.SelectSPObject($list13) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>Update-DASP07To13MigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified SharePoint 2007 to 2013 online migration plan. Related Links Get-DASP07To13MigrationOnlinePlan New-DASP07To13MigrationOnlinePlan Remove-DASP07To13MigrationOnlinePlan Remove-DASP07To13MigrationOnlinePlan Deletes the specified SharePoint 2007 to 2013 online migration plan. Syntax Remove-DASP07To13MigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] 181

182 The Remove-DASP07To13MigrationOnlinePlan cmdlet deletes the specified SharePoint 2007 to 2013 online migration plan. Parameters -Name<String> Specifies the name of a SharePoint 2007 to 2013 online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DASP07To13MigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DASP07To13MigrationOnlinePlan Update-DASP07To13MigrationOnlinePlan 182

183 New-SP07To13MigrationOnlinePlan Run-DASP07To13MigrationOnlineJob Runs a SharePoint 2007 to 2013 online migration plan. Syntax Run-DASP07To13MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution <SP07To13MigrationConflictResolution> -JobReportType <String> [- TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DASP07To13MigrationOnlineJob cmdlet runs a SharePoint 2007 to 2013 online migration plan. Parameters -PlanName<String> Specifies the name of an existing SharePoint 2007 to 2013 online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. The valid values are "Full" and "Incremental". true named false false -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 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'. false named false false -ConflictResolution<SP07To13MigrationConflictResolution> 183

184 Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". true named false false -JobReportType<String> Specifies the job report level. The valid values are "Simplified" and "Detailed". true named false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DASP07To13MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed - WaitForJobComplete ID PlanName : MD : plan1 184

185 Module Status : SharePointMigration : Finished StartTime : 7/10/2012 2:49:29 PM FinishTime : 7/10/2012 3:19:44 PM Progress : 100 This command runs the specified SharePoint 2007 to 2013 online migration plan in full. Example 2 PS C:\>Run-DASP07To13MigrationOnlineJob -PlanName 'plan2' -Options Incremental -IncrementalType 123hour -ConflictResolution Skip - JobReportType Detailed -WaitForJobComplete -TestRun ID PlanName Module Status : MD : plan2 : SharePointMigration : Finished StartTime : 7/10/2012 2:54:29 PM FinishTime : 7/10/2012 3:29:44 PM Progress : 100 This command simulates an incremental migration job of the specified SharePoint 2007 to 2013 online migration plan. Related Links Get-DASP07To13MigrationOnlinePlan Download-DASP07To13MigrationOnlineProfile Downloads the SharePoint 2007 to 2013 online migration profile. 185

186 Syntax Download-DASP07To13MigrationOnlineProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DASP07To13MigrationOnlineProfile cmdlet downloads the SharePoint 2007 to 2013 online migration profile to an XML file. Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DASP07To13MigrationOnlineProfile -Name 'SP07To13MigrationOnlineProfile1' -Path 'C:\SP07To13MigrationOnlineProfile1.xml' -Overwrite This command downloads the SharePoint 2007 to 2013 online migration profile to an XML file. 186

187 Related Links Upload-DASP07To13MigrationOnlineProfile Upload-DASP07To13MigrationOnlineProfile Uploads the SharePoint 2007 to 2013 online migration profile. Syntax Upload-DASP07To13MigrationOnlineProfile [-Path] <String> [-Overwrite] [<CommonParameters>] The Upload-DASP07To13MigrationOnlineProfile cmdlet uploads the SharePoint 2007 to 2013 online migration profile from an XML file. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DASP07To13MigrationOnlineProfile -Path 'C:\SP07To13MigrationOnlineProfile1.xml' -Overwrite This command uploads the SharePoint 2007 to 2013 online migration profile to manager. 187

188 Related Links Download-DASP07To13MigrationOnlineProfile SharePoint 2010 to 2013 Migration Refer to the following sections for more information. Get-DASP10To13MigrationOnlinePlan Gets the plan settings of the specified SharePoint 2010 to 2013 online migration plan(s). Syntax Get-DASP10To13MigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DASP10To13MigrationOnlinePlan cmdlet gets the configurations of the specified SharePoint 2010 to 2013 online migration plan(s). Parameters -Name<String[]> Specifies the name(s) of the existing SharePoint 2010 to 2013 online migration plan(s) you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing SharePoint 2010 to 2013 online migration plan(s) will be obtained. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DASP10To13MigrationOnlinePlan -Name 'plan1' SourceFarmName : Farm(SP2010_DB:SH 188

189 AREPOINT_CONFIG) DestinationFarmName : Farm(SP2013_DB:SH AREPOINT_CONFIG) SourceAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C ONFIG) DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 3_DB:SHAREPOINT_C ONFIG) DestinationSPSitesGroupName : SourceTree : DocAve.API.Migrat ion.sp10to13migra tion.sp10to13migr ationsourcetree DestinationTree : DocAve.API.Migrat ion.sp10to13migra tion.sp10to13migr ationdestinationt ree Action MigrationDatabaseName : Merge : MigrationDB UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : plan1 : 189

190 ProfileName NotificationName AssociatedPlanGroup : Default Profile : Notification1 : {PlanGroup1} This command gets the plan settings of the specified plan. Related Links New-DASP10To13MigrationOnlinePlan Update-DASP10To13MigrationOnlinePlan Remove-DASP10To13MigrationOnlinePlan Get-DASP10To13MigrationBlankOnlinePlan Gets a blank SharePoint 2010 to 2013 online migration plan without any plan settings. Syntax Get-DASP10To13MigrationBlankOnlinePlan [<CommonParameters>] This command gets a blank SharePoint 2010 to 2013 online migration plan that has no plan settings configured. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DASP10To13MigrationBlankOnlinePlan PS C:\>$plan SourceFarmName : DestinationFarmName : 190

191 SourceAgentGroupName : DestinationAgentGroupName : DestinationSPSitesGroupName : SourceTree : DocAve.API.Migrat ion.sp10to13migra tion.sp10to13migr ationsourcetree DestinationTree : DocAve.API.Migrat ion.sp10to13migra tion.sp10to13migr ationdestinationt ree Action : Merge MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : : ProfileName : Notification : AssociatedPlanGroup : {} This command gets a SharePoint 2010 to 2013 online migration blank plan that has no plan settings configured. Related Links New-DASP10To13MigrationOnlinePlan 191

192 New-DASP10To13MigrationOnlinePlan Creates a new SharePoint 2010 to 2013 online migration plan. Syntax New-DASP10To13MigrationOnlinePlan [-Plan] <SP10To13MigrationOnlinePlan> [<CommonParameters>] The New-DASP10To13MigrationOnlinePlan cmdlet creates a new SharePoint 2010 to 2013 online migration plan. Parameters -Plan<SP10To13MigrationOnlinePlan> Specifies a SharePoint 2010 to 2013 Migration online plan object. About the structure and attribute of SP10To13MigrationOnlinePlan, please refer to the SDK documentation for more information. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DASP10To13MigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.SourceFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationFarmName = 'Farm(SP2013_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.SourceAgentGroupName = 'AgentGroup10' PS C:\>$plan.DestinationAgentGroupName = 'AgentGroup13' PS C:\>$plan.ProfileName = 'Default Profile' 192

193 PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list10, $true, $false) PS C:\>$list13 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2013_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.DestinationTree.SelectSPObject($list13) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$scheduleForFullJob = New-Object DocAve.API.Migration.SP10To13Migration.SP10To13MigrationSchedule PS C:\>$scheduleForFullJob.JobOption = "Full" PS C:\>$scheduleForFullJob.ConflictResolution = "MergeAndOverwrite" PS C:\>$scheduleForFullJob.StartTime = " :00" PS C:\>$scheduleForFullJob.TimeZoneId = "Pacific Standard Time" PS C:\>$scheduleForFullJob.Interval = "2Day" PS C:\>$scheduleForFullJob.NumberOfOccurrence = 1 PS C:\>$plan.Schedules.Add($scheduleForFullJob) PS C:\>$scheduleForIncrementalJob = New-Object DocAve.API.Migration.SP10To13Migration.SP10To13MigrationSchedule PS C:\>$scheduleForIncrementalJob.JobOption = "Incremental" PS C:\>$scheduleForIncrementalJob.ConflictResolution = "Skip" PS C:\>$scheduleForIncrementalJob.StartTime = " :00" PS C:\>$scheduleForIncrementalJob.TimeZoneId = "Pacific Standard Time" PS C:\>$scheduleForIncrementalJob.Interval = "2Day" PS C:\>$scheduleForIncrementalJob.SetNoEnd() 193

194 PS C:\>$plan.Schedules.Add($scheduleForIncrementalJob) PS C:\>New-DASP10To13MigrationOnlinePlan -Plan $plan 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 = Get-DASP10To13MigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.SourceFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationSPSitesGroupName = 'Default_SharePoint Sites_Group' PS C:\>$plan.SourceAgentGroupName = 'AgentGroup10' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list10, $true, $false) PS C:\>$listOnline = New-Object DocAve.API.Objects.SharePointonlineList('Default_SharePoint Sites_Group', ' 'list1') PS C:\>$plan.DestinationTree.SelectSPOnlineObject($listOnline) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>New-DASP10To13MigrationOnlinePlan -Plan $plan 194

195 These commands show how to create a SharePoint 2010 to 2013 online migration plan. The destination is from My Registered Sites. Related Links Get-DASP10To13MigrationBlankOnlinePlan Update-DASP10To13MigartionOnlinePlan Remove-DASP10To13MigartionOnlinePlan Get-DASP10To13MigartionOnlinePlan Update-DASP10To13MigrationOnlinePlan Updates an existing SharePoint 2010 to 2013 online migration plan. Syntax Update-DASP10To13MigrationOnlinePlan [-Plan] <SP10To13MigrationOnlinePlan> [<CommonParameters>] The Update-DASP10To13MigrationOnlinePlan cmdlet updates an existing SharePoint 2010 to 2013 online migration plan. Parameters -Plan<SP10To13MigrationOnlinePlan> Specifies a plan name to get an existing SharePoint 2010 to 2013 online migration plan for editing. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DASP10To13MigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = 'New ' 195

196 PS C:\>$plan.SourceFarmName = 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.DestinationFarmName = 'Farm(SP2013_DB:SHAREPOINT_CONFIG)' PS C:\>$plan.SourceAgentGroup = 'AgentGroup10' PS C:\>$plan.DestinationAgentGroup = 'AgentGroup13' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$list10 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2010_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2010:10001/sites/site1','/sites/site1', 'list1') PS C:\>$plan.SourceTree.IncludeSPList($list10, $true, $false) PS C:\>$list13 = New-Object DocAve.API.Objects.Sharepointlist('Farm(SP2013_DB:SHAREPOINT_CONFIG)', 'htt p://sharepoint2013:10001/sites/site1','/sites/site1', 'list1') PS C:\>$plan.DestinationTree.SelectSPObject($list13) PS C:\>$plan.Action = 'Merge' PS C:\>$plan.AssociatedPlanGroup.Add('plan group1') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>Update-DASP10To13MigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified SharePoint 2010 to 2013 online migration plan. Related Links Get-DASP10To13MigrationOnlinePlan New-DASP10To13MigrationOnlinePlan Remove-DASP10To13MigrationOnlinePlan 196

197 Remove-DASP10To13MigrationOnlinePlan Deletes the specified SharePoint 2010 to 2013 online migration plan. Syntax Remove-DASP10To13MigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DASP10To13MigrationOnlinePlan cmdlet deletes the specified SharePoint 2010 to 2013 online migration plan. Parameters -Name<String> Specifies the name of a SharePoint 2010 to 2013 online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DASP10To13MigrationOnlinePlan -Name 'plan1' 197

198 This command deletes the specified plan. Related Links Get-DASP10To13MigrationOnlinePlan Update-DASP10To13MigrationOnlinePlan New-SP10To13MigrationOnlinePlan Run-DASP10To13MigrationOnlineJob Runs a SharePoint 2010 to 2013 online migration plan. Syntax Run-DASP10To13MigrationOnlineJob [-PlanName] <String> -Options <String> [-IncrementalType <String>] -ConflictResolution <SP10To13MigrationConflictResolution> -JobReportType <String> [- TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DASP10To13MigrationOnlineJob cmdlet runs a SharePoint 2010 to 2013 online migration plan. Parameters -PlanName<String> Specifies the name of an existing SharePoint 2010 to 2013 online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. The valid values are "Full" and "Incremental". true named false false -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 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'. 198

199 false named false false -ConflictResolution<SP10To13MigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". true named false false -JobReportType<String> Specifies the job report level. The valid values are "Simplified" and "Detailed". true named false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DASP10To13MigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -JobReportType Detailed - WaitForJobComplete 199

200 ID PlanName Module Status : MD : plan1 : SharePointMigration : Finished StartTime : 7/10/2012 2:49:29 PM FinishTime : 7/10/2012 3:19:44 PM Progress : 100 This command runs the specified SharePoint 2010 to 2013 online migration plan in full. Example 2 PS C:\>Run-DASP10To13MigrationOnlineJob -PlanName 'plan2' -Options Incremental -IncrementalType 123hour -ConflictResolution Skip - JobReportType Detailed -WaitForJobComplete -TestRun ID PlanName Module Status : MD : plan2 : SharePointMigration : Finished StartTime : 7/10/2012 2:54:29 PM FinishTime : 7/10/2012 3:29:44 PM Progress : 100 This command simulates an incremental migration job of the specified SharePoint 2010 to 2013 online migration plan. Related Links Get-DASP10To13MigrationOnlinePlan 200

201 Download-DASP10To13MigrationOnlineProfile Downloads the SharePoint 2010 to 2013 online migration profile. Syntax Download-DASP10To13MigrationOnlineProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DASP10To13MigrationOnlineProfile cmdlet downloads the SharePoint 2010 to 2013 online migration profile to an XML file. Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DASP10To13MigrationOnlineProfile -Name 'SP10To13MigrationOnlineProfile1' -Path 'C:\SP10To13MigrationOnlineProfile1.xml' -Overwrite 201

202 This command downloads the SharePoint 2010 to 2013 online migration profile to an XML file. Related Links Upload-DASP10To13MigrationOnlineProfile Upload-DASP10To13MigrationOnlineProfile Uploads the SharePoint 2010 to 2013 online migration profile. Syntax Upload-DASP10To13MigrationOnlineProfile [-Path] <String> [-Overwrite] [<CommonParameters>] The Upload-DASP10To13MigrationOnlineProfile cmdlet uploads the SharePoint 2010 to 2013 online migration profile from an XML file. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DASP10To13MigrationOnlineProfile -Path 'C:\SP10To13MigrationOnlineProfile1.xml' -Overwrite 202

203 This command uploads the SharePoint 2010 to 2013 online migration profile to manager. Related Links Download-DASP10To13MigrationOnlineProfile Lotus Notes Migration Refer to the following sections for more information. Get-DALotusNotesMigrationOnlinePlan Gets the plan settings of the specified Lotus Notes online migration plan(s). Syntax Get-DALotusNotesMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DALotusNotesMigrationOnlinePlan cmdlet gets the configurations of the specified Lotus Notes online migration plan(s). Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DALotusNotesMigrationOnlinePlan -Name 'plan1' 203

204 SourceTree : DocAve.API.Migration.LotusNotesMigra tion.lotusnotesmigrationsourcetree SourceAgentName ConnectionName DominoServerName ServerName AddressBookName ShowSystemDB DestinationTree : Agent-LotusNotes : Connection-LotusNotes : NotesDominoServer : NotesServer : NotesAddressBook : True : DocAve.API.Migration.LotusNotesMigra tion.lotusnotesmigrationdestinationt ree DestinationFarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG) DestinationSPSitesGroupName : MigrationDatabaseName : MigrationDatabase Schedules : {} DestinationAgentGroupName : DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_ DB:SHAREPOINT_CONFIG) Name ProfileName NotificationName : plan1 : : Default Profile : Notification1 AssociatedPlanGroup : {} This command gets the plan settings of the specified plan. 204

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>] The Get-DALotusNotesMigrationBlankOnlinePlan cmdlet gets a blank Lotus Notes online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DALotusNotesMigrationBlankOnlinePlan PS C:\>$plan SourceTree : SourceAgentName : ConnectionName : DominoServerName : ServerName : AddressBookName : 205

206 ShowSystemDB DestinationTree : True : DocAve.API.Migration.LotusNotesMigra tion.lotusnotesmigrationdestinationt ree DestinationFarmName : DestinationSPSitesGroupName : MigrationDatabaseName : Schedules : {} DestinationAgentGroupName : Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} 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>] The New-DALotusNotesMigrationOnlinePlan cmdlet creates a new Lotus Notes online migration plan. Parameters -Plan<LotusNotesMigrationOnlinePlan> 206

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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DALotusNotesMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 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 = " :00" 207

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 = new-object DocAve.API.Migration.LotusNotesMigration.LotusNotesMigrationSchedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DALotusNotesMigrationOnlinePlan -Plan $plan These commands show how to create a Lotus Notes online migration plan by getting a blank plan. Example 2 PS C:\>$plan = Get-DALotusNotesMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$destinationNode = New-Object DocAve.API.Objects.SharePointOnlineWeb 'Default_SharePoint Sites_Group', ' '' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($destinationNode) 208

209 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 = " :00" 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 = new-object DocAve.API.Migration.LotusNotesMigration.LotusNotesMigrationSchedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DALotusNotesMigrationOnlinePlan -Plan $plan These commands show how to create a Lotus Notes online migration plan. The destination is from My Registered Sites. 209

210 Related Links Get-DALotusNotesMigrationBlankOnlinePlan Get-DALotusNotesMigrationOnlinePlan Update-DALotusNotesMigrationOnlinePlan Remove-DALotusNotesMigrationOnlinePlan Update-DALotusNotesMigrationOnlinePlan Updates an existing Lotus Notes online migration plan. Syntax Update-DALotusNotesMigrationOnlinePlan [-Plan] <LotusNotesMigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DALotusNotesMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' 210

211 PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB:SHAREPOINT_CONFIG)', ' 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:\>Update-DALotusNotesMigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified Lotus Notes online migration plan. Related Links Get-DALotusNotesMigrationOnlinePlan New-DALotusNotesMigrationOnlinePlan Remove-DALotusNotesMigrationOnlinePlan Remove-DALotusNotesMigrationOnlinePlan Deletes the specified Lotus Notes online migration plan. Syntax Remove-DALotusNotesMigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DALotusNotesMigrationOnlinePlan deletes the specified Lotus Notes online migration plan. Parameters -Name<String> Specifies the name of a Lotus Notes online migration plan that you want to delete. true 0 true (ByValue) false 211

212 -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DALotusNotesMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DALotusNotesMigrationOnlinePlan Update-DALotusNotesMigrationOnlinePlan New-DALotusNotesMigrationOnlinePlan Run-DALotusNotesMigrationOnlineJob Runs a Lotus Notes online migration plan. Syntax Run-DALotusNotesMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <LotusNotesMigrationConflictResolution> [-RemigrateObjectsWithException] [- IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] 212

213 The Run-DALotusNotesMigrationOnlineJob cmdlet runs a Lotus Notes online migration plan. Parameters -PlanName<String> Specifies the name of an existing Lotus Notes online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental". true named false false -ConflictResolution<LotusNotesMigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". 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>] 213

214 Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DALotusNotesMigrationOnlineJob -PlanName 'plan1' -Options Incremental -ConflictResolution MergeAndAppend - RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions - WaitForJobComplete ID PlanName Module Status : LM : plan1 : LotusNotesMigration : Finished StartTime : 9/10/ :55:36 PM FinishTime : 9/10/2012 1:25:44 PM Progress : 100 This command runs the specified Lotus Notes online migration plan in incremental. 214

215 Related Links Get-DALotusNotesMigrationOnlinePlan Download-DALotusNotesMigrationOnlineMappingOptionsProfile Downloads the Mapping Options profile of the Lotus Notes online migration. Syntax Download-DALotusNotesMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DALotusNotesMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping Options profile of Lotus Notes online migration to an XML file in the specified local path. Parameters -Name<String> 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. false named false false <CommonParameters> Examples 215

216 PS C:\>Download-DALotusNotesMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite 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] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> 216

217 Examples PS C:\>Upload-DALotusNotesMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DALotusNotesMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration Options profile of the Lotus Notes online migration to an XML file in the specified local path. Parameters -Name<String> 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. 217

218 false named false false <CommonParameters> Examples PS C:\>Download-DALotusNotesMigrationOnlineMigrationOptionsProfile - Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Migration Options profile of the Lotus Notes online migration to an XML file in the specified local path. 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] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] 218

219 Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DALotusNotesMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite 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 Refer to the following sections for more information. Get-DAFileSystemMigrationOnlinePlan Gets the plan settings of the specified file system online migration plan(s). Syntax Get-DAFileSystemMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DAFileSystemMigrationOnlinePlan cmdlet gets the plan settings of the specified file system online migration plan(s). Parameters -Name<String[]> 219

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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DAFileSystemMigrationOnlinePlan -Name 'plan 1' MetadataResolution : UseCustomizedMeta datafile MetadataSettings : DocAve.API.Migrat ion.filesystemmig ration.usecustomi zedmetadatafile MetadataFileReady SourceAgentName SourceTree : True : SP2010 : DocAve.API.Migrat ion.filesystemmig ration.filesystem MigrationSourceTr ee 220

221 DestinationFarmName : Farm(SQL:SHAREPOI NT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C ONFIG) DestinationTree : DocAve.API.Migrat ion.filesystemmig ration.filesystem MigrationDestinat iontree MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : plan 1 : ProfileName NotificationName : Default Profile : Notification1 AssociatedPlanGroup : {} This command gets the plan settings of the specified plan. Related Links Get-DAFileSystemMigrationBlankOnlinePlan Gets a blank file system online migration plan. 221

222 Syntax Get-DAFileSystemMigrationBlankOnlinePlan [<CommonParameters>] The Get-DAFileSystemMigrationBlankOnlinePlan cmdlet gets a blank file system online migration plan. Parameters <CommonParameters> Examples 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 DestinationFarmName : DestinationSPSitesGroupName : 222

223 DestinationAgentGroupName : DestinationTree : DocAve.API.Migrati on.filesystemmigra tion.filesystemmig rationdestinationt ree MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False UserHighPerformanceConversion MigrateContentOnly : False : False Schedules : {} Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} 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>] The New-DAFileSystemMigrationOnlinePlan cmdlet creates a new file system online migration plan. 223

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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAFileSystemMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan 1' PS C:\>$plan.ProfileName = 'default profile' PS C:\>$plan.NotificationName = 'Notification1' 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) PS C:\>$list = New-Object DocAve.API.Objects.SharePointList 'Farm(SQL:SHAREPOINT_CONFIG)', ' '', 'shared documents' PS C:\>$plan.DestinationTree.SelectSPObject($list) PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$scheduleForIncrementalJob = New-Object DocAve.API.Migration.FileSystemMigration.FileSystemMigrationSchedule PS C:\>$scheduleForIncrementalJob.JobOption = 'incremental' PS C:\>$scheduleForIncrementalJob.TimeZoneId = 'Tokyo Standard Time' PS C:\>$scheduleForIncrementalJob.Interval = '15minute' 224

225 PS C:\>$scheduleForIncrementalJob.NumberOfOccurrence = 2 PS C:\>$scheduleForIncrementalJob.StartTime = ' :10' PS C:\>$scheduleForIncrementalJob.EndTime = ' :00' PS C:\>$scheduleForIncrementalJob.IgnoreMetadataAndSecurityExceptions = $true PS C:\>$plan.Schedules.Add($scheduleForIncrementalJob) PS C:\>New-DAFileSystemMigrationOnlinePlan -Plan $plan 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 = Get-DAFileSystemMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan 1' PS C:\>$plan.ProfileName = 'default profile' PS C:\>$plan.NotificationName = 'Notification1' 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) PS C:\>$listOnline = New-Object DocAve.API.Objects.SharePointOnlineList 'Default_SharePoint Sites_Group', ' '', 'shared documents' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($listOnline) PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>New-DAFileSystemMigrationOnlinePlan -Plan $plan These commands show how to create a file system online migration plan. The destination is from My Registered Sites. 225

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>] 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. Parameters -PlanName<String> 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> 226

227 Examples PS C:\>$jobId = Generate-DAFileSystemMigrationMetadataFile -PlanName 'plan 1' -Option Full 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>] The Update-DAFileSystemMigrationOnlinePlan updates an existing file system online migration plan. Parameters -Plan<FileSystemMigrationOnlinePlan> Specifies a file system online migration plan for editing. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAFileSystemMigrationOnlinePlan -Name 'plan 1' PS C:\>$plan. = 'updated from cmdlet' 227

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 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. = '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) PS C:\>$listOnline = New-Object DocAve.API.Objects.SharePointOnlineList 'New Sites Group', ' '', 'shared documents' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($listOnline) PS C:\>Update-DAFileSystemMigrationOnlinePlan -Plan $plan 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] [- Confirm] [<CommonParameters>] 228

229 The Remove-DAFileSystemMigrationOnlinePlan cmdlet deletes the specified file system online migration plan. Parameters -Name<String> Specifies the name of a file system online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DAFileSystemMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links 229

230 Run-DAFileSystemMigrationOnlineJob Runs a file system online migration plan. Syntax Run-DAFileSystemMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <FileSystemMigrationConflictResolution> [-RemigrateObjectsWithException] [- IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DAFileSystemMigrationOnlineJob cmdlet runs a file system online migration plan. Parameters -PlanName<String> Specifies the name of an existing file system online migration plan that you want to run. true 0 true (ByValue) false -Options<String> 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> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "SkipAndNewVersion", "MergeAndOverwrite", "MergeAndAppend" and "MergeAndNewVersion". 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". 230

231 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>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DAFileSystemMigrationOnlineJob -PlanName 'plan 1' -Options Incremental -ConflictResolution MergeAndAppend -WaitForJobComplete - RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions ID : FM PlanName : plan 1 231

232 Module Status : FileSystemMigration : Finished StartTime : 2012/10/23 17:28:52 FinishTime : 2012/10/23 17:30:09 Progress : 100 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> 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>] 232

233 Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Download-DAFileSystemMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite 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 Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the file system online migration. Syntax Upload-DAFileSystemMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false 233

234 -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DAFileSystemMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> Specifies the profile name. 234

235 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. false named false false <CommonParameters> Examples PS C:\>Download-DAFileSystemMigrationOnlineMigrationOptionsProfile - Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Migration Options profile of the file system online migration to an XML file in the specified local path. 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] <String> [-Overwrite] [<CommonParameters>] 235

236 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DAFileSystemMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite 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 Refer to the following sections for more information. Get-DALivelinkMigrationOnlinePlan Gets the plan settings of the specified Livelink online migration plan(s). 236

237 Syntax Get-DALivelinkMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DALivelinkMigrationOnlinePlan cmdlet gets the configurations of the specified Livelink online migration plan(s). Parameters -Name<String[]> Specifies the name(s) of the existing Livelink online migration plan(s) that you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, the information of all of the existing Livelink online migration plan(s) will be obtained. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DALivelinkMigrationOnlinePlan -Name 'plan1' ConnectionName DestinationFarmName : Livelink : Farm(SP2010_DB:SH AREPOINT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C 237

238 ONFIG) SourceTree : DocAve.API.Migrat ion.livelinkmigra tion.livelinkmigr ationsourcetree DestinationTree : DocAve.API.Migrat ion.livelinkmigra tion.livelinkmigr ationdestinationt ree ProjectMigrationSelection : MigrateProjectAsS ite MigrationDatabaseName : MigrationDB UseSpecifiedMigrationDatabaseToStoreTheJobData : True Schedules : {} Name : plan1 : ProfileName NotificationName AssociatedPlanGroup : Default Profile : Notification1 : {PlanGroup01} This command gets the plan settings of the specified plan. Related Links New-DALivelinkMigrationOnlinePlan Update-DALivelinkMigrationOnlinePlan Remove-DALivelinkMigrationOnlinePlan 238

239 Get-DALivelinkMigrationBlankOnlinePlan Gets a blank Livelink online migration plan without any plan settings. Syntax Get-DALivelinkMigrationBlankOnlinePlan [<CommonParameters>] The Get-DALivelinkMigrationBlankOnlinePlan cmdlet gets a blank Livelink online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DALivelinkMigrationBlankOnlinePlan PS C:\>$plan ConnectionName : DestinationFarmName : DestinationSPSitesGroupName : DestinationAgentGroupName : SourceTree : DocAve.API.Migrat ion.livelinkmigra tion.livelinkmigr ationsourcetree DestinationTree : DocAve.API.Migrat ion.livelinkmigra 239

240 tion.livelinkmigr ationdestinationt ree ProjectMigrationSelection : None MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : : ProfileName : NotificationName : NotificationName : AssociatedPlanGroup : {} 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>] 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. 240

241 true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DALivelinkMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = 'this is a livelink plan' PS C:\>$plan.ProfileName = 'Default profile' PS C:\>$plan.AssociatedPlanGroup.Add('PlanGroup01') PS C:\>$plan.ConnectionName = 'livelink' PS C:\>$item1 = New-Object 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') PS C:\>$container2 = New-Object 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 DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($webapp10) 241

242 PS C:\>$plan.ProjectMigrationSelection = 'MigrateProjectAsSiteCollection' PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$scheduleForIncrementalJob = New-Object 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.StartTime = ' :00' PS C:\>$scheduleForIncrementalJob.NumberOfOccurrence = 3 PS C:\>$scheduleForIncrementalJob.SetNoEnd() PS C:\>$plan.Schedules.Add($scheduleForIncrementalJob) PS C:\>New-DALivelinkMigrationOnlinePlan -Plan $plan These commands show how to create a Livelink online migration plan by getting a blank plan. Example 2 PS C:\>$plan = Get-DALivelinkMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = 'this is a livelink plan' PS C:\>$plan.ProfileName = 'Default profile' PS C:\>$plan.AssociatedPlanGroup.Add('PlanGroup01') PS C:\>$plan.ConnectionName = 'livelink' PS C:\>$item1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkItem('Admin','item01',' EnterpriseWorkspace') 242

243 PS C:\>$path = 'Folder', 'Folder01', ' Folder02' PS C:\>$container1 = New-Object DocAve.API.Migration.LivelinkMigration.LivelinkContainer('Admin',$path,'EnterpriseWorkspace') PS C:\>$container2 = New-Object 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:\>$onlineWeb = New-Object DocAve.API.Objects.SharePointOnlineWeb('Farm(SP2010_DB:SHAREPOINT_CONF IG)',' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($onlineWeb) PS C:\>$plan.ProjectMigrationSelection = 'MigrateProjectAsSiteCollection' PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>New-DALivelinkMigrationOnlinePlan -Plan $plan 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 Update-DALivelinkMigrationOnlinePlan Remove-DALivelinkMigrationOnlinePlan Update-DALivelinkMigrationOnlinePlan Updates an existing Livelink online migration plan. 243

244 Syntax Update-DALivelinkMigrationOnlinePlan [-Plan] <LivelinkMigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DALivelinkMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = 'this is a livelink plan' PS C:\>$plan.ProfileName = 'Default profile' PS C:\>$plan.AssociatedPlanGroup.Add('PlanGroup01') PS C:\>$plan.ConnectionName = 'livelink' PS C:\>$item1 = New-Object 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') 244

245 PS C:\>$container2 = New-Object 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 DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($webapp10) PS C:\>$plan.ProjectMigrationSelection = 'MigrateProjectAsSiteCollection' PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>Update-DALivelinkMigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified Livelink online migration plan. Related Links Get-DALivelinkMigrationOnlinePlan New-DALivelinkMigrationOnlinePlan Remove-DALivelinkMigrationOnlinePlan Remove-DALivelinkMigrationOnlinePlan Deletes the specified Livelink online migration plan. Syntax Remove-DALivelinkMigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DALivelinkMigrationOnlinePlan deletes the specified Livelink online migration plan. Parameters -Name<String> 245

246 Specifies the name of a Livelink online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DALivelinkMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DALivelinkMigrationOnlinePlan Update-DALivelinkMigrationOnlinePlan New-DALivelinkMigrationOnlinePlan Run-DALivelinkMigrationOnlineJob Runs a Livelink online migration plan. 246

247 Syntax Run-DALivelinkMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <LivelinkMigrationConflictResolution> [- TestRun] [-RemigrateObjectsWithException] [- IgnoreMetadataAndSecurityExceptions] [-WaitForJobComplete] [<CommonParameters>] The Run-DALivelinkMigrationOnlineJob cmdlet runs a Livelink online migration plan. Parameters -PlanName<String> Specifies the name of an existing Livelink online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental". true named false false -ConflictResolution<LivelinkMigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". true named false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false 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". 247

248 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 -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DALivelinkMigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -WaitForJobComple te -IgnoreMetadataAndSecurityExceptions ID PlanName Module Status : LL : plan1 : LivelinkMigration : InProgress StartTime : 11/1/2012 7:12:18 PM 248

249 FinishTime : Progress : 0 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DALivelinkMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping Options profile of the Livelink online migration to an XML file in the specified local path. Parameters -Name<String> 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. false named false false <CommonParameters> 249

250 Examples PS C:\>Download-DALivelinkMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite 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 Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the Livelink online migration. Syntax Upload-DALivelinkMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false 250

251 <CommonParameters> Examples PS C:\>Upload-DALivelinkMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DALivelinkMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration Options profile of the Livelink online migration to an XML file in the specified local path. Parameters -Name<String> Specifies the profile name. true 0 false false -Path<String> Specifies the path to store the downloaded XML file. 251

252 true 1 false false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Download-DALivelinkMigrationOnlineMigrationOptionsProfile -Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Migration Options profile of the Livelink online migration to an XML file in the specified local path. Related Links Upload-DALivelinkMigrationOnlineMigrationOptionsProfile Upload-DALivelinkMigrationOnlineMigrationOptionsProfile Uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Livelink online migration. Syntax Upload-DALivelinkMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> 252

253 Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DALivelinkMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Livelink online migration. Related Links Download-DALivelinkMigrationOnlineMigrationOptionsProfile eroom Migration Refer to the following sections for more information. Get-DAERoomMigrationOnlinePlan Gets the plan settings of the specified eroom online migration plan(s). Syntax Get-DAERoomMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] 253

254 The Get-DAERoomMigrationOnlinePlan cmdlet gets the configurations of the specified eroom online migration plan(s). Parameters -Name<String[]> Specifies the name(s) of the existing eroom online migration plan(s) that you want to get information from. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, The information of all of the existing eroom online migration plan(s) will be obtained. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DAERoomMigrationOnlinePlan -Name 'plan01' SourceAgentName DestinationFarmName : agent-eroom : Farm(SP2010_DB:SH AREPOINT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C ONFIG) SourceTree 254 : DocAve.API.Migrat

255 ion.eroommigratio n.eroommigrations ourcetree DestinationTree : DocAve.API.Migrat ion.eroommigratio n.eroommigrationd estinationtree MigrationDatabaseName : MigrationDB UseSpecifiedMigrationDatabaseToStoreTheJobData : True Schedules : {} Name : plan01 : this is an eroom migration online plan. ProfileName NotificationName AssociatedPlanGroup : Default Profile : Notification1 : {PlanGroup1} This command gets the plan settings of the specified plan. 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>] 255

256 The Get-DAERoomMigrationBlankOnlinePlan cmdlet gets a blank eroom online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DAERoomMigrationBlankOnlinePlan PS C:\>$plan SourceAgentName : DestinationFarmName : DestinationSPSitesGroupName : DestinationAgentGroupName : SourceTree : DocAve.API.Migrat ion.eroommigratio n.eroommigrations ourcetree DestinationTree : DocAve.API.Migrat ion.eroommigratio n.eroommigrationd estinationtree MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False 256

257 Schedules : Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} 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> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples 257

258 PS C:\>$plan = Get-DAERoomMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '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:\>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($webapp10) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$scheduleForFullJob = New-Object DocAve.API.Migration.ERoomMigration.ERoomMigrationSchedule PS C:\>$scheduleForFullJob.ConflictResolution = 'skip' PS C:\>$scheduleForFullJob.Interval = '1day' 258

259 PS C:\>$scheduleForFullJob.TimeZoneId = 'Taipei Standard Time' PS C:\>$scheduleForFullJob.StartTime = ' :40' PS C:\>$scheduleForFullJob.NumberOfOccurrence = 2 PS C:\>$scheduleForFullJob.SetNoEnd() PS C:\>$scheduleForFullJob.IgnoreMetadataAndSecurityExceptions = $true PS C:\>$plan.Schedules.Add($scheduleForFullJob) PS C:\>New-DAERoomMigrationOnlinePlan -Plan $plan These commands show how to create an eroom online migration plan by getting a blank plan. Example 2 PS C:\>$plan = Get-DAERoomMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '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) 259

260 PS C:\>$onlineWeb = New-Object DocAve.API.Objects.SharePointOnlineWeb('Farm(SP2010_DB:SHAREPOINT_CONF IG)',' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($onlineWeb) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>New-DAERoomMigrationOnlinePlan -Plan $plan 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 Update-DAERoomMigrationOnlinePlan Remove-DAERoomMigrationOnlinePlan Update-DAERoomMigrationOnlinePlan Updates an existing eroom online migration plan. Syntax Update-DAERoomMigrationOnlinePlan [-Plan] <ERoomMigrationOnlinePlan> [<CommonParameters>] The Update-DAERoomMigrationOnlinePlan cmdlet updates an existing eroom online migration plan. Parameters -Plan<ERoomMigrationOnlinePlan> Specifies an existing eroom online migration plan for editing. true 0 true (ByValue) false <CommonParameters> 260

261 Examples PS C:\>$plan = Get-DAERoomMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = '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:\>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($webapp10) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') PS C:\>Update-DAERoomMigrationOnlinePlan -Plan $plan 261

262 These commands update the plan settings of the specified eroom online migration plan. Related Links Get-DAERoomMigrationOnlinePlan New-DAERoomMigrationOnlinePlan Remove-DAERoomMigrationOnlinePlan Remove-DAERoomMigrationOnlinePlan Deletes the specified eroom online migration plan. Syntax Remove-DAERoomMigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DAERoomMigrationOnlinePlan cmdlet deletes the specified eroom online migration plan. Parameters -Name<String> Specifies the name of an eroom online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> 262

263 Examples PS C:\>Remove-DAERoomMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DAERoomMigrationOnlinePlan Update-DAERoomMigrationOnlinePlan New-DAERoomMigrationOnlinePlan Run-DAERoomMigrationOnlineJob Runs an eroom online migration plan. Syntax Run-DAERoomMigrationOnlineJob [-PlanName] <String> -Options <String> - ConflictResolution <ERoomMigrationConflictResolution> [- RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DAERoomMigrationOnlineJob cmdlet runs an eroom online migration plan. Parameters -PlanName<String> Specifies the name of an existing eroom online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental". 263

264 true named false false -ConflictResolution<ERoomMigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". 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>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> 264

265 Examples PS C:\>Run-DAERoomMigrationOnlineJob -PlanName 'plan1' -Options Full - ConflictResolution Skip -IgnoreMetadataAndSecurityExceptions ID PlanName Module Status : EM : plan1 : ERoomMigration : Waiting StartTime : 10/5/2012 5:08:17 PM FinishTime : Progress : 0 This command runs the specified eroom online migration plan in full. Related Links Get-DAERoomMigrationOnlinePlan Download-DAERoomMigrationOnlineMappingOptionsProfile Downloads the Mapping Options profile of the eroom online Migration. Syntax Download-DAERoomMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DAERoomMigrationOnlineMappingOptionsProfile cmdlet downloads the Mapping Options profile of the eroom online migration to an XML file in the specified local path. 265

266 Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DAERoomMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Mapping Options profile of the eroom online migration to an XML file in the specified local path. Related Links Upload-DAERoomMigrationOnlineMappingOptionsProfile Upload-DAERoomMigrationOnlineMappingOptionsProfile Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the eroom online migration. 266

267 Syntax Upload-DAERoomMigrationOnlineMappingOptionsProfile [-Path] <String> [- Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DAERoomMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the eroom online migration. Related Links Download-DAERoomMigrationOnlineMappingOptionsProfile Download-DAERoomMigrationOnlineMigrationOptionsProfile Downloads the Migration Options profile of the eroom online migration. 267

268 Syntax Download-DAERoomMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] The Download-DAERoomMigrationOnlineMigrationOptionsProfile cmdlet downloads the Migration Options profile of the eroom online migration to an XML file in the specified local path. Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DAERoomMigrationOnlineMigrationOptionsProfile -Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Migration Options profile of the eroom online migration to an XML file in the specified local path. 268

269 Related Links Upload-DAERoomMigrationOnlineMigrationOptionsProfile Upload-DAERoomMigrationOnlineMigrationOptionsProfile Uploads the specified XML file from the local path to the Manager as the Migration Options profile of the eroom online migration. Syntax Upload-DAERoomMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DAERoomMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite 269

270 This command uploads the specified XML file from the local path to the Manager as the Migration Options profile of the eroom online migration. Related Links Download-DAERoomMigrationOnlineMigrationOptionsProfile Exchange Public Folder Migration Refer to the following sections for more information. Get-DAExchangePublicFolderMigrationOnlinePlan Gets the plan settings of the specified Exchange Public Folder online migration plan(s). Syntax Get-DAExchangePublicFolderMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DAExchangePublicFolderMigrationOnlinePlan cmdlet gets the configurations of the specified Exchange Public Folder online migration plan(s). Parameters -Name<String[]> Specifies the name(s) of the existing Exchange Public Folder 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 Exchange Public Folder online migration plan(s) will be obtained. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1' 270

271 SourceTree : DocAve.API.Migration. ExchangePublicFolderM igration.exchangepubl icfoldermigrationsour cetree ConnectionName SourceAgentName DestinationTree : Connection1 : Agent1 : DocAve.API.Migration. ExchangePublicFolderM igration.exchangepubl icfoldermigrationdest inationtree DestinationFarmName : Farm(SP2010_DB:SHAREP OINT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GROUP_F OR_Farm(SP2010_DB:SHA REPOINT_CONFIG) MigrationDatabaseName : MigrationDatabase Schedules : {} UseSpecifiedMigrationDatabaseToStoreTheJobData : True Name ProfileName NotificationName AssociatedPlanGroup : plan1 : : Default Profile : Notification1 : {PlanGroup01} 271

272 This command gets the plan settings of the specified plan. 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 [<CommonParameters>] The Get-DAExchangePublicFolderMigrationBlankOnlinePlan cmdlet gets a blank Exchange Public Folder online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan PS C:\>$plan SourceTree : DocAve.API.Migrat ion.exchangepubli cfoldermigration. 272

273 ExchangePublicFol dermigrationsourc etree ConnectionName : SourceAgentName : DestinationTree : DocAve.API.Migrat ion.exchangepubli cfoldermigration. ExchangePublicFol dermigrationdesti nationtree DestinationFarmName : DestinationSPSitesGroupName : DestinationAgentGroupName : MigrationDatabaseName : Schedules : {} UseSpecifiedMigrationDatabaseToStoreTheJobData : False Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} This command gets a blank Exchange Public Folder online migration plan that has no plan settings configured. Related Links New-DAExchangePublicFolderMigrationOnlinePlan 273

274 New-DAExchangePublicFolderMigrationOnlinePlan Creates a new Exchange Public Folder online migration plan. Syntax New-DAExchangePublicFolderMigrationOnlinePlan [-Plan] <ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>] The New-DAExchangePublicFolderMigrationOnlinePlan cmdlet creates a new Exchange Public Folder online migration plan. 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' 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" 274

275 PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true 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, " "") PS C:\>$plan.SourceTree.Include($sourceNode) PS C:\>$plan.DestinationTree.SelectSPObject($destinationNode) PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$schedule1 = new-object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangePublicFolde rmigrationschedule PS C:\>$schedule1.JobOption = "Full" PS C:\>$schedule1.ConflictResolution = "Skip" PS C:\>$schedule1.StartTime = " :00" 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 = new-object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangePublicFolde rmigrationschedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" 275

276 PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan These commands show how to create an Exchange Public Folder online migration plan by getting a blank plan. Example 2 PS C:\>$plan = Get-DAExchangePublicFolderMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' 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" PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$sourceNode = New-Object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangeFolder("Mai lfolder1") PS C:\>$destinationNode = New-Object DocAve.API.Objects.SharePointOnlineWeb 'Default_SharePoint Sites_Group', ' '' PS C:\>$plan.SourceTree.Include($sourceNode) PS C:\>$plan.DestinationTree.SelectSPOnlineObject($destinationNode) PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$schedule1 = new-object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangePublicFolde rmigrationschedule 276

277 PS C:\>$schedule1.JobOption = "Full" PS C:\>$schedule1.ConflictResolution = "Skip" PS C:\>$schedule1.StartTime = " :00" 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 = new-object DocAve.API.Migration.ExchangePublicFolderMigration.ExchangePublicFolde rmigrationschedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan 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 Update-DAExchangePublicFolderMigrationOnlinePlan Remove-DAExchangePublicFolderMigrationOnlinePlan 277

278 Update-DAExchangePublicFolderMigrationOnlinePlan Updates an existing Exchange Public Folder online migration plan. Syntax Update-DAExchangePublicFolderMigrationOnlinePlan [-Plan] <ExchangePublicFolderMigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' 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" 278

279 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, " "") PS C:\>$plan.SourceTree.Include($sourceNode) PS C:\>$plan.DestinationTree.SelectSPObject($destinationNode) PS C:\>Update-DAExchangePublicFolderMigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified Exchange Public Folder online migration plan. Related Links Get-DAExchangePublicFolderMigrationOnlinePlan Remove-DAExchangePublicFolderMigrationOnlinePlan New-DAExchangePublicFolderMigrationOnlinePlan Remove-DAExchangePublicFolderMigrationOnlinePlan Deletes the specified Exchange Public Folder online migration plan. Syntax Remove-DAExchangePublicFolderMigrationOnlinePlan [-Name] <String> [- WhatIf] [-Confirm] [<CommonParameters>] The Remove-DAExchangePublicFolderMigrationOnlinePlan cmdlet deletes the specified Exchange Public Folder online migration plan. Parameters -Name<String> Specifies the name of an Exchange Public Folder online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] 279

280 false named false false -Confirm[<SwitchParameter>] false named false false <CommonParameters> Examples PS C:\>Remove-DAExchangePublicFolderMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DAExchangePublicFolderMigrationOnlinePlan Update-DAExchangePublicFolderMigrationOnlinePlan New-DAExchangePublicFolderMigrationOnlinePlan Run-DAExchangePublicFolderMigrationOnlineJob Runs an Exchange Public Folder online migration plan. Syntax Run-DAExchangePublicFolderMigrationOnlineJob [-PlanName] <String> - Options <String> -ConflictResolution <ExchangePublicFolderMigrationConflictResolution> [-TestRun] [- RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-WaitForJobComplete] [<CommonParameters>] 280

281 The Run-DAExchangePublicFolderMigrationOnlineJob cmdlet runs an Exchange Public Folder online migration plan. Parameters -PlanName<String> Specifies the name of an existing Exchange Public Folder online migration plan that you want to run. true 0 true (ByValue) false -Options<String> 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> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "MergeAndSkip", "MergeAndOverwrite". true named false false -TestRun[<SwitchParameter>] Specifies whether to simulate the execution of the selected plan. false 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>] 281

282 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 -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DAExchangePublicFolderMigrationOnlineJob -PlanName 'plan1' -Options Incremental -ConflictResolution Skip -WaitForJobComplete - RemigrateObjectsWithException -IgnoreMetadataAndSecurityExceptions ID PlanName Module Status : LM : plan1 : ExchangePublicFolderMigration : Finished StartTime : 9/10/ :55:36 PM FinishTime : 9/10/2012 1:19:44 PM Progress : 100 This command runs the specified Exchange Public Folder online migration plan in full. 282

283 Related Links Get-DAExchangePublicFolderMigrationOnlinePlan Download- DAExchangePublicFolderMigrationOnlineMappingOptionsProfile Downloads the Mapping Options profile of the Exchange Public Folder online migration. Syntax Download-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [- Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> 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. false named false false <CommonParameters> 283

284 Examples PS C:\>Download- DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite 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 Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the Exchange Public Folder online migration. Syntax Upload-DAExchangePublicFolderMigrationOnlineMappingOptionsProfile [- Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> 284

285 Examples PS C:\>Upload- DAExchangePublicFolderMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Mapping 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>] 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. Parameters -Name<String> Specifies the profile name. true 0 false false -Path<String> Specifies the path to store the downloaded XML file. 285

286 true 1 false false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Download- DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite 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 Uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Exchange Public Folder online migration. Syntax Upload-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile [- Path] <String> [-Overwrite] [<CommonParameters>] 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. 286

287 Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload- DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Exchange Public Folder online migration. Related Links Download-DAExchangePublicFolderMigrationOnlineMigrationOptionsProfile EMC Documentum Migration Refer to the following sections for more information. Get-DADocumentumMigrationOnlinePlan Gets the plan settings of the specified Documentum online migration plans. 287

288 Syntax Get-DADocumentumMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DADocumentumMigrationOnlinePlan cmdlet gets the configurations of the specified Documentum online migration plans. Parameters -Name<String[]> 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 0 true (ByValue, ByPropertyName) <CommonParameters> false Examples PS C:\>Get-DADocumentumMigrationOnlinePlan -Name 'plan01' SourceTree : DocAve.API.Migrat ion.documentummig ration.documentum MigrationSourceTr ee ConnectionName SourceAgentName 288 : emc connection : agent-emc

289 DestinationFarmName : Farm(SP2010_DB:SH AREPOINT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C ONFIG) DestinationTree : DocAve.API.Migrat ion.documentummig ration.documentum MigrationDestinat iontree MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : plan01 : ProfileName NotificationName AssociatedPlanGroup : Default Profile : Notification1 : {PlanGroup1} This command gets the plan settings of the specified plan. Related Links New-DADocumentumMigrationOnlinePlan Update-DADocumentumMigrationOnlinePlan Remove-DADocumentumMigrationOnlinePlan 289

290 Get-DADocumentumMigrationBlankOnlinePlan Gets a blank Documentum online migration plan with no plan settings configured. Syntax Get-DADocumentumMigrationBlankOnlinePlan [<CommonParameters>] The Get-DADocumentumMigrationBlankOnlinePlan cmdlet gets a blank Documentum online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DADocumentumMigrationBlankOnlinePlan PS C:\>$plan SourceTree : DocAve.API.Migrat ion.documentummig ration.documentum MigrationSourceTr ee ConnectionName : SourceAgentName : DestinationFarmName : DestinationSPSitesGroupName : DestinationAgentGroupName : 290

291 DestinationTree : DocAve.API.Migrat ion.documentummig ration.documentum MigrationDestinat iontree MigrationDatabaseName : UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} 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>] The New-DADocumentumMigrationOnlinePlan cmdlet creates a new Documentum online migration plan. Parameters -Plan<DocumentumMigrationOnlinePlan> 291

292 Specifies a Documentum online migration plan object. About the structure and attributes of DocumentumMigrationOnlinePlan, refer to the SDK Documentation for more information. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DADocumentumMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = 'this is a documentum plan' PS C:\>$plan.ConnectionName = 'emc connection' PS C:\>$cabinet1 = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumCabinet('cabinet1') PS C:\>$cabinet2 = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumCabinet('cabinet2') PS C:\>$folder = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumFolder('cabinet1/fo lder1') PS C:\>$plan.SourceTree.Include($cabinet1) PS C:\>$plan.SourceTree.Include($cabinet2) PS C:\>$plan.SourceTree.Exclude($folder) PS C:\>$webapp10 = New-Object DocAve.API.Objects.SharePointWebApplication('Farm(SP2010_DB:SHAREPOINT _CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($webapp10) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') 292

293 PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$scheduleForIncrementalJob = New-Object 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.StartTime = ' :53' PS C:\>$scheduleForIncrementalJob.EndTime = ' :00' PS C:\>$plan.Schedules.Add($scheduleForIncrementalJob) PS C:\>New-DADocumentumMigrationOnlinePlan -Plan $plan These commands create a Documentum online migration plan. Example 2 PS C:\>$plan = Get-DADocumentumMigrationOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = 'this is a documentum plan' PS C:\>$plan.ConnectionName = 'emc connection' PS C:\>$cabinet1 = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumCabinet('cabinet1') PS C:\>$cabinet2 = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumCabinet('cabinet2') PS C:\>$folder = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumFolder('cabinet1/fo lder1') PS C:\>$plan.SourceTree.Include($cabinet1) PS C:\>$plan.SourceTree.Include($cabinet2) PS C:\>$plan.SourceTree.Exclude($folder) 293

294 PS C:\>$onlineWeb = New-Object DocAve.API.Objects.SharePointOnlineWeb('Farm(SP2010_DB:SHAREPOINT_CONF IG)',' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($onlineWeb) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') PS C:\>$plan.UseSpecifiedMigrationDatabaseToStoreTheJobData = $true PS C:\>$plan.NotificationName = 'Notification1' PS C:\>New-DADocumentumMigrationOnlinePlan -Plan $plan These commands show how to create a documentum online migration plan. And the destination is from registered sites. Related Links Get-DADocumentumMigrationBlankOnlinePlan Update-DADocumentumMigrationOnlinePlan Remove-DADocumentumMigrationOnlinePlan Update-DADocumentumMigrationOnlinePlan Updates an existing Documentum online migration plan. Syntax Update-DADocumentumMigrationOnlinePlan [-Plan] <DocumentumMigrationOnlinePlan> [<CommonParameters>] Specifies an existing Documentum online migration plan you are about to update. Parameters -Plan<DocumentumMigrationOnlinePlan> Specifies an existing Documentum online migration plan for editing. true 0 true (ByValue) false <CommonParameters> 294

295 Examples PS C:\>$plan = Get-DADocumentumMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = 'this is a documentum plan' PS C:\>$plan.ConnectionName = 'emc connection' PS C:\>$virtualDocument = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumVirtualDocument('Ca binet01','09de75d ') PS C:\>$snapshot = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumSnapShot('Cabinet01 ','09de75d ') PS C:\>$simpleDocument = New-Object DocAve.API.Migration.DocumentumMigration.DocumentumSimpleDocument('Cab inet01','09de75d ') PS C:\>$plan.SourceTree.Include($virtualDocument) PS C:\>$plan.SourceTree.Include($snapshot) PS C:\>$plan.SourceTree.Include($simpleDocument) PS C:\>$list = New-Object DocAve.API.Objects.SharePointList 'Farm(SQL:SHAREPOINT_CONFIG)', ' '', 'shared documents' PS C:\>$plan.DestinationTree.SelectSPObject($list) PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.AssociatedPlanGroup.Add('plan01') PS C:\>Update-DAEMCDocumentumMigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified Documentum online migration plan. 295

296 Related Links Get-DADocumentumMigrationOnlinePlan New-DADocumentumMigrationOnlinePlan Remove-DADocumentumMigrationOnlinePlan Remove-DADocumentumMigrationOnlinePlan Deletes the specified Documentum online migration plan. Syntax Remove-DADocumentumMigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DADocumentumMigrationOnlinePlan cmdlet deletes the specified Documentum online migration plan. Parameters -Name<String> Specifies the name of a Documentum online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> 296

297 Examples PS C:\>Remove-DADocumentumMigrationOnlinePlan -Name 'plan1' This command deletes the specified Documentum online migration plan. Related Links Get-DADocumentumMigrationOnlinePlan Update-DADocumentumMigrationOnlinePlan New-DADocumentumMigrationOnlinePlan Run-DADocumentumMigrationOnlineJob Runs a Documentum online migration plan. Syntax Run-DADocumentumMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <DocumentumMigrationConflictResolution> [-RemigrateObjectsWithException] [- IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DADocumentumMigrationOnlineJob cmdlet runs a Documentum online migration plan. Parameters -PlanName<String> Specifies the name of an existing Documentum online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental". true named false false -ConflictResolution<DocumentumMigrationConflictResolution> 297

298 Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". 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>] 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 -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> 298

299 Examples PS C:\>Run-DADocumentumMigrationOnlineJob -PlanName 'plan1' -Options Full -ConflictResolution Skip -IgnoreMetadataAndSecurityExceptions ID PlanName Module Status : MC : plan1 : DocumentumMigration : waiting StartTime : 8/22/2013 5:46:46 PM FinishTime : 8/22/2013 5:46:46 PM Progress : 0 This command runs the specified Documentum online migration plan in full. Related Links Get-DADocumentumMigrationOnlinePlan Download-DADocumentumMigrationOnlineMappingOptionsProfile Downloads the Mapping Options profile of the Documentum online Migration. Syntax Download-DADocumentumMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. 299

300 Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DADocumentumMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Mapping Options profile of the documentum online migration to an XML file in the specified local path. Related Links Upload-DADocumentumMigrationOnlineMappingOptionsProfile Upload-DADocumentumMigrationOnlineMappingOptionsProfile Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the Documentum online migration. 300

301 Syntax Upload-DADocumentumMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DADocumentumMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the Documentum online migration. Related Links Download-DADocumentumMigrationOnlineMappingOptionsProfile 301

302 Download-DADocumentumMigrationOnlineMigrationOptionsProfile Downloads the Migration Options profile of the documentum online migration. Syntax Download-DADocumentumMigrationOnlineMigrationOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> 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. false named false false <CommonParameters> Examples PS C:\>Download-DADocumentumMigrationOnlineMigrationOptionsProfile - Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite 302

303 This command downloads the Migration Options profile of the documentum online migration to an XML file in the specified local path. Related Links Upload-DADocumentumMigrationOnlineMigrationOptionsProfile Upload-DADocumentumMigrationOnlineMigrationOptionsProfile Uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Documentum online migration. Syntax Upload-DADocumentumMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples 303

304 PS C:\>Upload-DADocumentumMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite This command uploads the specified XML file from the local path to the Manager as the Migration Options profile of the documentum online migration. Related Links Download-DADocumentumMigrationOnlineMigrationOptionsProfile Quickr Migration Refer to the following sections for more information. Get-DAQuickrMigrationOnlinePlan Gets the plan settings of the specified Quickr online migration plans. Syntax Get-DAQuickrMigrationOnlinePlan [[-Name] <String[]>] [<CommonParameters>] The Get-DAQuickrMigrationOnlinePlan cmdlet gets the configurations of the specified Quickr online migration plans. Parameters -Name<String[]> 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 0 true (ByValue, ByPropertyName) <CommonParameters> false 304

305 Examples PS C:\>Get-DAQuickrMigrationOnlinePlan -Name 'plan1' UseSpecifiedMigrationDatabaseToStoreTheJobData : True Schedules : {} MigrationDatabaseName DestinationTree : MigrationDatabase : DocAve.API.Migrat ion.quickrmigrati on.quickrmigratio ndestinationtree DestinationFarmName : Farm(SP2010_DB:SH AREPOINT_CONFIG) DestinationSPSitesGroupName : DestinationAgentGroupName : DEFAULT_AGENT_GRO UP_FOR_Farm(SP201 0_DB:SHAREPOINT_C ONFIG) SourceTree : DocAve.API.Migrat ion.quickrmigrati on.quickrmigratio nsourcetree SourceAgentName : Agent-QuickrMigra tion ConnectionName : Connection-Quickr Migration 305

306 QuickrServerName Name ProfileName : QuickrServer : plan1 : Descritpion : Default Profile NotificationName : AssociatedPlanGroup : {} This command gets the plan settings of the specified plan. Related Links New-DAQuickrMigrationOnlinePlan Update-DAQuickrMigrationOnlinePlan Get-DAQuickrMigrationBlankOnlinePlan Gets a blank Quickr online migration plan without any plan settings. Syntax Get-DAQuickrMigrationBlankOnlinePlan [<CommonParameters>] The Get-DAQuickrMigrationBlankOnlinePlan cmdlet gets a blank Quickr online migration plan for creating a new plan. Parameters <CommonParameters> Examples PS C:\>$plan = Get-DAQuickrMigrationBlankOnlinePlan PS C:\>$plan 306

307 UseSpecifiedMigrationDatabaseToStoreTheJobData : False Schedules : {} MigrationDatabaseName : DestinationTree : DocAve.API.Migra tion.quickrmigra tion.quickrmigra tiondestinationt ree DestinationFarmName : DestinationSPSitesGroupName : DestinationAgentGroupName : SourceTree : DocAve.API.Migra tion.quickrmigra tion.quickrmigra tionsourcetree SourceAgentName : ConnectionName : QuickrServerName : Name : : ProfileName : NotificationName : AssociatedPlanGroup : {} This command gets a blank Quickr online migration plan that has no plan settings configured. Related Links New-DAQuickrMigrationOnlinePlan 307

308 New-DAQuickrMigrationOnlinePlan Creates a new Quickr online migration plan. Syntax New-DAQuickrMigrationOnlinePlan [-Plan] <QuickrMigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$plan = Get-DAQuickrMigrationBlankOnlinePlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB :SHAREPOINT_CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($site1) PS C:\>$plan.SetSourceInformation('Connection-QuickrMigration', 'QuickrServer') 308

309 PS C:\>$QuickrObject = New-Object DocAve.API.Migration.QuickrMigration.QuickrMigrationPlace("QuickPlace/ Place1/Main.nsf") PS C:\>$plan.SourceTree.Include($QuickrObject) PS C:\>$schedule1 = new-object DocAve.API.Migration.QuickrMigration.QuickrMigrationSchedule PS C:\>$schedule1.JobOption = "Full" PS C:\>$schedule1.ConflictResolution = "Skip" PS C:\>$schedule1.StartTime = " :00" 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 = new-object DocAve.API.Migration.QuickrMigration.QuickrMigrationSchedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DAQuickrMigrationOnlinePlan -Plan $plan These commands create a Quickr online migration plan. Example 2 PS C:\>$plan = Get-DAQuickrMigrationBlankOnlinePlan 309

310 PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$destinationNode = New-Object DocAve.API.Objects.SharePointOnlineWeb 'Default_SharePoint Sites_Group', ' '' PS C:\>$plan.DestinationTree.SelectSPOnlineObject($destinationNode) PS C:\>$plan.SetSourceInformation('Connection-QuickrMigration', 'QuickrServer') PS C:\>$QuickrObject = New-Object DocAve.API.Migration.QuickrMigration.QuickrMigrationPlace("QuickPlace/ Place1/Main.nsf") PS C:\>$plan.SourceTree.Include($QuickrObject) PS C:\>$schedule1 = new-object DocAve.API.Migration.QuickrMigration.QuickrMigrationSchedule PS C:\>$schedule1.JobOption = "Full" PS C:\>$schedule1.ConflictResolution = "Skip" PS C:\>$schedule1.StartTime = " :00" 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 = new-object DocAve.API.Migration.QuickrMigration.QuickrMigrationSchedule PS C:\>$schedule2.JobOption = "Incremental" PS C:\>$schedule2.ConflictResolution = "Skip" PS C:\>$schedule2.StartTime = " :00" 310

311 PS C:\>$schedule2.TimeZoneId = "Pacific Standard Time" PS C:\>$schedule2.AutoAdjustForDST = $true PS C:\>$schedule2.Interval = "1day" PS C:\>$schedule2.EndTime = " :00" PS C:\>$plan.Schedules.Add($schedule2) PS C:\>New-DAQuickrMigrationOnlinePlan -Plan $plan These commands show how to create a Quickr online migration plan. The destination is from My Registered Sites. Related Links Get-DAQuickrMigrationBlankOnlinePlan Update-DAQuickrMigrationOnlinePlan Get-DAQuickrMigrationOnlinePlan Update-DAQuickrMigrationOnlinePlan Updates an existing Quickr online migration plan. Syntax Update-DAQuickrMigrationOnlinePlan [-Plan] <QuickrMigrationOnlinePlan> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> 311

312 Examples PS C:\>$plan = Get-DAQuickrMigrationOnlinePlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>$plan. = '' PS C:\>$plan.ProfileName = 'Default Profile' PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite('Farm(SP2010_DB :SHAREPOINT_CONFIG)',' PS C:\>$plan.DestinationTree.SelectSPObject($site1) PS C:\>$plan.SetSourceInformation('Connection-QuickrMigration', 'QuickrServer') PS C:\>$QuickrObject = New-Object DocAve.API.Migration.QuickrMigration.QuickrMigrationPlace("QuickPlace/ Place1/Main.nsf") PS C:\>$plan.SourceTree.Include($QuickrObject) PS C:\>Update-DAQuickrMigrationOnlinePlan -Plan $plan These commands update the plan settings of the specified Quickr online migration plan. Related Links Get-DAQuickrMigrationOnlinePlan New-DAQuickrMigrationOnlinePlan Remove-DAQuickrMigrationOnlinePlan Deletes the specified Quickr online migration plan. Syntax Remove-DAQuickrMigrationOnlinePlan [-Name] <String> [-WhatIf] [- Confirm] [<CommonParameters>] The Remove-DAQuickrMigrationOnlinePlan deletes the specified Quickr online migration plan. 312

313 Parameters -Name<String> Specifies the name of a Quickr online migration plan that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DAQuickrMigrationOnlinePlan -Name 'plan1' This command deletes the specified plan. Related Links Get-DAQuickrMigrationOnlinePlan Update-DAQuickrMigrationOnlinePlan New-DAQuickrMigrationOnlinePlan Run-DAQuickrMigrationOnlineJob Runs a Quickr online migration plan. 313

314 Syntax Run-DAQuickrMigrationOnlineJob [-PlanName] <String> -Options <String> -ConflictResolution <QuickrMigrationConflictResolution> [- RemigrateObjectsWithException] [-IgnoreMetadataAndSecurityExceptions] [-TestRun] [-WaitForJobComplete] [<CommonParameters>] The Run-DAQuickrMigrationOnlineJob cmdlet runs a Quickr online migration plan. Parameters -PlanName<String> Specifies the name of an existing Quickr online migration plan that you want to run. true 0 true (ByValue) false -Options<String> Specifies to run a full or an incremental migration job of the selected migration plan. Valid values are "Full" and "Incremental". true named false false -ConflictResolution<QuickrMigrationConflictResolution> Specifies a conflict resolution to handle conflicts occurred during migration. The valid values are "Skip", "SkipAndSkip", "SkipAndOverwrite", "SkipAndAppend", "MergeAndSkip", "MergeAndOverwrite" and "MergeAndAppend". 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>] 314

315 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>] Specifies whether to simulate the execution of the selected plan. false named false false -WaitForJobComplete[<SwitchParameter>] Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job can be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job. false named false false <CommonParameters> Examples PS C:\>Run-DAQuickrMigrationOnlineJob -PlanName 'plan1' -Options Incremental -ConflictResolution MergeAndAppend -RemigrateObjectsWit hexception -IgnoreMetadataAndSecurityExceptions -WaitForJobComplete ID PlanName Module Status : QM : plan1 : QuickrMigration : Finished StartTime : 8/13/2013 4:27:51 PM 315

316 FinishTime : 8/13/2013 4:28:43 PM Progress : 100 This command runs the specified Quickr online migration plan in incremental. Related Links Get-DAQuickrMigrationOnlinePlan Download-DAQuickrMigrationOnlineMappingOptionsProfile Downloads the Mapping Options profile of the Quickr online migration. Syntax Download-DAQuickrMigrationOnlineMappingOptionsProfile [-Name] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> 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. false named false false <CommonParameters> 316

317 Examples PS C:\>Download-DAQuickrMigrationOnlineMappingOptionsProfile -Name 'mappingoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Mapping Options profile of the Quickr online migration to an XML file in the specified local path. Related Links Upload-DAQuickrMigrationOnlineMappingOptionsProfile Upload-DAQuickrMigrationOnlineMappingOptionsProfile Uploads the specified XML file from the local path to the Manager as the Mapping Options profile of the Quickr online migration. Syntax Upload-DAQuickrMigrationOnlineMappingOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false 317

318 <CommonParameters> Examples PS C:\>Upload-DAQuickrMigrationOnlineMappingOptionsProfile -Path 'C:\mappingOptionsProfile.xml' -Overwrite 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] <String> [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Name<String> Specifies the profile name. true 0 false false -Path<String> Specifies the path to store the downloaded XML file. 318

319 true 1 false false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Download-DAQuickrMigrationOnlineMigrationOptionsProfile -Name 'migrationoptionsprofile' -Path 'C:\profile.xml' -Overwrite This command downloads the Migration Options profile of the Quickr online migration to an XML file in the specified local path. Related Links Upload-DAQuickrMigrationOnlineMigrationOptionsProfile Upload-DAQuickrMigrationOnlineMigrationOptionsProfile Uploads the specified XML file from the local path to the Manager as the Migration Options profile of the Quickr online migration. Syntax Upload-DAQuickrMigrationOnlineMigrationOptionsProfile [-Path] <String> [-Overwrite] [<CommonParameters>] 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. Parameters -Path<String> 319

320 Specifies the path of the XML file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing profile. false named false false <CommonParameters> Examples PS C:\>Upload-DAQuickrMigrationOnlineMigrationOptionsProfile -Path 'C:\migrationOptionsProfile.xml' -Overwrite online migration. Related Links Download-DAQuickrMigrationOnlineMigrationOptionsProfile Granular Backup and Restore Refer to the following sections for more information. Get-DAGranularBackupPlan Gets the Granular Backup plan(s). Syntax Get-DAGranularBackupPlan [[-Name] <String[]>] [<CommonParameters>] 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. 320

321 Parameters -Name<String[]> Specifies one or more plans' names. You can type multiple plan names (separated by commas). Wildcards are supported. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>$plan = Get-DAGranularBackupPlan -Name 'plan1' PS C:\>$plan Name FarmName : plan1 : Farm(SP2010_DB:SHAREPOINT_CONFIG) : RestoreLevel StoragePolicyName DataCompressionType DataCompressionMethod DataEncryption SecurityProfile : ItemLevel : storagepolicy : None : None : SharePointAgent : DocAveDefaultProfile AgentGroupName : DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG) IncludeWorkflowDefinition : False 321

322 IncludeWorkflowInstance IncludeUserProfile Tree : False : True : DocAve.API.Objects.SharePointTree PS C:\>$includedSPObjects = $plan.tree.getincludedspobject() PS C:\>$includedSPObjects ForEach-Object -Process {$_.ToString()} Web application: Farm(SP2010_DB:SHAREPOINT_CONFIG), Site collection: Farm(SP2010_DB:SHAREPOINT_CONFIG), Site: Farm(SP2010_DB:SHAREPOINT_CONFIG), /sites/site1 List: Farm(SP2010_DB:SHAREPOINT_CONFIG), /sites/site1, Shared Documents Folder: Farm(SP2010_DB:SHAREPOINT_CONFIG), /sites/site1, Shared Documents, Folder1 This command retrieves the plan named 'plan1'. Related Links New-DAGranularBackupPlan Remove-DAGranularBackupPlan Update-DAGranularBackupPlan Get-DAGranularBackupBlankPlan Gets a blank Granular Backup plan. 322

323 Syntax Get-DAGranularBackupBlankPlan [<CommonParameters>] The Get-DAGranularBackupBlankPlan cmdlet gets a blank plan with the default settings and then you can configure it to create a plan. Parameters <CommonParameters> Examples PS C:\>Get-DAGranularBackupBlankPlan Name : FarmName : : RestoreLevel : ItemLevel StoragePolicyName : DataCompressionType DataCompressionMethod DataEncryption : None : None : None SecurityProfile : AgentGroupName : IncludeWorkflowDefinition : False IncludeWorkflowInstance IncludeUserProfile : False : False NotificationName : 323

324 Tree : This command retrieves a blank plan. Related Links New-DAGranularBackupPlan New-DAGranularBackupPlan Creates a new Granular Backup plan. Syntax New-DAGranularBackupPlan [-Plan] <GranularBackupPlan> [<CommonParameters>] 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 PS C:\>$plan = Get-DAGranularBackupBlankPlan PS C:\>$plan.Name = 'plan1' PS C:\>$plan. = 'description' PS C:\>$plan.StoragePolicyName = 'storage policy1' 324

325 PS C:\>$plan.AgentGroupName = "DEFAULT_AGENT_GROUP_FOR_Farm(SP2010_DB:SHAREPOINT_CONFIG)" PS C:\>$plan.NotificationName = 'Notification1' PS C:\>$site1 = New-Object DocAve.API.Objects.SharePointSite ('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 = " :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 = " :00" PS C:\>$incrementalJobSchedule.TimeZoneId = "Pacific Standard Time" PS C:\>$incrementalJobSchedule.AutoAdjustForDST = true PS C:\>$incrementalJobSchedule.Interval = "2D" PS C:\>$incrementalJobSchedule.EndTime = " :00" PS C:\>$plan.Schedules.Add($incrementalJobSchedule) PS C:\>New-DAGranularBackupPlan -Plan $plan 325

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 Get-DAGranularBackupPlan Remove-DAGranularBackupPlan Update-DAGranularBackupPlan Update-DAGranularBackupPlan Updates the Granular Backup plan. Syntax Update-DAGranularBackupPlan [-Plan] <GranularBackupPlan> [<CommonParameters>] The Update-DAGranularBackupPlan cmdlet updates an existing Granular Backup plan. Parameters -Plan<GranularBackupPlan> Specifies a Granular Backup plan object. true 0 false false <CommonParameters> Examples PS C:\>$plan = Get-DAGranularBackupPlan -Name 'plan1' PS C:\>$plan.Name = 'plan2' PS C:\>Update-DAGranularBackupPlan -Plan $plan 326

327 These commands show how to change the plan name from 'plan1' to 'plan2'. Related Links New-DAGranularBackupPlan Get-DAGranularBackupPlan Remove-DAGranularBackupPlan Remove-DAGranularBackupPlan Removes the specified Granular Backup plan. Syntax Remove-DAGranularBackupPlan [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>] The Remove-DAGranularBackupPlan cmdlet removes the specified Granular Backup plan. Parameters -Name<String> Specifies the name of plan to be removed. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> 327

328 Examples PS C:\>Remove-DAGranularBackupPlan -Name 'plan1' This command removes a Granular Backup plan named plan1. Related Links Get-DAGranularBackupPlan Update-DAGranularBackupPlan New-DAGranularBackupPlan Run-DAGranularBackupJob Runs Granular Backup job. Syntax Run-DAGranularBackupJob [-PlanName] <String> -BackupJobType <RunGranularBackupPlanType> -JobReportType <String> [-TestRun] [- WaitForJobComplete] [<CommonParameters>] The Run-DAGranularBackupJob cmdlet runs Granular Backup job. Parameters -PlanName<String> Specifies the plan name, the job will run based on the plan. true 0 false false -BackupJobType<RunGranularBackupPlanType> Specifies the type of backup. Valid values are "Full", "Incremental" and "Differential". 328 true named false false

329 -JobReportType<String> Specifies the job report level. Valid values are "Simplified" and "Detailed". true named false false -TestRun[<SwitchParameter>] Whether to run the test job. false named false false -WaitForJobComplete[<SwitchParameter>] 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. false named false false <CommonParameters> Examples PS C:\>Run-DAGranularBackupJob -PlanName 'plan1' -BackupJobType full - JobReportType Detailed -WaitForJobComplete ID PlanName Module Status : FB : plan1 : GranularBackup : Finished StartTime : 7/10/2012 3:03:49 PM FinishTime : 7/10/2012 3:08:54 PM Progress :

330 This command runs Granular Backup job based on plan1. Related Links Platform Backup and Restore Refer to the following sections for more information. Run-DAPlatformBackupJob Runs Platform Backup job. Syntax Run-DAPlatformBackupJob [-PlanName] <String> -BackupType <PRBackupType> [-CopyDataFromSnapshotToMediaServer] [- DeferCopyingDataFromPersistentSnapshot] [- DeferGeneratingInstaMountMapping] -RestoreGranularityLevel <PlatformRestoreGranularityLevel> [- DeferGeneratingGranularRestoreIndex] [-WaitForJobComplete] [<CommonParameters>] Run-DAPlatformBackupJob [-PlanName] <String> [-FullJobConfiguration] <PlatformBackupFullJobConfiguration> [-WaitForJobComplete] [<CommonParameters>] Run-DAPlatformBackupJob [-PlanName] <String> [- DifferentialJobConfiguration] <PlatformBackupDifferentialJobConfiguration> [-WaitForJobComplete] [<CommonParameters>] Run-DAPlatformBackupJob [-PlanName] <String> [- IncrementalJobConfiguration] <PlatformBackupIncrementalJobConfiguration> [-WaitForJobComplete] [<CommonParameters>] The Run-DAplatformBackupJob cmdlet runs a Platfrom Backup job based on the specified plan. Parameters -PlanName<String> Specifies the plan name, the job will run based on the plan. 330

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. false named false false -WaitForJobComplete[<SwitchParameter>] 331

332 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. 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. true 1 false false <CommonParameters> Examples PS C:\>$FullJobConfiguration = New-Object DocAve.API.DataProtection.PlatformBackupAndRestore.PlatformBackupFullJ obconfiguration PS C:\>$FullJobConfiguration.TransferDataFromSnapshotToMediaServer = $True 332

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 PlanName Module Status : FB : plan1 : PlatformBackup : Finished StartTime : 7/10/2012 3:03:49 PM FinishTime : 7/10/2012 3:08:54 PM Progress : 100 This command runs a platform backup job based on plan1. Example 2 PS C:\>$DifferentialJobConfiguration = New-Object DocAve.API.DataProtection.PlatformBackupAndRestore.PlatformBackupDiffe rentialjobconfiguration 333

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 PlanName Module Status : FB : plan1 : PlatformBackup : Finished StartTime : 8/11/2012 3:03:49 PM FinishTime : 8/11/2012 3:08:54 PM Progress : 100 This command runs a platform backup job based on plan1. 334

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 PlanName Module Status : FB : plan1 : PlatformBackup : Finished StartTime : 7/11/2012 3:03:49 PM FinishTime : 7/11/2012 3:08:54 PM Progress : 100 This command runs a platform backup job based on plan1. Related Links 335

336 Obtain a Date Time Object Refer to the following sections for more information. 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>] 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 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. true 3 false false <CommonParameters> 336

337 Examples PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>Get-DADate -Year Month 03 -Day 20 -TimeZoneId $TimeZoneID Year : 2012 Month : 3 Day : 20 TimeZone : DocAve.API.Common.TimeZoneInfo AutomaticallyAdjustClockForDaylightSavingTime : False 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> [<CommonParameters>] 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. 337

338 Parameters -Year<Int32> Specifies the year that is displayed. Valid value is between 1 and 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. true 5 false false <CommonParameters> 338

339 Examples PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime PS C:\>Get-DADateTime -Year 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 This command shows how to get DateTime instance. Related Links Get-DADate Agent Monitor Refer to the following sections for more information. Get-DAAgentService Gets the Agent services. Syntax Get-DAAgentService [[-Name] <String[]>] [<CommonParameters>] The Get-DAAgentService cmdlet gets the Agent services. 339

340 Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DAAgentService Name Status AccountName agent1 mydomain\account1 agent2 mydomain\account2 agent3 mydomain\account3 Down Up Down This command gets the Agent services. Related Links Update-DAAgentService Updates an existing Agent service. 340

341 Syntax Update-DAAgentService [-AgentService] <AgentService> [<CommonParameters>] The Update-DAAgentService cmdlet updates an existing Agent service. Parameters -AgentService<AgentService> Specifies an Agent service for updating. true 0 true (ByValue, ByPropertyName) <CommonParameters> false Examples 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 These commands update the account settings of the specified Agent service. Related Links Account Manager Refer to the following sections for more information. 341

342 Get-DALocalUser Gets the information of the existing local user(s). Syntax Get-DALocalUser [[-Name] <String[]>] [<CommonParameters>] The Get-DALocalUser cmdlet gets the information of the existing local user(s). Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DALocalUser Name user1 : [email protected] Password : SecuritySettings : DocAve.API.ControlPanel.AccountManager.SecuritySettings SecuritySettingsType : Customized Type 342 : Local User

343 Mode UserGroupType : this is a user. : Active : System Group SystemGroups : {system group 01} TenantGroup : InAdministratorsGroup : False 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>] The Get-DABlankLocalUser cmdlet gets a blank local user for adding a new local user. Parameters <CommonParameters> Examples PS C:\>Get-DABlankLocalUser Name : 343

344 Password : SecuritySettings : DocAve.API.ControlPanel.AccountManager.SecuritySettings SecuritySettingsType : Default Type : Local User : Mode : Unknown UserGroupType : SystemGroups : {} TenantGroup : InAdministratorsGroup : False 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>] The Get-DAActiveDirectoryUser cmdlet gets the information of the existing active directory user(s). Parameters -Name<String[]> 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. 344

345 false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>$user = Get-DAActiveDirectoryUser PS C:\>$user Name Type : example.com\user1 : [email protected] : Active Directory User : Mode UserGroupType : Active : System Group SystemGroups : {system group 01} TenantGroup : InAdministratorsGroup : False This command gets the information of all the existing active directory users. Related Links Update-DAUser Get-DABlankActiveDirectoryUser Gets a blank active directory user for creating an AD user. 345

346 Syntax Get-DABlankActiveDirectoryUser [<CommonParameters>] The Get-DABlankActiveDirectoryUser cmdlet gets a blank active directory user for creating an AD user. Parameters <CommonParameters> Examples PS C:\>Get-DABlankActiveDirectoryUser Name : Type : Active Directory User : Mode : Unknown UserGroupType : SystemGroups : {} TenantGroup : InAdministratorsGroup : False This command gets a blank active directory user. Related Links New-DAUser 346

347 Get-DAActiveDirectoryGroup Gets the information of the existing active directory group(s). Syntax Get-DAActiveDirectoryGroup [[-Name] <String[]>] [<CommonParameters>] The Get-DAActiveDirectoryGroup cmdlet gets the information of the existing active directory group(s). Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>$user = Get-DAActiveDirectoryGroup PS C:\>$user Name Type Mode : example.com\group1 : [email protected] : Active Directory Group : this is an active directory group. : Active 347

348 UserGroupType : Tenant Group SystemGroups : {} TenantGroup : tenant group 01 InAdministratorsGroup : False This command gets the information of all the existing active directory groups. Related Links Update-DAUser Get-DABlankActiveDirectoryGroup Gets a blank active directory group for creating an AD group. Syntax Get-DABlankActiveDirectoryGroup [<CommonParameters>] The Get-DABlankActiveDirectoryGroup cmdlet gets a blank active directory group for creating an AD group. Parameters <CommonParameters> Examples PS C:\>$user = Get-DABlankActiveDirectoryGroup PS C:\>$user Name : 348

349 Type : Active Directory Group : Mode : Unknown UserGroupType : SystemGroups : {} TenantGroup : InAdministratorsGroup : False This command gets a blank active directory group. Related Links New-DAUser New-DAUser Creates a new user according to the user object that you specified. Syntax New-DAUser [-User] <UserBase> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> 349

350 Examples PS C:\>$user = Get-DABlankLocalUser PS C:\>$user.Name = 'user1' PS C:\>$user. = '[email protected]' PS C:\>$user.Password = Read-Host -AsSecureString ********* PS C:\>$user. = '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 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 These commands create a new active directory user. 350

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>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$user = Get-DALocalUser -Name 'user1' PS C:\>$user. = '[email protected]' PS C:\>Update-DAUser -User $user These commands update the information of the specified local user. 351

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] [<CommonParameters>] The Remove-DAActiveDirectoryGroup cmdlet deletes an existing active directory group according to the group's name. Parameters -Name<String> Specifies the name of an active directory group that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> 352

353 Examples PS C:\>Remove-DAActiveDirectoryGroup -Name 'example.com\group1' 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] [<CommonParameters>] The Remove-DAActiveDirectoryUser cmdlet deletes an existing active directory user according to the user's name. Parameters -Name<String> Specifies the name of an active directory user that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] 353

354 Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DAActiveDirectoryUser 'example.com\user1' 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] [<CommonParameters>] The Remove-DALocalUser cmdlet deletes an existing local user according to the user's name. Parameters -Name<String> Specifies the name of a local user that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. 354

355 false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DALocalUser -Name 'user1' This command deletes the specified local user. Related Links Get-DALocalUser Security Information Manager Refer to the following sections for more information. Backup-DADatabaseEncryptionKey Backs up DocAve database encryption key. Syntax Backup-DADatabaseEncryptionKey [-Path] <String> [-Overwrite] [<CommonParameters>] The Backup-DADatabaseEncryptionKey cmdlet backs up the DocAve database encryption key to a file under the specified path. Parameters -Path<String> 355

356 Specifies a path to store the backup file. true 0 false false -Overwrite[<SwitchParameter>] Overwrites the backup file if it already exists at the specified path. false named false false <CommonParameters> Examples PS C:\>Backup-DADatabaseEncryptionKey -Path 'C:\backup' 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>] 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. Parameters -Path<String> 356

357 Specifies a path to load the backup file. true 0 false false -OutPut<String> Specifies a path to store the output file. true 1 false false -Overwrite[<SwitchParameter>] 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 PS C:\>Restore-DADatabaseEncryptionKey -Path 'C:\backup' -OutPut 'C:\sql' This command shows how to restore DocAve database encryption key. Example 2 357

358 PS C:\>Restore-DADatabaseEncryptionKey -Path 'C:\backup' -OutPut 'C:\sql' -Passphrase passphrase 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] [<CommonParameters>] 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. Parameters -Path<String> Specifies a path to store the backup file. true 0 false false -Overwrite[<SwitchParameter>] Overwrites the backup file if it already exists at the specified path. false named false false <CommonParameters> Examples 358

359 PS C:\>Backup-DADataEncryptionProfile -Path 'C:\backup.zip' 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>] The Restore-DADataEncryptionProfile cmdlet imports the exported DocAve security profiles from the compressed file under the specified path. Parameters -Path<String> Specifies a path to load the backup file. true 0 false false <CommonParameters> Examples PS C:\>Restore-DADataEncryptionProfile -Path 'C:\backup.zip' This command shows how to restore DocAve data encryption profile. Related Links Backup-DADataEncryptionProfile 359

360 Set-DAPassPhrase Sets up a new value for the passphrase. Syntax Set-DAPassPhrase [-PassPhrase] <SecureString> [-ConfirmPassPhrase] <SecureString> [<CommonParameters>] Set-DAPassPhrase [-PassPhrase] <SecureString> [-LocalServerOnly] [<CommonParameters>] 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. false named false false <CommonParameters> 360

361 Examples PS C:\>$passphrase = ConvertTo-SecureString 'PassPhrase' -AsPlainText -Force PS C:\>$ConfirmPassPhrase = ConvertTo-SecureString 'PassPhrase' - AsPlainText -Force PS C:\>Set-DAPassPhrase -PassPhrase $passphrase -ConfirmPassPhrase $ConfirmPassPhrase 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 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>] [<CommonParameters>] Set-DAFipsAlgorithmPolicy [[-Enabled] <SwitchParameter>] [<CommonParameters>] 361

362 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 PS C:\>Set-DAFipsAlgorithmPolicy -Enabled This command shows how to enable the FipsAlgorithmPolicy. Example 2 PS C:\>Set-DAFipsAlgorithmPolicy -Disabled This command shows how to disable the FipsAlgorithmPolicy. Related Links 362

363 Physical Device Refer to the following sections for more information. Get-DAPhysicalDevice Gets the detailed information of the specified physical device(s). Syntax Get-DAPhysicalDevice [[-Name] <String[]>] [<CommonParameters>] Get-DAPhysicalDevice [-Type] <StorageType> [<CommonParameters>] The Get-DAPhysicalDevice cmdlet gets the detailed information of the physical device(s). Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) -Type<StorageType> true Specifies the physical device type. Valid values are "NetShare", "FTP", "TSM", "EMCCentera", "CloudStorage", "DELLDXStorage", "CaringoStorage", "HDSHitachiContentPlatform", "DataONTAPLUN" and "DataONTAPCIFSShare". true 0 false false <CommonParameters> Examples PS C:\>Get-DAPhysicalDevice -Name 'physical device1' 363

364 StorageType : DataONTAPCIFSShare StorageSystemProfile : storage system profile1 ShareName UNCPath : FilerA: sharename1 : \\ \sharename2 FreeSpace : G TotalSize IsSnapLock Username : 7G : False : example.com\user1 Password : ExtendedParameters : Farms SpaceThreshold Name SpaceUsage : {Farm(SP2010_DB:SHAREPOINT_CONFIG)} : 1024MB : physical device1 : this is a CIFS Share physical device : 2.06GB free of 7.00GB This command gets the detailed information of the physical device whose name is 'physical device1'. Example 2 PS C:\>Get-DAPhysicalDevice StorageType : DataONTAPCIFSShare StorageSystemProfile : storage system profile1 ShareName : FilerA: sharename2 364

365 UNCPath : \\ \sharename2 FreeSpace : G TotalSize IsSnapLock Username : 7G : False : example.com\user1 Password : ExtendedParameters : Farms : {} SpaceThreshold Name SpaceUsage : 1024MB : physical device1 : this is a physical device : 2.06GB free of 7.00GB StorageType : DataONTAPCIFSShare StorageSystemProfile : storage system profile1 ShareName UNCPath : FilerA: sharename1 : \\ \sharename1 FreeSpace : G TotalSize IsSnapLock Username : 4G : True : example.com\user1 Password : ExtendedParameters Farms SpaceThreshold Name : SnapLockEnabled = True : {Farm(SP2010_DB:SHAREPOINT_CONFIG)} : 1024MB : physical device2 : 365

366 SpaceUsage : 1.83GB free of 4.00GB This command gets the detailed information of all the physical devices. Example 3 PS C:\>Get-DAPhysicalDevice -Type DataONTAPCIFSShare StorageType : DataONTAPCIFSShare StorageSystemProfile : storage system profile1 ShareName UNCPath : FilerA: sharename1 : \\ \sharename1 FreeSpace : G TotalSize IsSnapLock Username : 4G : False : example.com\user1 Password : ExtendedParameters : Farms : {} SpaceThreshold Name : 1024MB : physical device1 : SpaceUsage : 1.83GB free of 4.00GB This command gets the detailed information of the physical device whose storage type is DataONTAPCIFSShare. Related Links New-DAPhysicalDevice 366

367 Get-DABlankPhysicalDevice Gets a blank physical device for creating a new physical device. Syntax Get-DABlankPhysicalDevice [-Type] <String> [<CommonParameters>] 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". true 0 true (ByValue) false <CommonParameters> Examples PS C:\>Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare StorageType : DataONTAPCIFSShare StorageSystemProfile : ShareName : UNCPath : FreeSpace : TotalSize : IsSnapLock : False 367

368 Username : Password : ExtendedParameters : Farms : {} SpaceThreshold : 1024MB Name : : SpaceUsage : 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> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> 368

369 Examples 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:\> These commands create a Data ONTAP (CIFS Share) physical device. Example 2 PS C:\>$device = Get-DABlankPhysicalDevice -Type NetShare PS C:\>$device.Name = 'physical device1' PS C:\>$device. = '' 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:\> 369

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> [<CommonParameters>] The Update-DAPhysicalDevice cmdlet updates an existing physical device. Parameters -PhysicalDevice<PhysicalDeviceBase> Specifies an existing physical device object to be updated. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$device = Get-DAPhysicalDevice -Name 'physical device1' PS C:\>$device.Name = 'physical device2' PS C:\>$device. = '' PS C:\>Update-DAPhysicalDevice -PhysicalDevice $device PS C:\> These commands update the specified physical device. 370

371 Related Links Get-DAPhysicalDevice Remove-DAPhysicalDevice Deletes an existing physical device. Syntax Remove-DAPhysicalDevice [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>] The Remove-DAPhysicalDevice cmdlet deletes an existing physical device. Parameters -Name<String> Specifies the name of an existing physical device that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples 371

372 PS C:\>Remove-DAPhysicalDevice -Name 'physical device1' This command deletes the specified physical device. Related Links Get-DAPhysicalDevice Logical Device Refer to the following sections for more information. Get-DALogicalDevice Gets the information of the specified logical devices. Syntax Get-DALogicalDevice [[-Name] <String[]>] [<CommonParameters>] The Get-DALogicalDevice cmdlet gets the information of the specified logical devices. Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DALogicalDevice -Name 'logical device1' 372

373 Name StorageType : logical device1 : this is a logical device. : FTP PhysicalDeviceList : {physical device1} This command gets the information of the logical device whose name is logical device1. Example 2 PS C:\>Get-DALogicalDevice Name StorageType : logical device1 : this is a logical device. : FTP PhysicalDeviceList : {physical device1} Name : logical device2 : StorageType : NetShare PhysicalDeviceList : {physical device2} 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 373

374 Syntax Get-DABlankLogicalDevice [<CommonParameters>] The Get-DABlankLogicalDevice cmdlet gets a blank logical device for creating a new physical device. Parameters <CommonParameters> Examples PS C:\>Get-DALogicalDevice Name : : StorageType : NetShare PhysicalDeviceList : This command gets a blank logical device. Related Links New-DALogicalDevice New-DALogicalDevice Creates a new logical device. Syntax New-DALogicalDevice [-LogicalDevice] <LogicalDevice> [<CommonParameters>] The New-DALogicalDevice cmdlet creates a new logical device. 374

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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$device = Get-DABlankLogicalDevice PS C:\>$device.name = 'Logical Device' PS C:\>$device. = '' PS C:\>$device.StorageType = 'NetShare' PS C:\>$entity1 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('phy sical device 1') PS C:\>$entity2 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('phy sical device 2') PS C:\>$entity3 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('phy 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 375

376 PS C:\>$device.AddPhysicalDevice($entity1) PS C:\>$device.AddPhysicalDevice($entity2) PS C:\>$device.AddPhysicalDevice($entity3) PS C:\>New-DALogicalDevice -LogicalDevice $device PS C:\> 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> [<CommonParameters>] The Update-DALogicalDevice cmdlet updates an existing logical device. Parameters -LogicalDevice<LogicalDevice> Specifies a logical device object to be updated. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$device = Get-DALogicalDevice -Name 'logical device1' 376

377 PS C:\>$device fl Name StorageType : logical device1 : description : NetShare PhysicalDeviceList : {physical device1} PS C:\>$device.RemovePhysicalDevice('physical device1') PS C:\>$entity = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('phy sical device 2') PS C:\>$entity.StorageIndex =$true PS C:\>$entity.StorageData =$true PS C:\>$device.AddPhysicalDevice($entity) PS C:\>$device.PhysicalDeviceList fl Name : physical device2 StorageData : True StorageIndex : True PS C:\>Update-DALogicalDevice -LogicalDevice $device 377

378 PS C:\> 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] [<CommonParameters>] The Remove-DALogicalDevice cmdlet deletes an existing logical device. Parameters -Name<String> Specifies the name of the logical device that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> 378

379 Examples PS C:\>Remove-DALogicalDevice -Name 'physical device1' This command deletes the specified logical device. Related Links Get-DALogicalDevice Storage Policy Refer to the following sections for more information. Get-DAStoragePolicy Gets the information of the specified storage policies. Syntax Get-DAStoragePolicy [[-Name] <String[]>] [<CommonParameters>] The Get-DAStoragePolicy cmdlet gets the information of the specified storage policies. Parameters -Name<String[]> 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. false 0 true (ByValue, ByPropertyName) <CommonParameters> true 379

380 Examples PS C:\>Get-DAStoragePolicy -Name 'storage policy' Name : storage policy : this is a storage policy. PrimaryStorage : logical device 1 MediaServiceUseStrategy : DefaultPriority MediaServiceNames EnableRetentionRule StoragePolicyType : {service1} : False : None 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>] The Get-DABlankStoragePolicy cmdlet gets a blank storage policy for creating a new storage policy. Parameters <CommonParameters> 380

381 Examples PS C:\>Get-DABlankStoragePolicy Name : : PrimaryStorage : MediaServiceUseStrategy : DefaultPriority MediaServiceNames : {} EnableRetentionRule StoragePolicyType : False : None This command gets a blank storage policy. Related Links New-DAStoragePolicy New-DAStoragePolicy Creates a new storage policy. Syntax New-DAStoragePolicy [-StoragePolicy] <StoragePolicy> [<CommonParameters>] The New-DAStoragePolicy cmdlet creates a new storage policy. Parameters -StoragePolicy<StoragePolicy> 381

382 Specifies a storage policy object. About the structure and attributes of the storage policy, refer to the DocAve SDK Documentation for more information. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$policy = Get-DABlankStoragePolicy PS C:\>$policy.Name = 'storage policy 01' PS C:\>$policy. = '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:\> These commands create a storage policy. Related Links Get-DABlankStoragePolicy Update-DAStoragePolicy Updates an existing storage policy. Syntax Update-DAStoragePolicy [-StoragePolicy] <StoragePolicy> [<CommonParameters>] 382

383 The Update-DAStoragePolicy cmdlet updates an existing storage policy. Parameters -StoragePolicy<StoragePolicy> Specifies an existing storage policy to be updated. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$policy = Get-DAStoragePolicy -Name 'storage policy 1' PS C:\>$policy.Name = 'storage policy 2' PS C:\>$policy. = 'updates the storage policy' PS C:\>$policy.MediaServiceUseStrategy ='DefaultPriority' PS C:\>Update-DAStoragePolicy -StoragePolicy $policy PS C:\> These commands update an existing storage policy. Related Links New-DAStoragePolicy Get-DAStoragePolicy Remove-DAStoragePolicy Deletes an existing storage policy. 383

384 Syntax Remove-DAStoragePolicy [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>] The Remove-DAStoragePolicy cmdlet deletes an existing storage policy. Parameters -Name<String> Specifies the name of the storage policy that you want to delete. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>Remove-DAStoragePolicy -Name 'storage policy' This command deletes the specified storage policy. Related Links Get-DAStoragePolicy 384

385 New-DAStoragePolicy Update Manager Refer to the following sections for more information. Upload-DAUpdate Uploads the update to manager. Syntax Upload-DAUpdate [-Path] <String> [-Overwrite] [<CommonParameters>] The Upload-DAUpdate cmdlet uploads the upate to manager. Parameters -Path<String> Specifies the path of the update file. true 0 true (ByValue) false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing update. false named false false <CommonParameters> Examples PS C:\>Upload-DAUpdate -Path 'C:\Hotfix_ zip' -Overwrite This command uploads the update to manager and will overwrite the update if existed. 385

386 Related Links Get-DAUpdate Get-DAUpdate Gets the update(s) information. Syntax Get-DAUpdate [[-Name] <String[]>] [<CommonParameters>] 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. Parameters -Name<String[]> Specifies one or more updates' names. You can type multiple update names (separated by commas). Wildcards are supported. false 0 true (ByValue, ByPropertyName) <CommonParameters> true Examples PS C:\>Get-DAUpdate -Name 'HotFix_ ' Name Type : HotFix_ : Optional Size : Status : ReadyForInstall 386

387 PublishTime : 11/3/2011 5:29:37 PM This command retrieves the update named 'HotFix_ '. Related Links Install-DAUpdate Get-DAUpdateConfiguration Gets an update configuration. Syntax Get-DAUpdateConfiguration [-UpdateName] <String[]> [<CommonParameters>] 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). true 0 true (ByValue) false <CommonParameters> Examples PS C:\>Get-DAUpdateConfiguration -UpdateName Hotfix_ UpdateNames UpdateManager : {Hotfix_ } : False UpdateFarms : {} 387

388 UpdateSQLAgents : {} UpdateNonFarmRelatedAgent : False This command retrieves the update configuration base on update 'Hotfix_ '. Related Links Install-DAUpdate Test-DAUpdate Test-DAUpdate Tests whether the update is valid. Syntax Test-DAUpdate [-Configuration] <UpdateConfiguration> [<CommonParameters>] 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. true 0 true (ByValue) false <CommonParameters> Examples PS C:\>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_ ' PS C:\>$config.UpdateManager = $true 388

389 PS C:\>$config.ViewServiceForUpdate() Category : WillUpdate : True Name Status : Control Service : ACTIVE Version : Type Message : Control : 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 This command tells whether there are warnings. If no warning returns True, Otherwise, it writes the warning messages. Related Links Install-DAUpdate Install-DAUpdate Installs update. Syntax Install-DAUpdate [-Configuration] <UpdateConfiguration> [-WhatIf] [- Confirm] [<CommonParameters>] 389

390 The Install-DAUpdate cmdlet installs update basing on the update configuration. Parameters -Configuration<UpdateConfiguration> Specifies an update configuration object. true 0 true (ByValue) false -WhatIf[<SwitchParameter>] Describes what would happen if you executed the command without actually executing the command. false named false false -Confirm[<SwitchParameter>] Prompts you for confirmation before executing the command. false named false false <CommonParameters> Examples PS C:\>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_ ' PS C:\>$config.UpdateManager = $true PS C:\>$config.ViewServiceForUpdate() Category : WillUpdate : True 390

391 Name Status : Control Service : Up Version : Type Message : Control : 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 This command retrieves the update configuration base on update 'Hotfix_ '. Related Links Test-DAUpdate Get-DAUpdate Job Monitor Refer to the following sections for more information. Get-DAJob Gets job information in the Job Monitor. Syntax Get-DAJob [-ID] <String> [<CommonParameters>] Get-DAJob [-Module] <Module> [-StartTimeRangeBeginning <DateTime>] [- StartTimeRangeEnding <DateTime>] [<CommonParameters>] 391

392 The Get-DAJob cmdlet gets job information in the Job Monitor. Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) -Module<Module> false 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/ :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. false named false false 392

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/ :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. false named false false <CommonParameters> Examples PS C:\>Get-DAJob -Id CA ID PlanName Module Status : CA : DeadAccountCleaner_PLAN : Administrator : Finished StartTime : 2012/7/10 10:54:16 FinishTime : 2012/7/10 10:55:01 Progress : 100 This command retrieves the job whose id is CA Example 2 PS C:\>Get-DAJob -Module Administrator 393

394 ID PlanName Module Status : CA : DeadAccountCleaner_PLAN : Administrator : Finished StartTime : 2012/7/10 10:54:16 FinishTime : 2012/7/10 10:55:01 Progress : 100 ID PlanName Module Status : CA : CloneUserPermission_PLAN : Administrator : Finished StartTime : 2012/7/10 10:59:04 FinishTime : 2012/7/10 11:00:26 Progress : 100 This command searches all Administrator jobs. Example 3 PS C:\>Get-DAJob -Module Administrator -StartTimeRangeBeginning "7/10/ :10" -StartTimeRangeEnding "7/10/ :58" ID PlanName Module Status : CA : DeadAccountCleaner_PLAN : Administrator : Finished StartTime : 2012/7/10 10:54:16 FinishTime : 2012/7/10 10:55:01 394

395 Progress : 100 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>] [<CommonParameters>] The Get-DAJobDetail cmdlet gets job details of the specified job. Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) -JobReportDetailStatus<JobReportDetailStatus[]> false Specifies the detail status to filter the detail. Valid values are "Success", "Failed", "Skipped" and "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. 395

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. false named false false <CommonParameters> Examples PS C:\>Get-DAJobDetail -ID CM Key Value Type Source URL Target URL Web Application Agent Size Status 0Bytes Success This command retrieves all the details of the job whoes id is CM Example 2 PS C:\>Get-DAJobDetail -ID CM JobReportDetailStatus Success,Failed -StartIndex 0 -Length 1 396

397 Key Value Type Source URL Target URL Web Application Agent Size Status 0Bytes Success 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>] The Get-DAJobSetting cmdlet gets the settings of the specified job. Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) <CommonParameters> false 397

398 Examples PS C:\>Get-DAJobSetting -ID cm Key Value Common Settings-Method Common Settings-Action Copy Attach Common Settings-Backup the Destinati... No Advanced Settings-Filter Policy Advanced Settings-Configuration Advanced Settings-Security Advanced Settings-Content None Copy/Move configuration Copy/Move security 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 Advanced Settings-Data Encryption Advanced Settings-Column Mapping No No None 398

399 Advanced Settings-Content Type Mapping None Advanced Settings-Template Mapping Advanced Settings-User Mapping Advanced Settings-Domain Mapping Advanced Settings-Language Mapping Advanced Settings-List Name Mapping None None None None 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 This command gets the settings of the job whose Job ID is CM Related Links Get-DAJob Get-DAJobSummary Get-DAJobDetail Get-DAJobSummary Gets job summary. Syntax Get-DAJobSummary [-ID] <String> [<CommonParameters>] The Get-DAJobSummary cmdlet gets the summary of the specified job. The summary includes the general information of the job. Parameters -ID<String> 399

400 Specifies the job ID. true 0 true (ByValue, ByPropertyName) <CommonParameters> false Examples PS C:\>Get-DAJobSummary -ID CA Key Value Job Information-Plan Name DeadAccountCleaner_PLAN Job Information- Job Information-Plan Type Account Cleaner Dead Job Information-Job ID CA Job Information-Start Time :54:16 (UTC+08:00) Beijing, Chongqing, Hong... Job Information-Finish Time :55:01 (UTC+08:00) Beijing, Chongqing, Hong... Job Information-Job Operated By Job Information-Plan Modified By admin admin Environment Information-Farm Name Farm(SP2010_DB:SHAREPOINT_CONFIG) Environment Information-Agent Host SP2010 Environment Information-Manager Version Environment Information-Agent Version

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 This command retrieves the summary of the job whose job id is CA Related Links Get-DAJob Get-DAJobDetail Download-DAJobReport Downloads the job report. Syntax Download-DAJobReport [-ID] <String> [-Format <JobReportFormat>] -Path <String> [-Overwrite] [<CommonParameters>] The Download-DAJobReport cmdlet downloads the report of the specified job. Parameters -ID<String> Specifies the job ID. true 0 true (ByValue, ByPropertyName) -Format<JobReportFormat> false 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> 401

402 Specifies the path of the report file. true named false false -Overwrite[<SwitchParameter>] Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Download-DAJobReport -ID FB Path 'C:\Report.zip' -Format txt -Overwrite This command downloads the job report to C:\Report.zip. The report format is txt. Related Links Get-DAJob Health Analyzer Refer to the following sections for more information. Export-DAHealthAnalyzerReport Exports the Health Anallyzer report. Syntax Export-DAHealthAnalyzerReport -JobId <String> -File <String> [- Overwrite] [<CommonParameters>] The Export-DAHealthAnalyzerReport cmdlet exports the Health Analyzer report. 402

403 Parameters -JobId<String> Specifies the job ID. 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>] Allows the cmdlet to overwrite an existing file. false named false false <CommonParameters> Examples PS C:\>Export-DAHealthAnalyzerReport -JobId HAR File 'C:\Report.txt' -Overwrite This command exports the Health Analyzer report to C:\Report.txt. The report file format is.txt. Related Links Get-DAJob 403

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