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