SnapManager® 8.2 for Microsoft SharePoint®

SnapManager® 8.2 for Microsoft SharePoint®

SDK Management Shell User’s Guide

NetApp, Inc. 495 East Java Drive Sunnyvale, CA 94089 U.S.

Telephone: +1 (408) 822-6000 Fax: +1 (408) 822-4501 Support telephone: +1 (888) 463-8277 Web: www.netapp.com Feedback: [email protected]

Part number: 215-09876_A0 June 2015

mailto:[email protected]

http://www.netapp.com/

Table of Contents

What Is New in this Guide ............................................................................................................................. 4

Overview ....................................................................................................................................................... 5

SnapManager for SharePoint API and CLI ..................................................................................................... 7

Before You Begin ........................................................................................................................................... 8

Configuration ............................................................................................................................................ 8

Agents ....................................................................................................................................................... 8

Getting Started .............................................................................................................................................. 9

Environment Requirements ...................................................................................................................... 9

SnapManager for SharePoint SDK .............................................................................................................. 10

Supported Features in SnapManager 8.2 for SharePoint SDK ................................................................ 10

SnapManager for SharePoint Management Shell ...................................................................................... 13

Installing the Management Shell ............................................................................................................ 13

Accessing SnapManager for SharePoint Management Shell .................................................................. 14

Upgrading SnapManager for SharePoint SDK and Management Shell .................................................. 15

SnapManager for SharePoint Management Shell Cmdlet Reference ........................................................ 16

Log Into SMSP Manager .......................................................................................................................... 16

Log Out of SMSP Manager ...................................................................................................................... 19

BLOB Provider ......................................................................................................................................... 20

Archiver ................................................................................................................................................... 31

Storage Manager..................................................................................................................................... 51

Real-Time Storage Manager ................................................................................................................... 56

Scheduled Storage Manager ................................................................................................................... 67

Platform Backup and Restore ................................................................................................................. 72

Obtain a Date Time Object...................................................................................................................... 77

Agent Monitor ......................................................................................................................................... 81

Account Manager .................................................................................................................................... 83

Security Information Manager .............................................................................................................. 108

Physical Device ...................................................................................................................................... 116

Logical Device ........................................................................................................................................ 125

2

SMSP 8.2 SDK Management Shell User’s Guide

Storage Policy ........................................................................................................................................ 132

Update Manager ................................................................................................................................... 138

Mapping Manager ................................................................................................................................. 145

Job Monitor ........................................................................................................................................... 165

Health Analyzer ..................................................................................................................................... 177

Copyright Information .............................................................................................................................. 179

Trademark Information ............................................................................................................................. 180

3


What Is New in this Guide • Updated the Supported Features in SnapManager 8.2 for SharePoint SDK.

• Added the information about the Get-DAArchiverProfile cmdlet.

• Added the information about the Reuse-DAArchiverProfile cmdlet.

• Added the information about the Retract-DAArchiverProfile cmdlet.

• Added the information about the Get-DAArchiverRule cmdlet.

• Added the information about the Reuse-DAArchiverRule cmdlet.

• Added the information about the Check-DAArchiverInheritance cmdlet.

• Added the information about the Inherit-DAArchiverParentSetting cmdlet.

• Added the information about the Stop-DAArchiverInheritance cmdlet.

• Added the information of the cmdlets for Scheduled Storage Manager.

• Added the information about the Get-DAAllSupportedTimeZoneIds cmdlet.

• Added the information about the Get-DASiteCollectionTenantGroup cmdlet.

• Added the information about the Get-DASystemGroup cmdlet.

• Added the information about the Get-DAWebApplicationTenantGroup cmdlet.

• Added the information about the Get-DABlankGroup cmdlet.

• Added the information about the New-DAGroup cmdlet.

• Added the information about the Update-DAGroup cmdlet.

• Added the information about the Remove-DAGroup cmdlet.

• Added the information of the cmdlets for Mapping Manager.

• Added the information about the Set-DAJobStopped cmdlet.

4


Overview SnapManager for SharePoint is an enterprise-strength backup, recovery, and data management solution for SharePoint Foundation 2010 and SharePoint Server 2010 (all current and future service packs), as well as SharePoint Foundation 2013 and SharePoint Server 2013 (all current and future service packs).

Operating on NetApp’s latest distributed software platform, SnapManager for SharePoint is accessible from anywhere in the network through Internet Explorer® (other browsers are supported), and can monitor multiple SharePoint environments across a network. SnapManager for SharePoint Manager’s main features include the following:

• The ability to centrally manage SharePoint backup and recovery jobs including scheduling, monitoring, reporting (logging and e-mail notifications), user account management, and software Agent management across multiple SharePoint farms from a single accessible-from-anywhere Web interface

• Fast backup speeds leveraging NetApp Snapshot backups, as well as real- time granular restore of items, item versions, lists, libraries, sites, and site collections directly onto the production server or an alternate location

• Backup coverage of all SharePoint 2010 and 2013 databases

• Backup of SharePoint search index files

• Backup of various SharePoint component settings including SharePoint and third-party solutions, IIS settings on Web front-end servers, SharePoint Global Search settings, and InfoPath Forms Services

• SnapMirror replication for backups of SharePoint databases and search indexes, Storage Manager BLOB data and Connector BLOB data, and verification of SnapMirror destination targets

• SnapVault data set backups of: SharePoint databases and search indexes, Storage Manager BLOB data and Connector BLOB data, and verification of SnapVault targets

• Configure multiple schedules for different restore granularity levels in a single backup plan

• Separately schedule verification jobs apart from backup or restore jobs

• Separately schedule granular indexing jobs apart from backup jobs

• Ability to browse and restore individual items from backup directly without generating an index at backup time

• Different retention settings for the same backup components in multiple plans

• Extend contents from the primary SQL content database storage to more affordable file system based locations (for example, NetApp CIFS devices) leveraging RBS

5


• End-user-initiated archiving can delete historical contents (from items to site collections), or move them based on fully customizable business rules or an on-demand basis with tiered storage management and the support of backup and recovery

• Connector can attach any NetApp CIFS Share to SharePoint, taking advantage of all SharePoint content management and presentation features without any ingestion of content into the SharePoint content database

• Integration with NetApp SnapLock technology

• Integration with NetApp ASUP system for streamlined support

• Integration with SCOM (Microsoft System Center Operations Manager) event log

• Support to backup and restore FAST Search Server Farms

In addition, SnapManager for SharePoint offers the option to evaluate various DocAve products for 90 days, including Migration, Granular Backup and Restore, Administration, Compliance products, and Report Center.

6


SnapManager for SharePoint API and CLI The APIs provided in the SnapManager for SharePoint SDK can be used to write your own commands and scripts. The SnapManager for SharePoint Management Shell provides you with many pre-defined commands that enable you to perform SMSP functions.

7


Before You Begin Refer to the sections below for system and farm requirements that must be in place prior to installing and using SnapManager for SharePoint Software Development Kit (SDK) and Management Shell.

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

Agents SnapManager for SharePoint Agents are responsible for running SnapManager for SharePoint jobs and interacting with the SharePoint object model. For more information on SnapManager for SharePoint Agents, refer to the SnapManager for SharePoint Installation Guide.

8


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

Environment Requirements For SnapManager for SharePoint SDK, the .NET Framework version must be v3.5 SP1 or later.

For SnapManager for SharePoint Management Shell, the .NET Framework version must be 3.5 SP1 or later and the PowerShell version must be v2.0 or later.

9


SnapManager for SharePoint SDK Build customizable, extendable, and programmable usage of SnapManager for SharePoint functions by invoking the program interfaces provided by SnapManager for SharePoint SDK.

To access detailed information on the commands available in the SnapManager for SharePoint SDK:

On a server that has SnapManager for SharePoint Manager or Agent installed on it, go to Start > All Programs > SnapManager 8 for SharePoint > SMSP SDK.

Double-click the help file named SMSP SDK Documentation to view detailed information on the commands. You can also find the help file in the following path: \NetApp\SMSP8\Shell\DocAveModules\DocAveModule\DocAveSDK.chm.

Supported Features in SnapManager 8.2 for SharePoint SDK The table below lists the supported features in SMSP 8.2 SDK.

Module Supported Features SMSP Manager Log into SMSP Manager

Log out of SMSP Manager Account Manager Add a local user

Update the settings of an existing local user Delete a local 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 Add/update/delete System/Web Application Tenant/Site Collection Tenant group List all of the System/Web Application Tenant/Site Collection Tenant groups Add user to System/Web Application Tenant/Site Collection Tenant group Remove user from System/Web Application Tenant/Site Collection Tenant group List Managed Web Applications/Plans by specify user in Web Application Tenant group List Managed Site Collections/Plans by specify user in Site Collection Tenant group

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

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

10


Module Supported Features Delete a physical device

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

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

Archive Manager Get all of the existing Archive Manager rules Get the rules that have been applied on a SharePoint object Reuse an existing rule on a SharePoint object Apply an existing rule on a SharePoint object Check and change a SharePoint object’s inheriting status Get all of the existing Archive Manager 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 Run an Archive Manager job

Storage Optimization BLOB Provider Settings

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

Real-Time Storage Manager Create a Real-Time Storage Manager rule Update the settings of an existing Teal-Time Storage Manager rule Delete an existing Real-Time Storage Manager rule Get all of the Real-Time Storage Manager rule Reuse a Real-Time Storage Manager rule on a SharePoint object Get the Real-Time Storage Manager rules that have been applied on a SharePoint object Retract a Real-Time Storage Manager rule

Scheduled Storage Manager Get all of the existing Storage Manager profiles Reuse a Storage Manager profile on a SharePoint site collection Retract a Storage Manager profile from a SharePoint site collection

Update Manager Get all of the available updates

11


Module Supported Features Upload an update Test an update Install an update

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

Platform Backup and Restore Get the default settings of a backup plan 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 Set the job status to Stopped.

Mapping Manager Export/import domain mapping profile Export/import column mapping profile Export/import language mapping profile Export/import user mapping profile Export/import content type mapping profile Export/import template mapping profile Export/import group mapping profile Export/import list name mapping profile

Health Analyzer Export the Health Analyzer job report.

12


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

Installing the Management Shell By default, SnapManager for SharePoint Management Shell is installed together with SnapManager for SharePoint Manager/Agent. You can find it in Start > All Programs > SnapManager 8 for SharePoint > SMSP Management Shell.

You can also install a SnapManager for SharePoint Management Shell server that does not have a SnapManager for SharePoint Manager/Agent installed on it. To install SnapManager for SharePoint Management Shell separately, see the following steps:

Copy the folder named Shell in the SnapManager for SharePoint installation path (…\NetApp\SMSP8).

Paste this folder into the server where you want to install SnapManager for SharePoint Management Shell. This folder can reside anywhere within the server’s directory.

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

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

Figure 1: Specify the installation location.

13


Press any key to exit when the installation completes.

Figure 2: Exit the tool.

Accessing SnapManager for SharePoint Management Shell After installing SnapManager 8 for SharePoint Management Shell, use either of the following two methods to access it.

• Go to Start > All Programs > SnapManager 8 for SharePoint > SMSP Management Shell and click SMSP 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 SnapManager for SharePoint PowerShell module by executing the command: Import-Module -Name DAModule -DisableNameChecking

*Note: Before using any SnapManager for SharePoint cmdlets, you must log into SnapManager for SharePoint using Login-DAManager cmdlet first. You can obtain additional information on using this cmdlet by entering Get-Help Login-DAManager.

To get the overview of all of the commands available for SnapManager for SharePoint, 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 related to the Platform Backup modules:

Get-Command -Name *PlatformBackup*

14


Upgrading SnapManager for SharePoint SDK and Management Shell To ensure proper functionality, the SnapManager for SharePoint SDK and Management Shell must be the same version as the SnapManager for SharePoint platform. The information below details where to find instructions on updating the SnapManager for SharePoint SDK and Management Shell to a version >7.0.

For detailed steps regarding how to upgrade the SnapManager for SharePoint SDK, refer to SMSP SDK Documentation, which is available in the following path by default: …\NetApp\SMSP8\Shell\DocAveModules\DocAveModule\DocAveSDK.chm.

For detailed steps regarding how to upgrade the SnapManager for SharePoint Management Shell, refer to the conceptual topic Get-Help about _DAUpdate cmdlet in the SnapManager 8 for SharePoint Management Shell:

1. Open the SMSP Management Shell.

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

Figure 3: Get-Help about_DAUpdate in SMSP Management Shell

15


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

*Note: SMSP 8 SDK provides a Connector API welcome page to allow users to get the functional summary of Connector API, and provides the directory of the Connector SDK in SMSP Agent server.

Log Into SMSP Manager Refer to the following sections for more information.

Login-DAManager Logs into the Manager.

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

Login-DAManager -ControlHost <String> -ControlPort <Int32> -Username <String> -PlainTextPassword <String> [-ADGroupName <String>] [<CommonParameters>]

Login-DAManager -ControlHost <String> -ControlPort <Int32> -Username <String> -Password <SecureString> [-ADGroupName <String>] [<CommonParameters>]

Description The Login-DAManager cmdlet is used to log into the Manager. The local user and the Active Directory user are supported for logging in to Manager.

Parameters -ControlHost<String>

Specifies the address of control host.

Required? Position? Default value Accept pipeline input?

Accept wildcard characters?

true named false false

-ControlPort<Int32>

16


Specifies the control port.




-Credential<PSCredential>

Specifies the credential.




-ADGroupName<String>

Specifies name of the Active Directory group whose permission you want to use to log into Manager. Use the full domain name, for example, example.com\group.



false named false false

-Username<String>

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




-PlainTextPassword<String>

Specifies the password in the form of plain text string.




17


-Password<SecureString>

Specifies the password in the form of secure string.




<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, type, "get-help about_commonparameters".

Examples Example 1

PS C:\>$Credential = Get-Credential

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

Description

Logins manager according to the credential.

Example 2

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

*****

PS C:\>Login-DAManager -ControlHost localhost -ControlPort 14000 -Username admin -Password $SecurePassword

Description

Logins manager according to the username and the secure string password.

Example 3

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

Description

Logins manager according to the username and the plain text password.

18


Example 4

PS C:\>Login-DAManager -ControlHost localhost -ControlPort 14000 -Username example.com\user1 -PlainTextPassword admin -ADGroupName example.com\group1

Description

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

Related Links Logout-DAManager

Log Out of SMSP Manager Refer to the following sections for more information.

Logout-DAManager Logs out of the DocAve Manager.

Syntax Logout-DAManager [<CommonParameters>]

Description The Logout-DAManager cmdlet logs out of the DocAve Manager.

Parameters <CommonParameters>


Examples Example 1

PS C:\>Logout-DAManager

Description

This command logs out the DocAve Manager.

Related Links Login-DAManager

19


BLOB Provider Refer to the following sections for more information.

Get-DABLOBProviderBinariesInfo Gets the BLOB provider binaries information.

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

Description The Get-DABLOBProviderBinariesInfo cmdlet gets the BLOB provider binaries information, including server name, service name, and whether agent and BLOB provider binaries are installed.

Parameters -FarmName<String>

Specifies a farm name. If you do not set any value for the parameter, all the farms' BLOB provider binaries information will be returned.



false 0 true (ByValue) false

<CommonParameters>


Examples Example 1

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

FarmName : Farm(SP2010_DB:SHAREPOINT_CONFIG)

Server : Server1

Service : {Microsoft SharePoint Foundation Database, Managed Metadata Web Service, Business Data Connectivity Service, Search Administration Web Service...}

20


AgentInstalled : True

BLOBProviderBinariesInstalled : True

Description

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

Get-DAStubDBConfiguration Gets the farm level stub database configuration.

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

Description The Get-DAStubDBConfiguration cmdlet gets the farm level stub database configuration. You can configure the stub database for farm, web application, and content database via the configuration instance.


Specifies a farm name.



true 0 true (ByValue, ByPropertyName)

false

<CommonParameters>


Examples Example 1

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

PS C:\>$StubDBConfig.WebApplicationStubDBConfigurations

21



WebApplicationUrl : http://SharePoint2010:10001/

DatabaseServer : Server\SharePoint

DatabaseName :

FailoverDatabaseServer :

Authentication : Windows

SQLAuthenticationAccount :



DatabaseServer : Server\SharePoint

DatabaseName :

FailoverDatabaseServer :

Authentication : Windows

SQLAuthenticationAccount :

Description

This command shows how to get stub database configuration of a specified farm. You can use the "WebApplicationStubDBConfigurations" property to get all web applications' stub database configurations. This example also uses the "ContentDBStubDBConfigurations" property to get all content databases' stub database configurations.

Related Links Configure-DAStubDB

Configure-DAStubDB Configures a stub database.

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

Description The Configure-DAStubDB cmdlet configures the stub database.

Parameters -Configuration<StubDBConfiguration>

22


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


PS C:\>$ContentDBs = $StubDBConfig.GetContentDBLevelStubDBConfigurationByName('WSS_Content_10001')

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

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

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

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

PS C:\>$ContentDB2 = $StubDBConfig.GetContentDBLevelStubDBConfigurationById("f17d7594-d09a-49a8-b41a-479a877a51d0")

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

*********

PS C:\>$ContentDB2.ConfigureAsSQLAuthentication('DBServer','StubDB2','Username',$password)

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

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

Description

These commands show how to configure a stub database for a content database with either Windows authentication or SQL authentication.

23


Example 2


PS C:\>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/')

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

*********

PS C:\>$WebAppConfig.ConfigureAsSQLAuthentication('DBServer','StubDB1','Username',$password)

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

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

Description

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

Example 3


PS C:\>$WebAppConfig = $StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/')

PS C:\>$WebAppConfig.ConfigureByConnectionString('Data Source=myServerAddress;Failover Partner=myMirrorServerAddress;Initial Catalog=myDataBase;Integrated Security=true;')

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

Description

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

Description 24


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


Specifies a farm name.




false

<CommonParameters>


Examples Example 1

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

PS C:\>$BLOB.WebApplicationLevelRBSConfigurations

FarmName WebApplicationUrl IncludeNewContentDBs

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

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




PS C:\>$BLOB.ContentDBLevelRBSConfigurations



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

25


ContentDBName : WSS_Content_10001

RBSEnabled : False

Description

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

Related Links Save-DABLOBProviderConfiguration

Save-DABLOBProviderConfiguration Saves the BLOB provider configuration.

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

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

Parameters -Configuration<BLOBProviderConfiguration>

Specifies the BLOB Provider configuration instance.




-RunNow[<SwitchParameter>]

Indicates whether or not to run now after saving the configuration.




<CommonParameters>


26


Examples Example 1


PS C:\>$ContentDBs = $BLOB.GetContentDBLevelRBSConfigurationByName('WSS_Content_10001')

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

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

PS C:\>$ContentDB2 = $BLOB.GetContentDBLevelRBSConfigurationById('f17d7594-d09a-49a8-b41a-479a877a51d0')

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

PS C:\>$ContentDB1



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


RBSEnabled : True

PS C:\>$ContentDB2



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


RBSEnabled : True

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

Description

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

Example 2

27



PS C:\>$WebApp1 = $BLOB.GetWebApplicationLevelRBSConfiguration('http://SharePoint2010:10001/')

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

PS C:\>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime

PS C:\>$StartTime = Get-DADateTime -Year 2012 -Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID

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

PS C:\>$BLOB.Schedule

Enabled : True

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

Interval : 34D

EndTime :

NumberOfOccurrence : 0

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

Description

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

Example 3



Enabled : False

StartTime :

Interval :

EndTime :


28




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


Enabled : True


Interval : 34D

EndTime :


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

Description

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

Example 4



Enabled : False

StartTime :

Interval :

EndTime :



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

inute 30 -TimeZoneId $TimeZoneID

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

29



Enabled : True


Interval : 34D

EndTime :



Description

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

Example 5



Enabled : False

StartTime :

Interval :

EndTime :




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

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

PS C:\>$blob.Schedule

Enabled : True

30



Interval : 34D

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



Description

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

Related Links Get-DABLOBProviderConfiguration

Archiver Refer to the following sections for more information.

Run-DAArchiverJob Runs an Archiver job.

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

Description The Run-DAArchiverJob cmdlet runs the specified Archiver job.

Parameters -SPObject<SharePointObject>

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




false

-WaitForJobComplete[<SwitchParameter>]

31


Whether to wait for the completion of the job. If you select to wait for the completion, it will show the job process. Otherwise, it will run in the background.




<CommonParameters>


Examples Example 1

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

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

ID : AR20120710135406923230S

PlanName :

Module : Archiver

Status : Waiting

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

FinishTime :

Progress : 0

Description

These commands show how to archive site1.

Run-DAArchiverIndexJob Runs an Archiver index job according to the job ID.

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

Description

32


The Run-DAArchiverIndexJob cmdlet runs an Archiver index job according to the specified Archiver index job ID.

Parameters -JobId<String>

Specifies a job ID of an archiver index job.




<CommonParameters>


Examples Example 1

PS C:\>Run-DAArchiverIndexJob -JobId AI2012070101234567890

Description

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

Get-DAArchiverIndexDataInfo Gets the information about the DocAve Archiver data that was not successfully indexed.

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

Description The Get-DAArchiverIndexDataInfo cmdlet gets the web application or the site collection that had Archiver data that was not successfully indexed.


Specifies the name of a farm where the Archiver data’s index information will be retrieved from.

33




true 0 false false

-OutPut<String>

Specifies a path in which to store the output file.



true 1 false false

-Overwrite[<SwitchParameter>]

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




<CommonParameters>


Examples Example 1

PS C:\>Get-DAArchiverIndexDataInfo -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -OutPut C:\IndexInfo.xls

Description

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

Related Links Set-DAArchiverIndexDataInfo

Get-DAArchiverJobDetailForBackup Gets Archiver job details of a backup job.

34


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

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

Parameters -ID<String>

Specifies the job ID.




false

-JobReportDetailStatus<JobReportDetailStatus[]>

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




-StartIndex<Int32>

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




-Length<Int32>

Specifies the total number of details in the result.

35





<CommonParameters>


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

Examples Example 1

PS C:\>Get-DAArchiverJobDetailForBackup -ID AR20120710135855645356A0

Key Value

--- -----

Type SiteCollection

Source URL http://SharePoint2010/sites/site1

Media 10.2.6.110

Agent SP2010

Size 503.00KB

Status Successful

Finish Time 2012-07-10 14:15:02 (UTC-08:00) Pacific Time (US & Canada)

Comment

Description

This command retrieves all backup details of the Archiver job.

Example 2

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

36


Key Value

--- -----

Type SiteCollection

Source URL http://SharePoint2010/sites/site1

Media 10.2.6.110

Agent SP2010

Size 503.00KB

Status Successful


Comment

Description

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

Related Links Get-DAArchiverJobDetailForDeletion

Get-DAArchiverJobDetailForDeletion Gets Archiver job details for deletion.

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

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






false

37



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




-StartIndex<Int32>

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




-Length<Int32>

Specifies the total number of details in the result.




<CommonParameters>


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

Examples Example 1

PS C:\>Get-DAArchiverJobDetailForDeletion -ID AR20120710135855645356A0

38


Key Value

--- -----

Type Item

Source URL Shared Documents\Case.xlsx

Media 10MGRSHU

Agent 10SPSHU

Size 25.00KB

Status Successful


Comment

Description

This command retrieves all deletion details of the Archiver job.

Example 2

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

Key Value

--- -----

Type Item

Source URL Shared Documents\Case.xlsx

Media 10MGRSHU

Agent 10SPSHU

Size 25.00KB

Status Successful


Comment

Description

39


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

Description The Set-DAArchiverIndexDataInfo sets the index information of the Archiver data that has not been successfully indexed.

Parameters -Path<String>

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



true 0 false false

-OutPut<String>

Specifies a path to store the output file.



true 1 false false


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




40


<CommonParameters>


Examples Example 1

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

Description

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

Related Links Get-DAArchiverIndexDataInfo

Get-DAArchiverProfile Gets the Archiver profiles applied in the SharePoint farm or the specified SharePoint object. Can also get gets the specified Archiver profile in a SharePoint farm.

Syntax Get-DAArchiverProfile [-SPObject] <SharePointObject> [<CommonParameters>]

Get-DAArchiverProfile [-FarmName] <String> [[-ProfileName] <String>] [<CommonParameters>]

Description The Get-DAArchiverProfile cmdlet gets the Archiver profiles applied in the specified farm or specified SharePoint object. The Get-DAArchiverProfile cmdlet can also get the Archiver profile according to the specified profile name in the SharePoint farm.


Specifies a SharePoint object to get the Archiver profiles that are applied on.




false

-FarmName<String>

41


Specifies a SharePoint farm to get the Archiver profiles that are applied on.




false

-ProfileName<String>

Specifies a profile name to get the Archiver profile from the specified farm.



false 1 true (ByValue, ByPropertyName)

false

<CommonParameters>


Examples Example 1

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

Name Description Rules

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

Profile 1 From farm {Rule1, Rule2}

Description

These commands get Archiver profiles applied in the specified SharePoint farm.

Example 2

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

PS C:\>Get-DAArchiverProfile -SPObject $web

42


Name Description Rules

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

Profile 2 From Site {Rule3, Rule4}

Description

These commands get Archiver profiles applied in the specified SharePoint site.

Example 3

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

PS C:\>Get-DAArchiverProfile -FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' -ProfileName 'Profile 3'

Description

These commands get the specified Archiver profile from the specified SharePoint farm.

Reuse-DAArchiverProfile Reuses the existing Archiver profile on a SharePoint object.

Syntax Reuse-DAArchiverProfile [-ProfileName] <String> [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Reuse-DAArchiverProfile reuses the existing Archiver profile on a SharePoint object.

Parameters -ProfileName<String>

Specifies an existing Archiver profile name that you want to reuse.




false

-SPObject<SharePointObject>

Specifies a SharePoint object that you want to reuse a Archiver profile on.

43





false

<CommonParameters>


Examples Example 1


PS C:\>Reuse-DAArchiverProfile -ProfileName 'Profile 1' -SPObject $web

Description

These commands reuse the existing Archiver profile on a specified SharePoint site.

Retract-DAArchiverProfile Retracts the applied Archiver profile from the specified SharePoint object.

Syntax Retract-DAArchiverProfile [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Retract-DAArchiverProfile cmdlet retracts an applied Archiver profile from the specified SharePoint object.


Specifies a SharePoint object with the applied Archiver profile that you want to remove.




false

44


<CommonParameters>


Examples Example 1

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

PS C:\>Retract-DAArchiverProfile -SPObject $sitecollection

Description

These commands retract an existing Archiver profile from the specified SharePoint site collection.

Get-DAArchiverRule Gets the Archiver rule using the specified rule name, gets all of the Archiver rules, or gets the Archiver rules for the specified SharePoint object.

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

Get-DAArchiverRule [-SPObject <SharePointObject>] [<CommonParameters>]

Description The Get-DAArchiverRule cmdlet gets the Archiver rule using the specified rule name, gets all of the Archiver rules, or gets the Archiver rules for the specified SharePoint object.

Parameters -Name<String>

Specifies the name of an existing Archiver rule that you want to get.




false


Specifies a SharePoint object that you want to reuse an Archiver profile on.

45




false named true (ByValue, ByPropertyName)

false

<CommonParameters>


Examples Example 1

PS C:\>Get-DAArchiverRule

Name : Rule 1

ObjectLevel : Document

StoragePolicyName : Policy 1

Enabled : True

Detail : Criteria:

1.Document,Name,Match,doc .

Criteria Filters: ( 1 )

Storage Policy: Policy 1

Compression:None

Encryption:None

Name : Rule 2

ObjectLevel : DocumentVersion


Enabled : True

Detail : Criteria:

1.Document Version,Title,Match,version .

46




Compression:None

Encryption:None

Description

These commands get all of the Archiver rules.

Example 2

PS C:\>

Name : Rule 1

ObjectLevel : Document


Enabled : True

Detail : Criteria:

1.Document,Name,Match,doc .



Compression:None

Encryption:None

Description

These commands get an existing Archiver rule using the specified rule name.

Example 3


PS C:\>Get-DAArchiverRule -SPObject $web

Description

These commands get the Archiver rule for the specified SharePoint site.

47


Reuse-DAArchiverRule Reuses the existing Archiver rules on a SharePoint object.

Syntax Reuse-DAArchiverRule [-RuleNames] <List`1[String]> [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Reuse-DAArchiver reuses the existing Archiver rules on a SharePoint object.

Parameters -RuleNames<List`1[String]>

Specifies the existing Archiver rule names that you want to reuse.




false


Specifies a SharePoint object to stop it inherit the Archiver settings from its parent node.




false

<CommonParameters>


Examples Example 1


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

PS C:\>$ruleNames.Add('rule 1')

48


PS C:\>$ruleNames.Add('rule 2')

PS C:\>Reuse-DAArchiverRule -RuleNames $ruleNames -SPObject $web

Description

These commands reuse the existing Archiver rules on a specified SharePoint site.

Check-DAArchiverInheritance Checks whether or not a SharePoint object is inheriting the Archiver settings from its parent node.

Syntax Check-DAArchiverInheritance [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Check-DAArchiverInheritance cmdlet checks whether or not a SharePoint object is inheriting the Archiver settings from its parent node.


Specifies the SharePoint object that you want to check.




false

<CommonParameters>


Examples Example 1

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

PS C:\>Check-DAArchiverInheritance -SPObject $sitecollection

False

Description

49


These commands check whether or not the specified SharePoint object is inheriting the Archiver settings from its parent node.

Inherit-DAArchiverParentSetting Enables a SharePoint object to inherit the Archiver settings from the parent level.

Syntax Inherit-DAArchiverParentSetting [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Inherit-DAArchiverParentSetting cmdlet enables a SharePoint object to inherit the Archiver settings from the parent node.


Specifies a SharePoint object that you want to inherit the Vault settings from the parent level.




false

<CommonParameters>


Examples Example 1


PS C:\>Inherit-DAArchiverParentSetting -SPObject $web

Description

These commands enable the SharePoint site to inherit the Archiver settings from the parent node.

Stop-DAArchiverInheritance Stops the specified SharePoint object inherit the Archiver settings from its parent node.

50


Syntax Stop-DAArchiverInheritance [-SPObject] <SharePointObject> [<CommonParameters>]

Description The Stop-DAArchiverInheritance cmdlet stops the specified SharePoint object from inheriting the Archiver settings from its parent node.


Specifies a SharePoint object that you want to stop inheriting Archiver settings.




false

<CommonParameters>


Examples Example 1


PS C:\>Stop-DAArchiverInheritance -SPObject $web

Description

These commands stop the specified SharePoint site from inheriting the Archiver settings from the parent node.

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

51


Export-DABLOBTraceOfStub -Configuration <ExportBlobInfoConfiguration> [<CommonParameters>]

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

Parameters -Configuration<ExportBlobInfoConfiguration>

Specifies the information of the item. The FarmName property represents the name of the farm where the item resides and the URL property represents the item's full path or the item's full path followed by a version.




<CommonParameters>


Examples Example 1

PS C:\>$config=New-Object DocAve.Cmdlet.StorageOptimization.ExportBlobInfoConfiguration

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

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

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

PS C:\>$result.StubTraceInfomation

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

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

ItemSize : 2867

RBSId : 0x0000000000000009000000010002

BlobId : 0x444f4301xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

52


StubType : Scheduled

StubDBServer : 10.1.53.15

StubDBName : StubDB

StubInfoTable : StubInfo_83b53a95_f74c_4371_8bc4_91f071aad6ba

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

DeviceName : DeviceName

FolderName : Data_Extender\Farm(SP201X_DB:SHAREPOINT_CONFIG)\webAppUrl\d8dcb342-50ef-4d9e-9

d9a-10ea929d4edb\7\8

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

ProviderType : RBS

IsOrphanStub : False

BSN : 671

LastAccessTime :

Description

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('http://leafsp2010:1111/library1/document.docx:1.1')

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

PS C:\>$result.FailedType

FarmNameNotExisting

Description

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

New-DARemapStorageManagerLogicalDeviceConfiguration Creates a Storage Manager logical device mapping configuration object.

53


Syntax New-DARemapStorageManagerLogicalDeviceConfiguration [<CommonParameters>]

Description The New-DARemapStorageManagerLogicalDeviceConfiguration cmdlet creates a Storage Manager logical device mapping configuration object.



Examples Example 1

PS C:\>$config = New-DARemapStorageManagerLogicalDeviceConfiguration

#Enter the name of the Disaster Recovery farm.

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

#Enter the name of the SQL Server Instance.

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

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

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

#Specify a default destination logical device. If no destination logical device is configured for a source logical device. The default logical device will be used to store the BLOB data copied from the 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'

54


#'true' means to copy the BLOB data and update the logical device information for the stubs; 'false' means to only update the logical device information for the stubs.;

'false' means only change stub information.

PS C:\>$config.CopyBLOBData =$true

#Enter a logical device mapping rule.

PS C:\>$config.LogicalDeviceMapping.Add('source logical device','destination logical device')

PS C:\>$config.LogicalDeviceMapping.Add('source logical device1','destination logical device1')

Description

This command creates a Storage Manager logical device mapping configuration object.

Related Links Remap-DAStorageManagerLogicalDevice

Remap-DAStorageManagerLogicalDevice Maps the source Storage Manager logical devices to the destination Storage Manager logical devices.

Syntax Remap-DAStorageManagerLogicalDevice -Configuration <CopyBlobAndRemapDeviceRequestConfig> [<CommonParameters>]

Description The Remap-DAStorageManagerLogicalDevice cmdlet maps the source Storage Manager logical devices to the destination Storage Manager logical devices.

Parameters -Configuration<CopyBlobAndRemapDeviceRequestConfig>

Specifies the configurations to map the source Storage Manager logical devices to the destination Storage Manager logical devices.

55





<CommonParameters>


Examples Example 1

PS C:\>$result =Remap-DAStorageManagerLogicalDevice -Configuration $config

Finish

PS C:\>$result.Succeeded

10000

PS C:\>$result.Failed

0

Description

This command maps the source Storage Manager logical devices to the destination Storage Manager logical devices.

Related Links New-DARemapStorageManagerLogicalDeviceConfiguration

Real-Time Storage Manager Refer to the following sections for more information.

56


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

Description The Get-DARealtimeStorageManagerRule cmdlet gets the real-time storage manager rules according to the specified rule name, the SharePoint content database, web application or site collection. If no parameter value is entered, all the existing real-time storage manager rules' configurations will be gotten.


Specifies the name of the real-time storage manager rule whose configurations will be gotten.



false named true (ByValue) false

-SPWebApplication<SharePointWebApplication>

Specifies a SharePoint web application. All the real-time storage manager rules that have been applied to this specified web application will be gotten.




-SPContentDB<SharePointContentDB>

Specifies a SharePoint content database. All the real-time storage manager rules that have been applied to this specified database will be gotten.

57





-SPSite<SharePointSite>

Specifies a SharePoint site collection. All the real-time storage manager rules that have been applied to this specified site collection will be gotten.




<CommonParameters>


Examples Example 1

PS C:\>Get-DARealtimeStorageManagerRule

Name : rule1

Description :

SizeThreshold : 2MB

LogicalDeviceName : logical device1

CompressionLevel : Level1

DataEncryption : False

SecurityProfileName :

Name : rule2

58


Description :

SizeThreshold : 512KB


CompressionLevel : None

DataEncryption : True

SecurityProfileName : security profile1

Description

This command gets all the existing real-time storage manager rules.

Example 2

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

Name : rule2

Description :






Description

This command gets the real-time storage manager rule that has the specified name.

Example 3

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

PS C:\>Get-DARealtimeStorageManagerRule -SPContentDB $db

Name : rule1

Description :

59


SizeThreshold : 2MB





Name : rule2

Description :






Description

These commands get the real-time storage manager rules that have been applied to the specified SharePoint content database. In the very similar way, you can get rules applied on a web application or a site collection.

Get-DARealtimeStorageManagerBlankRule Gets a blank real-time storage manager rule without any configurations.

Syntax Get-DARealtimeStorageManagerBlankRule [<CommonParameters>]

Description The Get-DARealtimeStorageManagerBlankRule cmdlet gets a blank real-time storage manager rule without any configurations.



Examples Example 1

60


PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule

PS C:\>$rule

Name :

Description :

SizeThreshold :

LogicalDeviceName :




Description

This command gets a blank real-time storage manager rule where it allows you to configure a new real-time storage manager rule.

New-DARealtimeStorageManagerRule Creates a new real-time storage manager rule.

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

Description The New-DARealtimeStorageManagerRule cmdlet creates a new real-time storage manager rule.

Parameters -Rule<RealtimeStorageManagerRule>

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




<CommonParameters>

61



Examples Example 1

PS C:\>$rule = Get-DARealtimeStorageManagerBlankRule

PS C:\>$rule.Name = 'rule1'

PS C:\>$rule.SizeThreshold = '768kb'

PS C:\>$rule.LogicalDeviceName = 'logical device1'

PS C:\>$rule.CompressionLevel = 'level3'

PS C:\>$rule.EnableDataEncryption('MyProfile')

PS C:\>New-DARealtimeStorageManagerRule -Rule $rule

Description

These commands create a new real-time storage manager rule based on a blank rule.

Update-DARealtimeStorageManagerRule Updates the configurations of an existing real-time storage manager rule.

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

Description The Update-DARealtimeStorageManagerRule cmdlets updates the configurations of an existing real-time storage manager rule.

Parameters -Rule<RealtimeStorageManagerRule>

Specifies a real-time storage manager rule object whose configurations will be updated.




<CommonParameters>

62



Examples Example 1

PS C:\>$rule = Get-DARealtimeStorageManagerRule -Name 'rule1'

PS C:\>$rule.Name = 'rule2'

PS C:\>$rule.CompressionLevel = 'level7'

PS C:\>Update-DARealtimeStorageManagerRule -Rule $rule

Description

These commands update the configurations of the specified real-time storage manager rule.

Remove-DARealtimeStorageManagerRule Deletes an existing real-time storage manager rule according to the rule's name.

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

Description The Remove-DARealtimeStorageManagerRule cmdlet deletes an existing real-time storage manager rule according to the rule's name.


Specifies the name of a real-time storage manager rule that you want to delete.




<CommonParameters>


Examples

63


Example 1

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

Description

This command deletes the real-time storage manager rule with the specified name.

Reuse-DARealtimeStorageManagerRule Reuses an existing real-time storage manager rule to a specified SharePoint content database, a web application or a site collection.

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

Reuse-DARealtimeStorageManagerRule -RuleName <String> [-SPWebApplication <SharePointWebApplication>] [<CommonParameters>]

Reuse-DARealtimeStorageManagerRule -RuleName <String> [-SPSite <SharePointSite>] [<CommonParameters>]

Description The Reuse-DARealtimeStorageManagerRule cmdlet reuses an existing real-time storage manager rule on a specified SharePoint content database, a web application or a site collection.

Parameters -RuleName<String>

Specifies the name of the real-time storage manager rule that you want to reuse.



true named true (ByValue) false


Specifies a SharePoint content database where the specified real-time storage manager rule will be applied.




64



Specifies a SharePoint web application where the specified real-time storage manager rule will be applied.





Specifies a SharePoint site collection where the specified real-time storage manager rule will be applied.




<CommonParameters>


Examples Example 1


PS C:\>Reuse-DARealtimeStorageManagerRule -RuleName 'rule1' -SPContentDB $db

Description

These commands apply the specified real-time storage manager rule to the specified SharePoint content database. In the very similar way, you can apply an existing rule to a web application or a site collection.

Retract-DARealtimeStorageManagerRule Retracts an applied real-time storage manager rule from the specified SharePoint content database, web application, or site collection.

Syntax

65


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

Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPWebApplication <SharePointWebApplication>] [<CommonParameters>]

Retract-DARealtimeStorageManagerRule -RuleName <String> [-SPSite <SharePointSite>] [<CommonParameters>]

Description The Retract-DARealtimeStorageManagerRule cmdlet retracts an already applied real-time storage manager rule from the specified SharePoint content database, web application, or site collection.

Parameters -RuleName<String>

Specifies the name of the real-time storage manager rule from which you want to retract the specified SharePoint content database.



true named true (ByValue) false


Specifies a SharePoint content database from which the specified real-time storage manager rule will be retracted.





Specifies a SharePoint web application from which the specified real-time storage manager rule will be retracted.





66


Specifies a SharePoint site collection from which the specified real-time storage manager rule will be retracted.




<CommonParameters>


Examples Example 1


PS C:\>Retract-DARealtimeStorageManagerRule -RuleName 'rule1' -SPContentDB $db

Description

These commands retract the specified real-time storage manager rule from the specified SharePoint content database. In the very similar way, you can retract rule from a web application or a site collection.

Scheduled Storage Manager Refer to the following sections for more information.

Get-DAScheduledStorageManagerProfile Gets all of the existing Scheduled Storage Manager profiles.

Syntax Get-DAScheduledStorageManagerProfile [<CommonParameters>]

Description The Get-DAScheduledStorageManagerProfile gets all of the existing Scheduled Storage Manager profiles.


67



Examples Example 1

PS C:\>Get-DAScheduledStorageManagerProfile

Description

These commands get all of the existing Scheduled Storage Manager profiles.

Reuse-DAScheduledStorageManagerProfile Reuses an existing Scheduled Storage Manager profile to a specified SharePoint object.

Syntax Reuse-DAScheduledStorageManagerProfile [-ProfileName] <String> [-SPWebApplication] <SharePointWebApplication> [<CommonParameters>]

Reuse-DAScheduledStorageManagerProfile [-ProfileName] <String> [-SPSite] <SharePointSite> [<CommonParameters>]

Reuse-DAScheduledStorageManagerProfile [-ProfileName] <String> [-SPWeb] <SharePointWeb> [<CommonParameters>]

Reuse-DAScheduledStorageManagerProfile [-ProfileName] <String> [-SPList] <SharePointList> [<CommonParameters>]

Reuse-DAScheduledStorageManagerProfile [-ProfileName] <String> [-SPFolder] <SharePointFolder> [<CommonParameters>]

Description The Reuse-DAScheduledStorageManagerProfile reuses an existing Scheduled Storage Manager profile on a specified SharePoint object.

Parameters -ProfileName<String>

Specifies the name of an existing Scheduled Storage Manager profile that you want to reuse.




false


68


Specifies a SharePoint Web application to reuse the specified Scheduled Storage Manager profile to.




false


Specifies a SharePoint site collection to reuse the specified Scheduled Storage Manager profile to.




false

-SPWeb<SharePointWeb>

Specifies a SharePoint site to apply the specified Scheduled Storage Manager profile to.




false

-SPList<SharePointList>

Specifies a SharePoint list to reuse the specified Scheduled Storage Manager profile to.




false

-SPFolder<SharePointFolder>

Specifies a SharePoint folder to reuse the specified Scheduled Storage Manager profile to.

69





false

<CommonParameters>


Examples Example 1

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

PS C:\>Reuse-DAScheduledStorageManagerProfile -ProfileName 'Profile 1' -SPWeb $web

Description

These commands reuses the existing Scheduled Storage Manager profile to a SharePoint web.

Retract-DAScheduledStorageManagerProfile Retracts a specified Scheduled Storage Manager profile from a specified Web application, site collection, site, list, or folder.

Syntax Retract-DAScheduledStorageManagerProfile [-SPWebApplication] <SharePointWebApplication> [<CommonParameters>]

Retract-DAScheduledStorageManagerProfile [-SPSite] <SharePointSite> [<CommonParameters>]

Retract-DAScheduledStorageManagerProfile [-SPWeb] <SharePointWeb> [<CommonParameters>]

Retract-DAScheduledStorageManagerProfile [-SPList] <SharePointList> [<CommonParameters>]

Retract-DAScheduledStorageManagerProfile [-SPFolder] <SharePointFolder> [<CommonParameters>]

Description The Retract-DAScheduledStorageManagerProfile retracts a specified Scheduled Storage Manager profile from the specified Web application, site collection, site, list, or folder.

Parameters 70



Specifies a SharePoint Web application to retract the applied Scheduled Storage Manager profile from it.




false


Specifies a SharePoint site collection to retract the applied Scheduled Storage Manager profile from it.




false

-SPWeb<SharePointWeb>

Specifies a SharePoint site to retract the applied Scheduled Storage Manager profile from it.




false

-SPList<SharePointList>

Specifies a SharePoint list to retract the applied Scheduled Storage Manager profile from it.




false

-SPFolder<SharePointFolder>

71


Specifies a SharePoint folder to retract the applied Scheduled Storage Manager profile from it.




false

<CommonParameters>


Examples Example 1

PS C:\>$webapplication= New-Object DocAve.API.Objects.SharePointWebApplication ('Farm

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

PS C:\>Retract-DAScheduledStorageManagerProfile -SPWebApplication $webapplication

Description

These commands retract the applied Scheduled Storage Manager profile from a specified SharePoint Web application.

Platform Backup and Restore Refer to the following sections for more information.

Get-DASMSPPlatformBackupJobConfiguration Gets the default SMSP Platform Backup settings.

Syntax Get-DASMSPPlatformBackupJobConfiguration [<CommonParameters>]

Description The Get-DASMSPPlatformBackupJobConfiguration cmdlet gets the default SMSP Platform Backup settings. You can save these settings as a variable to use when running a SMSP Platform Backup job.


72



Examples Example 1

PS C:\>Get-DASMSPPlatformBackupJobConfiguration

RestoreGranularLevel : SiteCollectionLevel

DeferIndexingToMaintenanceJobs : False

GranularityIndexServer :

MountPointForIndex :

VerifyBackup : False

VerificationServer :

MountPointForVerify :

CheckOldBackupsToBeDeleted : False

RunTransactionLogBackupAfterFullDatabaseBackup : True

BackupStubDatabase : False

BackupStorageManagerBLOB : False

BackupConnectorBLOB : False

NumberOfWebFrontEndServersParallel : 1

RefreshSharePointFarmTopology : False

VerifyStorageLayout : False

GranularIndexMethod : Sequential

CheckAgentAccountPermissions : True

UpdateSnapMirrorForBLOBAfterBackup : False

UpdateSnapVaultForBLOBAfterBackup : False

UpdateSnapMirrorForStoragePolicyAfterBackup : False

UpdateSnapVaultForStoragePolicyAfterBackup : False

ArchiveBackupToSecondaryStorage : False

73


ArchiveBackupToSecondaryStorageInterval : 0

VerifyArchiveBackupOnSecondaryStorage : False

UpdateSnapMirrorForFarmComponentAfterBackup : False

VerifyOnAvailableSnapMirrorDestinationVolumes : False

CommandProfileName :

GenerateDetailedReport : True

ReplicaBackupType : PreferredBackupReplicaOnly

MinimumBackupPriority : 0

MaximumBackupPriority : 0

Description

This command gets the settings list which allows you to configure the SMSP Platform Backup job settings.

Related Links Run-DASMSPPlatformBackupJob

Run-DASMSPPlatformBackupJob Runs an existing SMSP Platform Backup plan.

Syntax Run-DASMSPPlatformBackupJob [-PlanName] <String> [-JobConfiguration] <SMSPPlatformBackupJobConfiguration> [-WaitForJobComplete <>] [<CommonParameters>]

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

Description The Run-DASMSPPlatformBackupJob cmdlet runs or performs a test run of an existing SMSP Platform Backup plan according to the configured backup settings.

Parameters -PlanName<String>

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




false

74


-JobConfiguration<SMSPPlatformBackupJobConfiguration>

This parameter is optional when the TestRun parameter is used. Specify the job configuration variable that contains the backup job settings you want to use.




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.




-TestRun[<SwitchParameter>]

This parameter is optional when the JobConfiguration parameter is used. Enter this parameter to simulate the execution of the selected plan.



false 1 false false

<CommonParameters>


Examples Example 1

PS C:\>$info = Get-DASMSPPlatformBackupJobConfiguration

PS C:\>$info.RestoreGranularLevel = 'SiteLevel'

75


PS C:\>$info.DeferIndexingToMaintenanceJobs = $true

PS C:\>$info.BackupConnectorBLOB = $true

PS C:\>$info.CheckAgentAccountPermissions = $true;

PS C:\>$info.NumberOfWebFrontEndServersParallel = 10;

PS C:\>$info.VerifyArchiveBackupOnSecondaryStorage = $false;

PS C:\>$info.RefreshSharePointFarmTopology = $true;

PS C:\>$info.GranularIndexMethod = 'Sequential'

PS C:\>$info.GranularIndexMethod = 'Parallel'

PS C:\>$info.UpdateSnapMirrorAfterBLOBBackup = $true

PS C:\>$info.UpdateSnapVaultAfterBLOBBackup = $false

PS C:\>$info.UpdateSnapMirrorAfterBackup = $true

PS C:\>$info.UpdateSnapVaultAfterBackup = $false

PS C:\>$info.ArchiveBackupToSecondaryStorage = $true

PS C:\>$info.ArchiveBackupToSecondaryStorageInterval = 'Daily'

PS C:\>$info.UpdateSnapMirrorAfterDatabaseAndIndexBackup = $true

PS C:\>$info.VerifyOnAvailableSnapMirrorDestinationVolumes = $true

PS C:\>$info.GenerateDetailedReport = $true

PS C:\>$info.CommandProfileName = 'CmdProfile01'

PS C:\>$info.ReplicaBackupType = 'PreferredBackupReplicaOnly'

PS C:\>

PS C:\>Run-DASMSPPlatformBackupJob -PlanName 'plan1' -JobConfiguration $info -WaitForJobComplete

ID : FB20120525112704235532

PlanName : plan1

Module : PlatformBackup

Status : Finished

StartTime : 2012/5/25 11:27:04

FinishTime : 2012/5/25 11:35:30

76


Progress : 100

Description

This command, using specified plan name, performs a SMSP backup job with the configured backup settings.

Related Links Get-DASMSPPlatformBackupJobConfiguration

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

Description The Get-DADate cmdlet gets an instance of Date, which represents year, month or day. The instance returned also includes the time zone information.

Parameters -Year<Int32>

Specifies the year that is displayed. Valid value is between 1 and 9999.



true 0 false false

-Month<Int32>

Specifies the month that is displayed. Valid value is between 1 and 12.



true 1 false false

77


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


Examples Example 1


PS C:\>Get-DADate -Year 2012 -Month 03 -Day 20 -TimeZoneId $TimeZoneID

Year : 2012

Month : 3

Day : 20

TimeZone : DocAve.API.Common.TimeZoneInfo

AutomaticallyAdjustClockForDaylightSavingTime : False

Description

This command shows how to get Date instance.

78


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

Description The Get-DADate cmdlet gets an instance of DateTime, which represents year, month, day, hour or minute. The instance returned also includes the time zone information.

Parameters -Year<Int32>

Specifies the year that is displayed. Valid value is between 1 and 9999.



true 0 false false

-Month<Int32>

Specifies the month that is displayed. Valid value is between 1 and 12.



true 1 false false

-Day<Int32>

Specifies the day that is displayed. Valid value is between 1 and 31.



true 2 false false

-Hour<Int32>

79


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>


Examples Example 1


PS C:\>Get-DADateTime -Year 2012 -Month 03 -Day 20 -Hour 14 -Minute 30 -TimeZoneId $TimeZoneID

Year : 2012

Month : 3

80


Day : 20

Hour : 14

Minute : 30

TimeZone : DocAve.API.Common.TimeZoneInfo

AutomaticallyAdjustClockForDaylightSavingTime : False

Description

This command shows how to get DateTime instance.

Related Links Get-DADate

Get-DAAllSupportedTimeZoneIds Gets the IDs of all supported time zones.

Syntax Get-DAAllSupportedTimeZoneIds [<CommonParameters>]

Description The Get-DAAllSupportedTimeZoneIds gets the IDs of all supported time zones.



Agent Monitor Refer to the following sections for more information.

Get-DAAgentService Gets the Agent services.

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

Description The Get-DAAgentService cmdlet gets information about the Agent services.

81


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.




true

<CommonParameters>


Examples Example 1

PS C:\>Get-DAAgentService

Name Status AccountName

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

agent1 Down mydomain\account1

agent2 Up mydomain\account2

agent3 Down mydomain\account3

Description

This command gets the Agent services.

Update-DAAgentService Updates an existing Agent service.

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

Description The Update-DAAgentService cmdlet updates an existing Agent service.

82


Parameters -AgentService<AgentService>

Specifies an Agent service for updating.




false

<CommonParameters>


Examples Example 1

PS C:\>$agent = Get-DAAgentService -Name 'agent1'

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

*****

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

PS C:\>Update-DAAgentService -AgentService $agent

Description

These commands update the account settings of the specified Agent service.

Account Manager Refer to the following sections for more information.

Get-DALocalUser Gets the information about the existing local user(s).

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

Description The Get-DALocalUser cmdlet gets the information about the existing local user(s).

83



Specifies the name(s) of the local user(s) you want to get. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all the existing local users will be gotten.




true

<CommonParameters>


Examples Example 1

PS C:\>Get-DALocalUser

Name : user1

Email : [email protected]

Password :

SecuritySettings : DocAve.API.ControlPanel.AccountManager.SecuritySettings

SecuritySettingsType : Customized

Type : Local User

Description : this is a user.

Mode : Active

UserGroupType : System Group

SystemGroups : {system group 01}

TenantGroup :

InAdministratorsGroup : False

84


Description

This command gets the information of all the existing local users.

Related Links Update-DAUser

Get-DABlankLocalUser Gets a blank local user for adding a new local user.

Syntax Get-DABlankLocalUser [<CommonParameters>]

Description The Get-DABlankLocalUser cmdlet gets a blank local user for adding a new local user.



Examples Example 1

PS C:\>Get-DABlankLocalUser

Name :

Email :

Password :

SecuritySettings : DocAve.API.ControlPanel.AccountManager.SecuritySettings

SecuritySettingsType : Default

Type : Local User

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

85


TenantGroup :


Description

This command retrieves a blank Local User.

Related Links New-DAUser

Get-DAActiveDirectoryUser Gets information about the existing active directory user(s).

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

Description The Get-DAActiveDirectoryUser cmdlet gets the information about the existing active directory user(s).


Specifies the name(s) of the active directory user(s) you want to get. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all the existing active directory users will be returned.




true

<CommonParameters>


Examples Example 1

PS C:\>$user = Get-DAActiveDirectoryUser

PS C:\>$user

86


Name : example.com\user1


Type : Active Directory User

Description :

Mode : Active

UserGroupType : System Group

SystemGroups : {system group 01}

TenantGroup :


Description

This command gets information about all the existing active directory users.


Get-DABlankActiveDirectoryUser Gets a blank active directory user for creating an AD user.

Syntax Get-DABlankActiveDirectoryUser [<CommonParameters>]

Description The Get-DABlankActiveDirectoryUser cmdlet gets a blank active directory user for creating an AD user.



Examples Example 1

PS C:\>Get-DABlankActiveDirectoryUser

87


Name :

Email :

Type : Active Directory User

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

TenantGroup :


Description

This command gets a blank active directory user.


Get-DAActiveDirectoryGroup Gets the information of the existing active directory group(s).

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

Description The Get-DAActiveDirectoryGroup cmdlet gets the information of the existing active directory group(s).


Specifies the name(s) of the active directory group(s) you want to get. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all the existing active directory groups will be got.




true

<CommonParameters>

88



Examples Example 1

PS C:\>$user = Get-DAActiveDirectoryGroup

PS C:\>$user

Name : example.com\group1


Type : Active Directory Group

Description : this is an active directory group.

Mode : Active

UserGroupType : Tenant Group

SystemGroups : {}

TenantGroup : tenant group 01


Description

This command gets the information of all the existing active directory groups.


Get-DABlankActiveDirectoryGroup Gets a blank active directory group for creating an AD group.

Syntax Get-DABlankActiveDirectoryGroup [<CommonParameters>]

Description The Get-DABlankActiveDirectoryGroup cmdlet gets a blank active directory group for creating an AD group.

Parameters

89


<CommonParameters>


Examples Example 1

PS C:\>$user = Get-DABlankActiveDirectoryGroup

PS C:\>$user

Name :

Email :

Type : Active Directory Group

Description :

Mode : Unknown

UserGroupType :

SystemGroups : {}

TenantGroup :


Description

This command gets a blank active directory group.


New-DAUser Creates a new user according to the user object that you specified.

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

Description The New-DAUser cmdlet creates a new user according to the specified user object.

90


Parameters -User<UserBase>

Specifies a user object to create a new user. For the structure and attributes of the user object, please refer to the DocAve 6 SDK documentation for more information.




<CommonParameters>


Examples Example 1

PS C:\>$user = Get-DABlankLocalUser

PS C:\>$user.Name = 'user1'

PS C:\>$user.Email = '[email protected]'

PS C:\>$user.Password = Read-Host -AsSecureString

*********

PS C:\>$user.Description = 'This is a Local User'

PS C:\>

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

PS C:\>$groups.Add('system group 01')

PS C:\>$user.SetSystemGroups($groups)

PS C:\>

PS C:\>$user.SetSecuritySettingsType('Customized')

PS C:\>$user.SecuritySettings.AccountIsInactive = $false

PS C:\>$user.SecuritySettings.UserMustChangePasswordAtNextLogon = $true

PS C:\>New-DAUser -User $user

Description

91


These commands create a new local user.

Example 2

PS C:\>$user = Get-DABlankActiveDirectoryUser

PS C:\>$user.Name = 'example.com\user1'

PS C:\>$user.SetTenantGroup('tenant group 01')

PS C:\>New-DAUser -User $user

Description

These commands create a new active directory user.

Related Links Get-DABlankActiveDirectoryUser

Get-DABlankLocalUser

Update-DAUser

Get-DABlankActiveDirectoryGroup

Update-DAUser Updates an existing user according to the user object that you specified.

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

Description The Update-DAUser cmdlet updates an existing user according to the user object that you specified.

Parameters -User<UserBase>

Specifies a user object where you want to edit the user.




<CommonParameters>

92



Examples Example 1

PS C:\>$user = Get-DALocalUser -Name 'user1'

PS C:\>$user.Email = '[email protected]'

PS C:\>Update-DAUser -User $user

Description

These commands update the e-mail information of the specified local user.

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

Description The Remove-DAActiveDirectoryGroup cmdlet deletes an existing active directory group according to the group's name.


Specifies the name of an active directory group that you want to delete.




-WhatIf[<SwitchParameter>]

93


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




-Confirm[<SwitchParameter>]

Prompts you for confirmation before executing the command.




<CommonParameters>


Examples Example 1

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

Description

This command deletes the specified active directory group.

Related Links Get-DAActiveDirectoryGroup

Remove-DAActiveDirectoryUser Deletes an existing active directory user according to the user's name.

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

Description The Remove-DAActiveDirectoryUser cmdlet deletes an existing active directory user according to the user's name.

94



Specifies the name of an active directory user that you want to delete.














<CommonParameters>


Examples Example 1

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

Description

This command deletes the specified active directory user.

Related Links

95


Get-DAActiveDirectoryUser

Remove-DALocalUser Deletes an existing local user according to the user's name.

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

Description The Remove-DALocalUser cmdlet deletes an existing local user according to the user's name.


Specifies the name of a local user that you want to delete.














<CommonParameters>

96



Examples Example 1

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

Description

This command deletes the specified local user.

Related Links Get-DALocalUser

Get-DASiteCollectionTenantGroup Gets the information of the existing site collection tenant group(s).

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

Description The Get-DASiteCollectionTenantGroup cmdlet gets the information of the existing site collection tenant group(s).


Specifies the name(s) of the site collection tenant 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 site collection tenant groups will be gotten.




false

<CommonParameters>


97


Examples Example 1

PS C:\> Get-DASiteCollectionTenantGroup

GroupType : SiteCollectionTenentGroup

PermissionLevelNames : {Tenant Permission Level}

PowerUsernames : {user1}

StandardUsernames : {user2}

Name : Site Collection Tenant group

Description :

Description

This command gets the information of all of the existing site collection tenant groups.

Related Links Update-DAGroup

Get-DASystemGroup Gets information about the existing system group(s).

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

Description The Get-DASystemGroup cmdlet gets information about the existing system group(s).


Specifies the name(s) of the system 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 system groups will be gotten.




false

98


<CommonParameters>


Examples Example 1

PS C:\> Get-DASystemGroup

GroupType : SystemGroup

Permissions : {N/A}

Usernames : {user1}

ScopeType : Global

Name : System group

Description :

Description

This command gets information about all of the existing system groups.


Get-DAWebApplicationTenantGroup Gets the information of the existing Web application tenant group(s).

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

Description The Get-DAWebApplicationTenantGroup cmdlet gets the information of the existing Web application tenant group(s).


99


Specifies the name(s) of the web application tenant 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 web application tenant groups will be gotten.




false

<CommonParameters>


Examples Example 1

PS C:\> Get-DAWebApplicationTenantGroup

GroupType : WebApplicationTenentGroup

PermissionLevelNames : {TenantPermission01}

Scope : DocAve.API.ControlPanel.AccountManager.WebApplicationScope

PowerUsernames : {user1}

StandardUsernames : {user2}

Name : WebApplicationTenantGroup

Description :

Description

This command gets the information of all of the existing Web application tenant groups.


Get-DABlankGroup Gets a blank group for creating a new group.

100


Syntax Get-DABlankGroup [-SystemGroup <>] [<CommonParameters>]

Get-DABlankGroup [-WebApplicationTenantGroup <>] [<CommonParameters>]

Get-DABlankGroup [-SiteCollectionTenantGroup <>] [<CommonParameters>]

Description The Get-DABlankGroup cmdlet gets a blank group for creating a new group.

Parameters -SystemGroup[<SwitchParameter>]

Whether to get a blank system group.




-WebApplicationTenantGroup[<SwitchParameter>]

Whether to get a blank Web application tenant group.




-SiteCollectionTenantGroup[<SwitchParameter>]

Whether to get a blank site collection tenant group.




<CommonParameters>


Examples

101


Example 1

PS C:\> Get-DABlankGroup -SystemGroup

GroupType : SystemGroup

Permissions : {}

Usernames : {}

ScopeType : Global

Name :

Description :

Description

This command gets a blank system group.

Example 2

PS C:\> Get-DABlankGroup -WebApplicationTenantGroup

GroupType : WebApplicationTenentGroup

PermissionLevelNames : {}

Scope : DocAve.API.ControlPanel.AccountManager.WebApplicationScope

PowerUsernames : {}

StandardUsernames : {}

Name :

Description :

Description

This command gets a blank Web application tenant group.

Example 3

PS C:\> Get-DABlankGroup -SiteCollectionTenantGroup

102


GroupType : SiteCollectionTenentGroup

PermissionLevelNames : {}

PowerUsernames : {}

StandardUsernames : {}

Name :

Description :

Description

This command gets a blank site collection tenant group.

Related Links New-DAGroup

New-DAGroup Creates a new group according to the group object that you specified.

Syntax New-DAGroup [-Group] <GroupBase> [<CommonParameters>]

Description The New-DAGroup cmdlet creates a new group according to the specified group object.

Parameters -Group<GroupBase>

Specifies a group object to create a new group. For the structure and attributes of group, please refer to the DocAve 6 SDK documentation for more information.




<CommonParameters>


Examples Example 1

103


PS C:\> $group = Get-DABlankGroup -SystemGroup

PS C:\> $group.Name = 'SystemGroup01'

PS C:\> $group.Description = 'This is new system group.'

PS C:\> $group.ScopeType = 'Global'

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

PS C:\> $list.Add('SystemPermission01')

PS C:\> $group.SetPermissionForGlobal($list)

PS C:\> $group.AddUser('user01')

PS C:\> New-DAGroup -Group $group

Description

These commands create a new system group.

Example 2

PS C:\> $group = Get-DABlankGroup -WebApplicationTenantGroup

PS C:\> $group.Name = 'WebAppGroup01'

PS C:\> $group.Description = 'This is a new webapplicationtenant group.'

PS C:\> $group.PermissionLevelNames.Add('TenantPermission01')

PS C:\> $group.Scope.Include('Farm(SQL\SP2010:SHAREPOINT_CONFIG)')

PS C:\> $group.AddPowerUser('user01')

PS C:\> $group.AddStandardUser('user02')


Description

These commands create a new Web application tenant group.

Example 3

PS C:\> $group = Get-DABlankGroup -SiteCollectionTenantGroup

PS C:\> $group.Name = 'SiteCollectionGroup01'

PS C:\> $group.Description = 'This is a new site collection tenant group.'


PS C:\> $group.AddPowerUser('user01')


104



Description

These commands create a new site collection tenant group.

Related Links Get-DABlankGroup

Update-DAGroup

Update-DAGroup Updates an existing group according to the group object that you specified.

Syntax Update-DAGroup [-Group] <GroupBase> [<CommonParameters>]

Description The Update-DAGroup cmdlet updates an existing group according to the group object that you specified.

Parameters -Group<GroupBase>

Specifies a group object that you want to edit. For the structure and attributes of group, please refer to the DocAve 6 SDK documentation for more information.




<CommonParameters>


Examples Example 1

PS C:\> $group = Get-DASystemGroup -Name 'SystemGroup01'

PS C:\> $group.Name = 'SystemGroup02'

PS C:\> $group.Description = 'This is a update system group.'

PS C:\> $group.ScopeType = 'Particular'

105


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



PS C:\> $group.SetPermissionForFarm("Farm(SQL\SP2010:SHAREPOINT_CONFIG)",$list)

PS C:\> Update-DAGroup -Group $group

Description

These commands update the information of the specified system group.

Example 2

PS C:\> $group = Get-DAWebApplicationTenantGroup -Name 'WebAppGroup01'

PS C:\> $group.Name = 'WebAppGroup02'

PS C:\> $group.Description = 'This is a update webapplicationtenant group.'

PS C:\> $group.PermissionLevelNames.Remove('TenantPermission01')


PS C:\> $FarmName = 'Farm(SQL\SP2010:SHAREPOINT_CONFIG)'

PS C:\> $WebAppUrl = 'http://SharePoint2010:10001/'

PS C:\> $SPObject = New-Object -TypeName 'DocAve.API.Objects.SharePointWebApplication' -ArgumentList $FarmName,$WebAppUrl

PS C:\> $group.Scope.Exclude($SPObject)


Description

These commands update the information of the specified Web application tenant group.

Example 3

PS C:\> $group = Get-DASiteCollectionTenantGroup -Name 'SiteCollectionGroup01'

PS C:\> $group.Name = 'SiteCollectionGroup02'

PS C:\> $group.Description = 'This is a update site collection tenant group.'

PS C:\> $group.PermissionLevelNames.Remove('TenantPermission01')


PS C:\> $group.RemoveStandardUser('user02')


106



Description

These commands update the information of the specified site collection tenant group.

Related Links Get-DASystemGroup

Get-DAWebApplicationTenantGroup

Get-DASiteCollectionTenantGroup

New-DAGroup

Remove-DAGroup Deletes an existing group according to the group name.

Syntax Remove-DAGroup [-Name] <String> [-WhatIf <>] [-Confirm <>] [<CommonParameters>]

Description The Remove-DAGroup cmdlet deletes an existing group according to the group name.


Specifies the name of a group that you want to delete.










107






<CommonParameters>


Examples Example 1

PS C:\> Remove-DAGroup -Name 'group1'

PS C:\>

Description

This command deletes the specified group.

Related Links Get-DASystemGroup

Get-DAWebApplicationTenantGroup

Get-DASiteCollectionTenantGroup

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

Description The Backup-DADatabaseEncryptionKey cmdlet backs up the DocAve database encryption key to a file under the specified path.

Parameters

108


-Path<String>

Specifies the path in which to store the backup file.



true 0 false false


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




<CommonParameters>


Examples Example 1

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

Description

This command shows how to back up DocAve database encryption key.

Related Links Restore-DADatabaseEncryptionKey

Restore-DADatabaseEncryptionKey Restores DocAve database encryption key.

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

Description

109


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.


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


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




-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

110


<CommonParameters>


Examples Example 1

PS C:\>Restore-DADatabaseEncryptionKey -Path 'C:\backup' -OutPut 'C:\sql'

Description

This command shows how to restore DocAve database encryption key.

Example 2

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

Description

This command shows how to restore DocAve database encryption key with a passphrase.

Related Links Backup-DADatabaseEncryptionKey

Backup-DADataEncryptionProfile Backs up DocAve data encryption profile.

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

Description The Backup-DADataEncryptionProfile cmdlet exports all of the DocAve security profiles that can be accessed by the system users to a compressed file under the specified path.


Specifies a path to store the backup file.



true 0 false false

111



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




<CommonParameters>


Notes Data encryption profile was renamed to "security profile" in DocAve 6 SP1.

Examples Example 1

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

Description

This command shows how to back up DocAve data encryption profile.

Related Links Restore-DADataEncryptionProfile

Restore-DADataEncryptionProfile Restores the DocAve data encryption profile.

Syntax Restore-DADataEncryptionProfile [-Path] <String> [<CommonParameters>]

Description The Restore-DADataEncryptionProfile cmdlet imports the exported DocAve security profiles from the compressed file under the specified path.


Specifies a path to load the backup file.

112




true 0 false false

<CommonParameters>


Notes The Data encryption profile has been renamed to Security profile in DocAve 6 SP1.

Examples Example 1

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

Description

This command shows how to restore DocAve data encryption profile.

Related Links Backup-DADataEncryptionProfile

Set-DAPassPhrase Sets up a new value for the passphrase.

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

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

Description The Set-DAPassPhrase cmdlet sets up a new value for the passphrase. If the LocalServerOnly parameter is not used, the DocAve database encryption key will be re-encrypted with the new value and attempts to propagate this value to all other servers in this DocAve system. If the LocalServerOnly parameter is used, this is updated on the local machine only, and the DocAve database encryption key is not changed. The passphrase value must be same on all servers in DocAve system for the DocAve system to function correctly. 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.

113


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.




<CommonParameters>


Examples Example 1

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

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

PS C:\>Set-DAPassPhrase -PassPhrase $passphrase -ConfirmPassPhrase $ConfirmPassPhrase

Description

114


This command shows how to set up a new value for the passphrases of all the servers in DocAve system.

Example 2

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

PS C:\>Set-DAPassPhrase -PassPhrase $passphrase -LocalServerOnly

Description

This command shows how to set up a new value for the passphrase of the local machine in DocAve system.

Set-DAFipsAlgorithmPolicy Sets up the status of FipsAlgorithmPolicy.

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

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

Description The Set-DAFipsAlgorithmPolicy cmdlet sets up the status of FipsAlgorithmPolicy. The status of the FipsAlgorithmPolicy on all of DocAve servers must be the same. After setting up the status, you must restart all the DocAve services on each server.

Parameters -Disabled[<SwitchParameter>]

Enters this parameter to disable the FipsAlgorithmPolicy.



false 1 false false

-Enabled[<SwitchParameter>]

Enters this parameter to enable the FipsAlgorithmPolicy.



false 0 false false

<CommonParameters>

115



Examples Example 1

PS C:\>Set-DAFipsAlgorithmPolicy -Enabled

Description

This command shows how to enable the FipsAlgorithmPolicy.

Example 2

PS C:\>Set-DAFipsAlgorithmPolicy -Disabled

Description

This command shows how to disable the FipsAlgorithmPolicy.

Physical Device Refer to the following sections for more information.

Get-DAPhysicalDevice Gets the detailed information about the specified physical device(s).

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

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

Description The Get-DAPhysicalDevice cmdlet gets the detailed information about the physical device(s).


Specifies one or more physical device names. Multiple physical device names must be separated by commas. Wildcards are supported. If you do not type any value for the parameter, the information of all the physical devices will be returned.

116





true

-Type<StorageType>

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

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

StorageType : DataONTAPCIFSShare

StorageSystemProfile : storage system profile1

ShareName : FilerA: sharename1

UNCPath : \\10.0.0.1\sharename2

FreeSpace : 2.06105G

TotalSize : 7G

IsSnapLock : False

Username : example.com\user1

Password :

117


ExtendedParameters :

Farms : {Farm(SP2010_DB:SHAREPOINT_CONFIG)}

SpaceThreshold : 1024MB

Name : physical device1

Description : this is a CIFS Share physical device

SpaceUsage : 2.06GB free of 7.00GB

Description

This command gets the detailed information of the physical device whose name is 'physical device1'.

Example 2

PS C:\>Get-DAPhysicalDevice






TotalSize : 7G

IsSnapLock : False


Password :


Farms : {}



Description : this is a physical device



118






TotalSize : 4G

IsSnapLock : True


Password :

ExtendedParameters : SnapLockEnabled = True

Farms : {Farm(SP2010_DB:SHAREPOINT_CONFIG)}



Description :


Description

This command gets the detailed information of all the physical devices.

Example 3

PS C:\>Get-DAPhysicalDevice -Type DataONTAPCIFSShare






TotalSize : 4G

IsSnapLock : False


Password :

119



Farms : {}



Description :


Description

This command gets the detailed information of the physical device whose storage type is DataONTAPCIFSShare.

Related Links New-DAPhysicalDevice

Get-DABlankPhysicalDevice Gets a blank physical device for creating a new physical device.

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

Description The Get-DABlankPhysicalDevice cmdlet gets a blank physical device for creating a new physical device.

Parameters -Type<String>

Specifies a storage type for the physical device. Valid values are "DataONTAPCIFSShare" and "NetShare".




<CommonParameters>


Examples

120


Example 1

PS C:\>Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare


StorageSystemProfile :

ShareName :

UNCPath :

FreeSpace :

TotalSize :

IsSnapLock : False

Username :

Password :


Farms : {}


Name :

Description :

SpaceUsage :

Description

This command gets a blank Data ONTAP (CIFS Share) physical device.

Related Links New-DAPhysicalDevice

New-DAPhysicalDevice Creates a new physical device.

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

Description The New-DAPhysicalDevice cmdlet creates a new physical device.

121


Parameters -PhysicalDevice<PhysicalDeviceBase>

Specifies a physical device object. For more information about the structure and attributes of the physical device object, refer to the DocAve SDK Documentation for more information.




<CommonParameters>


Examples Example 1

PS C:\>$device = Get-DABlankPhysicalDevice -Type DataONTAPCIFSShare

PS C:\>$device.Name = 'physical device1'

PS C:\>$device.StorageSystemProfile = 'storage system profile1'

PS C:\>$device.ShareName = 'FilerA: sharename1'

PS C:\>$device.AccountProfile = 'example.com\user1'

*********

PS C:\>$device.SpaceThreshold = '1300MB'

PS C:\>$device.ExtendedParameters = 'SnapLockEnabled = True'

PS C:\>$device.Farms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

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

PS C:\>

Description

These commands create a Data ONTAP (CIFS Share) physical device.

Example 2

PS C:\>$device = Get-DABlankPhysicalDevice -Type NetShare


122


PS C:\>$device.Description = 'Description'

PS C:\>$device.SpaceThreshold = '1024MB'

PS C:\>$device.ExtendedParameters.Add("AuthMethod=NetUse")

PS C:\>$device.ExtendedParameters.Add("IsRetry=true")

PS C:\>$device.UNCPath = '\\admin-PC\c$\data'

PS C:\>$device.AccountProfile = 'example.com\user1'

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

PS C:\>

Description

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

Description The Update-DAPhysicalDevice cmdlet updates an existing physical device.

Parameters -PhysicalDevice<PhysicalDeviceBase>

Specifies an existing physical device object to be updated.




<CommonParameters>


Examples 123


Example 1

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



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

PS C:\>

Description

These commands update the specified physical device.

Related Links Get-DAPhysicalDevice

Remove-DAPhysicalDevice Deletes an existing physical device.

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

Description The Remove-DAPhysicalDevice cmdlet deletes an existing physical device.


Specifies the name of an existing physical device that you want to delete.






124










<CommonParameters>


Examples Example 1

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

Description

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 about the specified logical devices.

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

Description The Get-DALogicalDevice cmdlet gets the information about the specified logical devices.

125



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




true

<CommonParameters>


Examples Example 1

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

Name : logical device1

Description : this is a logical device.

StorageType : FTP

PhysicalDeviceList : {physical device1}

Description

This command gets the information about the logical device whose name is logical device1.

Example 2

PS C:\>Get-DALogicalDevice


Description : this is a logical device.

126


StorageType : FTP



Description :

StorageType : NetShare


Description

This command gets the information of all the logical devices.

Related Links Update-DALogicalDevice

Get-DABlankLogicalDevice Gets a blank logical device for creating a new logical device

Syntax Get-DABlankLogicalDevice [<CommonParameters>]

Description The Get-DABlankLogicalDevice cmdlet gets a blank logical device for creating a new physical device.



Examples Example 1

PS C:\>Get-DALogicalDevice

Name :

Description :


127


PhysicalDeviceList :

Description

This command gets a blank logical device.

Related Links New-DALogicalDevice

New-DALogicalDevice Creates a new logical device.

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

Description The New-DALogicalDevice cmdlet creates a new logical device.

Parameters -LogicalDevice<LogicalDevice>

Specifies a logical device object. For more about the structure and attribute of the Logical Device object, please refer to the DocAve SDK documentation for more information.




<CommonParameters>


Examples Example 1

PS C:\>$device = Get-DABlankLogicalDevice

PS C:\>$device.name = 'Logical Device'


PS C:\>$device.StorageType = 'NetShare'

PS C:\>$entity1 = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 1')

128




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

PS C:\>$device.AddPhysicalDevice($entity1)



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

PS C:\>

Description

These commands show how to create a logical device.

Related Links Get-DABlankLogicalDevice

Update-DALogicalDevice Updates an existing logical device.

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

Description The Update-DALogicalDevice cmdlet updates an existing logical device.

Parameters -LogicalDevice<LogicalDevice>

Specifies a logical device object to be updated.

129





<CommonParameters>


Examples Example 1

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

PS C:\>$device | fl


Description : description



PS C:\>$device.RemovePhysicalDevice('physical device1')

PS C:\>$entity = New-Object Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 2')

PS C:\>$entity.StorageIndex =$true

PS C:\>$entity.StorageData =$true

PS C:\>$device.AddPhysicalDevice($entity)

PS C:\>$device.PhysicalDeviceList | fl


130


StorageData : True

StorageIndex : True

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

PS C:\>

Description

These commands update an existing logical device.

Related Links Get-DALogicalDevice

Remove-DALogicalDevice Deletes an existing logical device.

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

Description The Remove-DALogicalDevice cmdlet deletes an existing logical device.


Specifies the name of the logical device that you want to delete.






131










<CommonParameters>


Examples Example 1

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

Description

This command deletes the specified logical device.

Related Links Get-DALogicalDevice

Storage Policy Refer to the following sections for more information.

Get-DAStoragePolicy Gets information about the specified storage policies.

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

Description The Get-DAStoragePolicy cmdlet gets information about the specified storage policies.

132



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




true

<CommonParameters>


Examples Example 1

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

Name : storage policy

Description : this is a storage policy.

PrimaryStorage : logical device 1

MediaServiceUseStrategy : DefaultPriority

MediaServiceNames : {service1}

EnableRetentionRule : False

StoragePolicyType : None

Description

This command gets the information of the storage policy whose name is 'storage policy'.

Related Links Update-DAStoragePolicy

133


Get-DABlankStoragePolicy Gets a blank storage policy for creating a new storage policy.

Syntax Get-DABlankStoragePolicy [<CommonParameters>]

Description The Get-DABlankStoragePolicy cmdlet gets a blank storage policy for creating a new storage policy.



Examples Example 1

PS C:\>Get-DABlankStoragePolicy

Name :

Description :

PrimaryStorage :

MediaServiceUseStrategy : DefaultPriority

MediaServiceNames : {}

EnableRetentionRule : False

StoragePolicyType : None

Description

This command gets a blank storage policy.

Related Links New-DAStoragePolicy

New-DAStoragePolicy Creates a new storage policy.

134


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

Description The New-DAStoragePolicy cmdlet creates a new storage policy.

Parameters -StoragePolicy<StoragePolicy>

Specifies a storage policy object. About the structure and attributes of the storage policy, refer to the DocAve SDK Documentation for more information.




<CommonParameters>


Examples Example 1

PS C:\>$policy = Get-DABlankStoragePolicy

PS C:\>$policy.Name = 'storage policy 01'

PS C:\>$policy.Description = 'This is a new storage policy'

PS C:\>$policy.PrimaryStorage = 'logical device 01'

PS C:\>$policy.MediaServiceUseStrategy = 'CustomPriority'

PS C:\>$policy.MediaServiceNames.Add('service1')

PS C:\>$policy.MediaServiceNames.Add('service2')

PS C:\>New-DAStoragePolicy -StoragePolicy $policy

PS C:\>

Description

These commands create a storage policy.

Related Links Get-DABlankStoragePolicy

135


Update-DAStoragePolicy Updates an existing storage policy.

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

Description The Update-DAStoragePolicy cmdlet updates an existing storage policy.

Parameters -StoragePolicy<StoragePolicy>

Specifies an existing storage policy to be updated.




<CommonParameters>


Examples Example 1

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

PS C:\>$policy.Name = 'storage policy 2'

PS C:\>$policy.Description = 'updates the storage policy'

PS C:\>$policy.MediaServiceUseStrategy ='DefaultPriority'

PS C:\>Update-DAStoragePolicy -StoragePolicy $policy

PS C:\>

Description

These commands update an existing storage policy.

Related Links New-DAStoragePolicy

Get-DAStoragePolicy

136


Remove-DAStoragePolicy Deletes an existing storage policy.

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

Description The Remove-DAStoragePolicy cmdlet deletes an existing storage policy.


Specifies the name of the storage policy that you want to delete.














<CommonParameters>


137


Examples Example 1

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

Description

This command deletes the specified storage policy.

Related Links Get-DAStoragePolicy

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

Description The Upload-DAUpdate cmdlet uploads the upate to manager.


Specifies the path of the update file.





Allows the cmdlet to overwrite an existing update.




138


<CommonParameters>


Examples Example 1

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

Description

This command uploads the update to manager and will overwrite the update if existed.

Related Links Get-DAUpdate

Get-DAUpdate Gets information about the DocAve update(s).

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

Description The Get-DAUpdate cmdlet gets information about the DocAve update(s) according to the name you specified. If you do not set any value for the parameter, all the updates will be returned.


Specifies one or more updates' names. You can type multiple update names (separated by commas). Wildcards are supported.




true

<CommonParameters>

139



Examples Example 1

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

Name : HotFix_6.0.0.51008601

Type : Optional

Size : 52812417

Status : ReadyForInstall

PublishTime : 11/3/2011 5:29:37 PM

Description

This command retrieves information about the update named 'HotFix_6.0.0.51008601'.

Related Links Install-DAUpdate

Get-DAUpdateConfiguration Gets information about an update's configuration.

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

Description The Get-DAUpdateConfiguration cmdlet gets information about the configuration of a specified update.

Parameters -UpdateName<String[]>

Specifies one or more udpates' names. You can type multiple update names(separated by commas).




140


<CommonParameters>


Examples Example 1

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

UpdateNames : {Hotfix_6.0.0.51008601}

UpdateManager : False

UpdateFarms : {}

UpdateSQLAgents : {}

UpdateNonFarmRelatedAgent : False

Description

This command retrieves the update configuration base on update 'Hotfix_6.0.0.51008601'.


Test-DAUpdate

Test-DAUpdate Tests whether or not the specified hotfix can be used to update DocAve.

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

Description The Test-DAUpdate cmdlet tests whether or not the specified hotfix can be used to update DocAve by

Parameters -Configuration<UpdateConfiguration>

Specifies an update configuration object.

141





<CommonParameters>


Examples Example 1

PS C:\>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_6.0.0.51008601'

PS C:\>$config.UpdateManager = $true

PS C:\>$config.ViewServiceForUpdate()

Category : 127.0.0.1

WillUpdate : True

Name : Control Service

Status : ACTIVE

Version : 6.0.0.51008601

Type : Control

Message : Ready for installing.

PS C:\>$config.UpdateNonFarmRelatedAgent = $true

PS C:\>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

PS C:\>$config.UpdateSQLAgents.Add('SQL Agent')

PS C:\>$config.RestartIIS = $true

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

PS C:\>Test-DAUpdate -Configuration $config

True

Description

142


This command looks at the specified hotfix to determine if there are any warnings. If there are no warnings, these commands return True, if there are warnings, it prints the warnings.


Install-DAUpdate Installs DocAve update.

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

Description The Install-DAUpdate cmdlet installs update based on the update configuration.

Parameters -Configuration<UpdateConfiguration>

Specifies an update configuration object.














143


<CommonParameters>


Notes If you want to reuse codes based on DocAve SDK, or PowerShell scripts based on DocAve Management Shell after updating DocAve, please refer to the User Guide for updating DocAve SDK and DocAve Management Shell. While installing the update(s) on the Control service, the Manager will be temporarily unavailable. After the update(s) have been installed, the Control service will be restarted and After installing the update(s) on the Agent server that enables any of the following Agent types: Replicator, Archiver, or Connector, IIS must be restarted to make the update(s) take effect. You can choose to manually restart IIS or restart IIS automatically using the commands as follows: PS C:\>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_6.0.0.51008601' PS C:\>$config.RestartIIS = $true Installing the update(s) will make the currently running job(s) fail or stopped.

Examples Example 1

PS C:\>$config = Get-DAUpdateConfiguration -UpdateName 'Hotfix_6.0.0.51008601'

PS C:\>$config.UpdateManager = $true

PS C:\>$config.ViewServiceForUpdate()

Category : 127.0.0.1

WillUpdate : True

Name : Control Service

Status : Up

Version : 6.0.0.51008601

Type : Control

Message : Ready for installing.

......

PS C:\>$config.UpdateNonFarmRelatedAgent = $true

PS C:\>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')

144


PS C:\>$config.UpdateSQLAgents.Add('SQL Agent')

PS C:\>$config.RestartIIS = $true

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

PS C:\>Install-DAUpdate -Configuration $config

Description

This command retrieves the update configuration base on update 'Hotfix_6.0.0.51008601'.

Related Links Test-DAUpdate

Get-DAUpdate

Mapping Manager Refer to the following sections for more information.

Export-DAColumnMapping Exports the column mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DAColumnMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DAColumnMapping cmdlet exports the column mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the column mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the column mapping profile.

145




true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the column mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Export-DAColumnMapping -Name 'ColumnMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the column mapping profile to an XML file in the specified location.

Related Links Import-DAColumnMapping

Import-DAColumnMapping Imports the specified XML file to Manager as the column mapping profile.

Syntax Import-DAColumnMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DAColumnMapping cmdlet imports the specified XML file to Manager as the column mapping profile.

Parameters

146


-Path<String>

Specifies the full path of the XML file which you are about to import to Manager as the column mapping profile.





Overwrites the existing column mapping profile with the same name as the specified XML file which you are about to import to Manager as the column mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DAColumnMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the column mapping profile.

Related Links Export-DAColumnMapping

Export-DAContentTypeMapping Exports the content type mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DAContentTypeMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

147


Description The Export-DAContentTypeMapping cmdlet exports the content type mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the content type mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the content type mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the content type mapping profile.




<CommonParameters>


Examples Example 1

148


PS C:\>Export-DAContentTypeMapping -Name 'ContentTypeMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the content type mapping profile to an XML file in the specified location.

Related Links Import-DAContentTypeMapping

Import-DAContentTypeMapping Imports the specified XML file from the specified location to Manager as the content type mapping profile.

Syntax Import-DAContentTypeMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DAContentTypeMapping cmdlet imports the specified XML file from the specified location to Manager as the content type mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the content type mapping profile.





Overwrites the existing content type mapping profile with the same name as the specified XML file which you are about to import to Manager as the content type mapping profile.




<CommonParameters>

149



Examples Example 1

PS C:\>Import-DAContentTypeMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the content type mapping profile.

Related Links Export-DAContentTypeMapping

Export-DADomainMapping Exports the domain mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DADomainMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DADomainMapping cmdlet exports the domain mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the domain mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the domain mapping profile.

150




true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the domain mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Export-DADomainMapping -Name 'DomainMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the domain mapping profile to an XML file in the specified location.

Related Links Import-DADomainMapping

Import-DADomainMapping Imports the specified XML file from the specified location to Manager as the domain mapping profile.

Syntax Import-DADomainMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DADomainMapping cmdlet imports the specified XML file from the specified location to Manager as the domain mapping profile.

Parameters

151


-Path<String>

Specifies the full path of the XML file which you are about to import to Manager as the domain mapping profile.





Overwrites the existing domain mapping profile with the same name as the specified XML file which you are about to import to Manager as the domain mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DADomainMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the domain mapping profile.

Related Links Export-DADomainMapping

Export-DAGroupMapping Exports the group mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DAGroupMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

152


Description The Export-DAGroupMapping cmdlet exports the group mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the group mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the group mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the group mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Export-DAGroupMapping -Name 'GroupMapping' -Path 'C:\mapping.xml' -Overwrite

Description

153


This command exports the group mapping profile to an XML file in the specified location.

Related Links Import-DAGroupMapping

Import-DAGroupMapping Imports the specified XML file from the specified location to Manager as the group mapping profile.

Syntax Import-DAGroupMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DAGroupMapping cmdlet imports the specified XML file from the specified location to Manager as the group mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the group mapping profile.





Overwrites the existing group mapping profile with the same name as the specified XML file which you are about to import to Manager as the group mapping profile.




<CommonParameters>


Examples Example 1

154


PS C:\>Import-DAGroupMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the group mapping profile.

Related Links Export-DAGroupMapping

Export-DALanguageMapping Exports the language mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DALanguageMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DALanguageMapping cmdlet exports the language mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the language mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the language mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the language mapping profile.

155





<CommonParameters>


Examples Example 1

PS C:\>Export-DALanguageMapping -Name 'LanguageMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the language mapping profile to an XML file in the specified location.

Related Links Import-DALanguageMapping

Import-DALanguageMapping Imports the specified XML file from the specified location to Manager as the language mapping profile.

Syntax Import-DALanguageMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DALanguageMapping cmdlet imports the specified XML file from the specified location to Manager as the language mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the language mapping profile.




156



Overwrites the existing language mapping profile with the same name as the specified XML file which you are about to import to Manager as the language mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DALanguageMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the language mapping profile.

Related Links Export-DALanguageMapping

Export-DAListNameMapping Exports the list name mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DAListNameMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DAListNameMapping cmdlet exports the list name mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the list name mapping profile you are about to export.

157





-Path<String>

Specifies the full path of the XML file where you are about to export the list name mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the list name mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Export-DAListNameMapping -Name 'ListNameMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the list name mapping profile to an XML file in the specified location.

Related Links Import-DAListNameMapping

158


Import-DAListNameMapping Imports the specified XML file from the specified location to Manager as the list name mapping profile.

Syntax Import-DAListNameMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DAListNameMapping cmdlet imports the specified XML file from the specified location to Manager as the list name mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the list name mapping profile.





Overwrites the existing list name mapping profile with the same name as the specified XML file which you are about to import to Manager as the list name mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DAListNameMapping -Path 'C:\mapping.xml' -Overwrite

Description

159


This command imports the specified XML file from the specified location to Manager as the list name mapping profile.

Related Links Export-DAListNameMapping

Export-DATemplateMapping Exports the template mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DATemplateMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DATemplateMapping cmdlet exports the template mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the template mapping profile you are about to export.




-Path<String>

Specifies the full path of the XML file where you are about to export the template mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the template mapping profile.

160





<CommonParameters>


Examples Example 1

PS C:\>Export-DATemplateMapping -Name 'TemplateMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the template mapping profile to an XML file in the specified location.

Related Links Import-DATemplateMapping

Import-DATemplateMapping Imports the specified XML file from the specified location to Manager as the template mapping profile.

Syntax Import-DATemplateMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DATemplateMapping cmdlet imports the specified XML file from the specified location to Manager as the template mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the template mapping profile.




161



Overwrites the existing template mapping profile with the same name as the specified XML file which you are about to import to Manager as the template mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DATemplateMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the specified location to Manager as the template mapping profile.

Related Links Export-DATemplateMapping

Export-DAUserMapping Exports the user mapping profile from the Manager to an XML file in the specified location.

Syntax Export-DAUserMapping [-Name] <String> [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DAUserMapping cmdlet exports the user mapping profile from the Manager to an XML file in the specified location.


Specifies the name of the user mapping profile you are about to export.

162





-Path<String>

Specifies the full path of the XML file where you are about to export the user mapping profile.



true 1 false false


Overwrites the existing XML file with the same name as the specified XML file where you are about to export the user mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Export-DAUserMapping -Name 'UserMapping' -Path 'C:\mapping.xml' -Overwrite

Description

This command exports the user mapping profile to an XML file in the specified location.

Related Links Import-DAUserMapping

Import-DAUserMapping Imports the specified XML file from the specified location to Manager as the user mapping profile.

163


Syntax Import-DAUserMapping [-Path] <String> [-Overwrite <>] [<CommonParameters>]

Description The Import-DAUserMapping cmdlet imports the specified XML file from the specified location to Manager as the user mapping profile.


Specifies the full path of the XML file which you are about to import to Manager as the user mapping profile.





Overwrites the existing user mapping profile with the same name as the specified XML file which you are about to import to Manager as the user mapping profile.




<CommonParameters>


Examples Example 1

PS C:\>Import-DAUserMapping -Path 'C:\mapping.xml' -Overwrite

Description

This command imports the specified XML file from the local path to the Manager as the user mapping.

Related Links Export-DAUserMapping

164


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

Description The Get-DAJob cmdlet gets job information in the Job Monitor.






false

-Module<Module>

Specifies the job's module. Valid values are "GranularBackup", "GranularRestore", "PlatformBackup", "PlatformRestore", "PlatformMaintenanceManager", "Retention", "FarmRebuild", "PlatformIndexMigration", "Administrator", "ContentManager", "DeploymentManager", "Replicator", "Archiver", "ArchiverFullTextIndex", "ArchiverRestore", "ArchiverRetention", "ConvertStubToContent", "ScheduledStorageManager", "Connector", "OrphanBLOBRetention", "ReportCenter", "LogManager", "JobPruning", "FileSystemMigration", "SharePointMigration", "ERoomMigration", "LivelinkMigration", "ExchangePublicFolderMigraton", "LotusNotesMigration", "EndUserArchiver", "EndUserRestore", "DataManager", "eDiscovery", "Vault", "EndUserGranularRestore", "StorageReport", "QuickrMigration", "EMCDocumentumMigration", "AnalyzeSQLBackup", "RestoreFromSQLBackup", "HighAvailabilityFailover", "HighAvailabilitySync", "HighAvailabilityFallback", "HighAvailabilityPreScan", "ReportCollector" and "DataSync". Note: If you specify to get all of the jobs of Connector module, all of the Connector and Cloud Connect jobs will be obtained.

165




true 0 false false

-StartTimeRangeBeginning<DateTime>

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




-StartTimeRangeEnding<DateTime>

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




<CommonParameters>


Notes The Get-DAJob cmdlet cannot get the following job information: Deployment Manager queue job and Replicator mapping job.

Examples Example 1

PS C:\>Get-DAJob -Id CA20120710105416471063

166


ID : CA20120710105416471063

PlanName : DeadAccountCleaner_PLAN20120710105504

Module : Administrator

Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

Progress : 100

Description

This command retrieves the job whose id is CA20120710105416471063.

Example 2

PS C:\>Get-DAJob -Module Administrator

ID : CA20120710105416471063



Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

Progress : 100

ID : CA20120710105904343484

PlanName : CloneUserPermission_PLAN20120710105954


Status : Finished

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

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

Progress : 100

Description

167


This command searches all Administrator jobs.

Example 3

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

ID : CA20120710105416471063



Status : Finished

StartTime : 2012/7/10 10:54:16

FinishTime : 2012/7/10 10:55:01

Progress : 100

Description

This command searches Administrator jobs in the specified start time range.

Related Links Get-DAJobDetail

Get-DAJobSummary

Get-DAJobDetail Gets detailed job report.

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

Description The Get-DAJobDetail cmdlet gets job details of the specified job.



168





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.




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




-Length<Int32>

Specifies the total number of details in the result. If the job is a Deployment Manager job, this parameter will be ignored.




<CommonParameters>


Notes

169


The Get-DAJobDetail cmdlet cannot get the following jobs' details: Deployment Manager queue job, Replicator mapping job, Archiver job and SharePoint migration job. If the job is a Deployment Manager job, this cmdlet will return the queue information. An error may occur if the job detail has a very large amount of data. Please use parameters such as: StartIndex and Length and set the suitable values to limit the data size of job detail got at a time.

Examples Example 1

PS C:\>Get-DAJobDetail -ID CM20111011115232293242

Key Value

--- -----

Type Web Application

Source URL http://SharePoint2010:10001/

Target URL http://SharePoint2010:10002/

Agent

Size 0Bytes

Status Success

Description

This command retrieves all the details of the job whoes id is CM20111011115232293242.

Example 2

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

Key Value

--- -----

Type Web Application

Source URL http://SharePoint2010:10001/

Target URL http://SharePoint2010:10002/

Agent

Size 0Bytes

Status Success

170


Description

This command retrieves the first detail of the job.

Related Links Get-DAJob

Get-DAJobSummary

Get-DAArchiverJobDetailForDeletion

Get-DAArchiverJobDetailForBackup

Get-DAJobSetting Gets the job settings.

Syntax Get-DAJobSetting [-ID] <String> [<CommonParameters>]

Description The Get-DAJobSetting cmdlet gets the settings of the specified job.






false

<CommonParameters>


Examples Example 1

PS C:\>Get-DAJobSetting -ID cm20131028111320255224

Key Value

171


--- -----

Common Settings-Method Copy

Common Settings-Action Attach

Common Settings-Backup the Destinati... No

Advanced Settings-Filter Policy None

Advanced Settings-Configuration Copy/Move configuration

Advanced Settings-Security Copy/Move security

Advanced Settings-Content Copy/Move content

Advanced Settings-Include List Attac... Yes

Advanced Settings-Include User Profile No

Advanced Settings-Include Workflow D... No

Advanced Settings-Include Workflow I... No

Advanced Settings-Managed Metadata S... Copy Managed Metadata Service

Advanced Settings-Copy Managed Metad... Term set

Advanced Settings-Preserve the Null ... Yes

Advanced Settings-Collapse Folder St... No

Advanced Settings-Data Compression No

Advanced Settings-Data Encryption No

Advanced Settings-Column Mapping None

Advanced Settings-Content Type Mapping None

Advanced Settings-Template Mapping None

Advanced Settings-User Mapping None

Advanced Settings-Domain Mapping None

Advanced Settings-Language Mapping None

Advanced Settings-List Name Mapping None

Advanced Settings-Container Level Co... Skip

Advanced Settings-Check Lower Objects Yes

Advanced Settings-Content Level Conf... Skip

Advanced Settings-Apps Conflict Reso... Skip

Advanced Settings-Notification None

172


Advanced Settings-Associated Plan Group None

Description

This command gets the settings of the job whose Job ID is CM20131028111320255224.


Get-DAJobSummary

Get-DAJobDetail

Get-DAJobSummary Gets the job summary.

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

Description The Get-DAJobSummary cmdlet gets the summary of the specified job. The summary includes the general information about the job.






false

<CommonParameters>


Notes The Get-DAJobSummary cmdlet cannot get the following jobs' summaries: Deployment Manager queue job and Replicator mapping job.

Examples Example 1

173


PS C:\>Get-DAJobSummary -ID CA20120710105416471063

Key Value

--- -----

Job Information-Plan Name DeadAccountCleaner_PLAN20120710105504

Job Information-Description

Job Information-Plan Type Dead Account Cleaner

Job Information-Job ID CA20120710105416471063

Job Information-Start Time 2012-07-10 10:54:16 (UTC+08:00) Beijing, Chongqing, Hong...

Job Information-Finish Time 2012-07-10 10:55:01 (UTC+08:00) Beijing, Chongqing, Hong...

Job Information-Job Operated By admin

Job Information-Plan Modified By admin

Environment Information-Farm Name Farm(SP2010_DB:SHAREPOINT_CONFIG)

Environment Information-Agent Host SP2010

Environment Information-Manager Version 6.1.0.1101

Environment Information-Agent Version 6.1.0.3005

Statistics-Status Finished

Statistics-Comment

Statistics-The Number of Successful Objects 0

Statistics-The Number of Failed Objects 0

Statistics-The Number of Skipped Objects 4

Description

This command retrieves the summary of the job whose ID is CA20120710105416471063.


Get-DAJobDetail

Download-DAJobReport Downloads the job report.

174


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

Description The Download-DAJobReport cmdlet downloads the report of the specified job.






false

-Format<JobReportFormat>

Specifies the format of the report. Valid values are "XLS","CSV", and "TXT". If the job is a Log Manager job, this parameter will be ignored.



false named XLS false false

-Path<String>

Specifies the path of the report file.





Allows the cmdlet to overwrite an existing file.

175





<CommonParameters>


Notes The Download-DAjobReport cmdlet cannot download the following job reports: Deployment Manager queued jobs and Replicator mapping jobs.

Examples Example 1

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

Description

This command downloads the job report to C:\Report.zip. The report format is txt.


Set-DAJobStopped Sets the job status of the specified job to Stopped.

Syntax Set-DAJobStopped [-ID] <String> [<CommonParameters>]

Description The Set-DAJobStopped cmdlet sets the job status of the specified job to Stopped. This cmdlet is used to set the job status of the unresponsive job that cannot be stopped from GUI and is blocking the jobs waiting in queue to Stopped, so that the jobs waiting in queue can be started.


Specifies the Job ID of the job whose status you are about to set to Stopped.

176





false

<CommonParameters>


Examples Example 1

PS C:\>Set-DAJobStopped -ID 'CM20140327160756184625'

Description

This command sets the job status of the specified job to Stopped.

Health Analyzer Refer to the following sections for more information.

Export-DAHealthAnalyzerReport Exports the Health Analyzer report.

Syntax Export-DAHealthAnalyzerReport -JobId <String> -File <String> [-Overwrite <>] [<CommonParameters>]

Description The Export-DAHealthAnalyzerReport cmdlet exports the Health Analyzer report.

Parameters -JobId<String>





177


-File<String>

Specifies the path of the report file. The report format can be either txt, xls, or csv.





Allows the cmdlet to overwrite an existing file.




<CommonParameters>


Examples Example 1

PS C:\>Export-DAHealthAnalyzerReport -JobId HAR20131118012748724634 -File 'C:\Report.txt' -Overwrite

Description

This command exports the Health Analyzer report to C:\Report.txt. The report file format is .txt.


178


Copyright Information Copyright © 1994–2015 NetApp, Inc. All rights reserved. Printed in the U.S. No part of this document covered by copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission of the copyright owner. Software derived from copyrighted NetApp material is subject to the following license and disclaimer: THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. NetApp reserves the right to change any products described herein at any time, and without notice. NetApp assumes no responsibility or liability arising from the use of products described herein, except as expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any patent rights, trademark rights, or any other intellectual property rights of NetApp. The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications. RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).

179


Trademark Information NetApp, the NetApp logo, Go Further, Faster, ASUP, AutoSupport, Campaign Express, Cloud ONTAP, clustered Data ONTAP, Customer Fitness, Data ONTAP, DataMotion, Fitness, Flash Accel, Flash Cache, Flash Pool, FlashRay, FlexArray, FlexCache, FlexClone, FlexPod, FlexScale, FlexShare, FlexVol, FPolicy, GetSuccessful, LockVault, Manage ONTAP, Mars, MetroCluster, MultiStore, NetApp Insight, OnCommand, ONTAP, ONTAPI, RAID DP,SANtricity, SecureShare, Simplicity, Simulate ONTAP, Snap Creator, SnapCopy, SnapDrive, SnapIntegrator, SnapLock, SnapManager, SnapMirror, SnapMover, SnapProtect, SnapRestore, Snapshot, SnapValidator, SnapVault, StorageGRID, Tech OnTap, Unbound Cloud, and WAFL are trademarks or registered trademarks of NetApp, Inc., in the United States, and/or other countries. A current list of NetApp trademarks is available on the web at http://www.netapp.com/us/legal/netapptmlist.aspx. Cisco and the Cisco logo are trademarks of Cisco in the U.S. and other countries. All other brands or products are trademarks or registered trademarks of their respective holders and should be treated as such.

180
