Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0....

109
Symantec Enterprise VaultPowerShell Cmdlets 11.0

Transcript of Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0....

Page 1: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Symantec Enterprise Vault™

PowerShell Cmdlets

11.0

Page 2: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Symantec Enterprise Vault: PowerShell CmdletsThe software described in this book is furnished under a license agreement and may be usedonly in accordance with the terms of the agreement.

Last updated: 2014-11-04.

Legal NoticeCopyright © 2014 Symantec Corporation. All rights reserved.

Symantec, the Symantec Logo, the Checkmark Logo, Enterprise Vault, Compliance Accelerator,and Discovery Accelerator are trademarks or registered trademarks of Symantec Corporationor its affiliates in the U.S. and other countries. Other names may be trademarks of theirrespective owners.

This Symantec product may contain third party software for which Symantec is required toprovide attribution to the third party ("Third Party Programs"). Some of the Third Party Programsare available under open source or free software licenses. The License Agreementaccompanying the Software does not alter any rights or obligations you may have under thoseopen source or free software licenses. Please see the Third Party Software file accompanyingthis Symantec product for more information on the Third Party Programs.

The product described in this document is distributed under licenses restricting its use, copying,distribution, and decompilation/reverse engineering. No part of this document may bereproduced in any form by any means without prior written authorization of SymantecCorporation and its licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIEDCONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIEDWARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ORNON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCHDISCLAIMERS ARE HELD TO BE LEGALLY INVALID. SYMANTEC CORPORATION SHALLNOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTIONWITH THE FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THEINFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGEWITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer softwareas defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq."Commercial Computer Software and Commercial Computer Software Documentation," asapplicable, and any successor regulations, whether delivered by Symantec as on premisesor hosted services. Any use, modification, reproduction release, performance, display ordisclosure of the Licensed Software and Documentation by the U.S. Government shall besolely in accordance with the terms of this Agreement.

Symantec Corporation350 Ellis Street, Mountain View, CA 94043

http://www.symantec.com

Page 3: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Technical SupportSymantec Technical Support maintains support centers globally. Technical Support’sprimary role is to help you resolve specific problems with a Symantec product. TheTechnical Support group also creates content for our online Knowledge Base. TheTechnical Support group works collaboratively with the other functional areas withinSymantec to answer your questions in a timely fashion. For example, the TechnicalSupport group works with Product Engineering and Symantec Security Responseto provide alerting services and virus definition updates.

Symantec’s support offerings include the following:

■ A range of support options that give you the flexibility to select the right amountof service for any size organization

■ Telephone and/or web-based support that provides rapid response andup-to-the-minute information

■ Upgrade assurance that delivers software upgrades

■ Global support purchased on a regional business hours or 24 hours a day, 7days a week basis

■ Premium service offerings that include Account Management Services

For information about Symantec’s support offerings, you can visit our website atthe following URL:

www.symantec.com/business/support/

All support services will be delivered in accordance with your support agreementand the then-current enterprise technical support policy.

Contacting Technical SupportCustomers with a current support agreement may access Technical Supportinformation at the following URL:

www.symantec.com/business/support/

Before contacting Technical Support, make sure you have satisfied the systemrequirements that are listed in your product documentation. Also, you should be atthe computer on which the problem occurred, in case it is necessary to replicatethe problem.

When you contact Technical Support, please have the following informationavailable:

■ Product release level

■ Hardware information

Page 4: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Available memory, disk space, and NIC information

■ Operating system

■ Version and patch level

■ Network topology

■ Router, gateway, and IP address information

■ Problem description:

■ Error messages and log files

■ Troubleshooting that was performed before contacting Symantec

■ Recent software configuration changes and network changes

Licensing and registrationIf your Symantec product requires registration or a license key, access our TechnicalSupport web page at the following URL:

www.symantec.com/business/support/

Customer serviceCustomer service information is available at the following URL:

www.symantec.com/business/support/

Customer Service is available to assist with non-technical questions, such as thefollowing types of issues:

■ Questions regarding product licensing or serialization

■ Product registration updates, such as address or name changes

■ General product information (features, language availability, local dealers)

■ Latest information about product updates and upgrades

■ Information about upgrade assurance and support contracts

■ Information about the Symantec Buying Programs

■ Advice about Symantec's technical support options

■ Nontechnical presales questions

■ Issues that are related to CD-ROMs, DVDs, or manuals

Page 5: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Support agreement resourcesIf you want to contact Symantec regarding an existing support agreement, pleasecontact the support agreement administration team for your region as follows:

[email protected] and Japan

[email protected], Middle-East, and Africa

[email protected] America and Latin America

Page 6: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Technical Support ............................................................................................... 3

Chapter 1 About this guide .................................................................... 8

Introducing this guide ...................................................................... 8Where to get more information about Enterprise Vault ........................... 8

“How To” articles on the Symantec Support website ....................... 10Enterprise Vault training modules ............................................... 11

Comment on the documentation ...................................................... 11

Chapter 2 Accessing the Enterprise Vault cmdlets ......................... 13

Enterprise Vault Management Shell .................................................. 13Importing modules ........................................................................ 13

Chapter 3 Help for Enterprise Vault PowerShell cmdlets .............. 15

Getting help for Enterprise Vault PowerShell cmdlets ........................... 15

Chapter 4 Enterprise Vault PowerShell cmdlet reference ............. 16

Get-EVArchive ............................................................................. 18Set-EVArchive ............................................................................. 20Get-EVComputers ........................................................................ 22Get-EVDatabase .......................................................................... 24Get-EVDatabaseFileInfo ................................................................ 25Get-EVDependencyService ............................................................ 27Get-EVDependencyServiceState .................................................... 28Remove-EVExchangeFolderPolicy ................................................... 29Get-EVFileLocation ....................................................................... 30Get-EVIISWebsite ........................................................................ 31Set-EVIMAPServerDisabled ........................................................... 32Set-EVIMAPServerEnabled ............................................................ 33Get-EVIMAPUsers ........................................................................ 34Get-EVIMAPUserSettings .............................................................. 36Get-EVIndexLocation .................................................................... 38New-EVMDSBuildTask .................................................................. 39Get-EVMDSStatus ........................................................................ 42

Contents

Page 7: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Add-EVPstComputer ..................................................................... 43Add-EVPstFile ............................................................................. 45Get-EVServer .............................................................................. 46Get-EVService ............................................................................. 47Get-EVServiceState ...................................................................... 48Get-EVSite .................................................................................. 49Get-EVSMTPHoldingFolder ............................................................ 50Get-EVSMTPPolicy ...................................................................... 50New-EVSMTPPolicy ..................................................................... 53Remove-EVSMTPPolicy ................................................................ 55Set-EVSMTPPolicy ....................................................................... 56Get-EVSMTPServerSettings ........................................................... 59New-EVSMTPServerSettings .......................................................... 61Set-EVSMTPServerSettings ........................................................... 67Sync-EVSMTPServerSettings ......................................................... 72Get-EVSMTPTarget ...................................................................... 74New-EVSMTPTarget ..................................................................... 77Remove-EVSMTPTarget ................................................................ 80Set-EVSMTPTarget ...................................................................... 81Get-EVStorageDatabase ............................................................... 84Get-EVTask ................................................................................. 86Get-EVTaskState .......................................................................... 87Get-EVVaultStore ......................................................................... 88Get-EVVaultStorePartition .............................................................. 89Clear-IndexLocationBackupMode .................................................... 92Get-IndexLocationBackupMode ...................................................... 94Set-IndexLocationBackupMode ....................................................... 96Set-IndexMetadataSyncLevel ......................................................... 97Get-IndexServerForIndexLocation ................................................... 99Start-PartitionRollover .................................................................. 100Clear-VaultStoreBackupMode ....................................................... 101Get-VaultStoreBackupMode .......................................................... 103Set-VaultStoreBackupMode .......................................................... 105

Index ................................................................................................................... 107

7Contents

Page 8: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

About this guide

This chapter includes the following topics:

■ Introducing this guide

■ Where to get more information about Enterprise Vault

■ Comment on the documentation

Introducing this guideThis guide provides usage information for all the Enterprise Vault 11.0 PowerShellcmdlets.

Where to getmore information about EnterpriseVaultTable 1-1 lists the documentation that accompanies Enterprise Vault.

1Chapter

Page 9: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 1-1 Enterprise Vault documentation set

CommentsDocument

Includes all the following documents in Windows Help (.chm)format so that you can search across them all. It also includeslinks to the guides in Acrobat (.pdf) format.

You can access the library in several ways, including thefollowing:

■ On the Windows Start menu, click Start > Programs >Enterprise Vault > Documentation.

■ In Windows Explorer, browse to theDocumentation\language subfolder of the EnterpriseVault installation folder, and then open the EV_Help.chmfile.

■ On the Help menu in the Administration Console, clickHelp on Enterprise Vault.

Symantec Enterprise VaultDocumentation Library

Provides an overview of Enterprise Vault functionality.Introduction and Planning

Describes how to check the required software and settingsbefore you install Enterprise Vault.

Deployment Scanner

Provides detailed information on setting up Enterprise Vault.Installing and Configuring

Describes how to upgrade an existing Enterprise Vaultinstallation to the latest version.

Upgrade Instructions

Describes how to archive items from Microsoft Exchangeuser mailboxes, journal mailboxes, and public folders.

Setting up Exchange ServerArchiving

Describes how to archive items from Domino mail files andjournal databases.

Setting up Domino ServerArchiving

Describes how to archive the files that are held on networkfile servers.

Setting up File SystemArchiving

Describes how to configure IMAP client access to Exchangearchives, and to Internet mail archives.

Setting up IMAP

Describes how to archive content from Microsoft SharePointservers.

Setting up SharePoint ServerArchiving

Describes how to archive SMTP messages from othermessaging servers.

Setting up SMTP Archiving

Describes how to perform day-to-day administrationprocedures.

Administrator’s Guide

9About this guideWhere to get more information about Enterprise Vault

Page 10: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 1-1 Enterprise Vault documentation set (continued)

CommentsDocument

Describes how to implement an effective backup strategy toprevent data loss, and how to provide a means for recoveryin the event of a system failure.

Backup and Recovery

Describes how to migrate content from Domino and NotesNSF files into Enterprise Vault archives.

NSF Migration

Describes how to migrate content from Outlook PST files intoEnterprise Vault archives.

PST Migration

Describes how to implement Enterprise Vault Reporting,which provides reports on the status of Enterprise Vaultservers, archives, and archived items. If you configure FSAReporting, additional reports are available for file servers andtheir volumes.

Reporting

Describes the Enterprise Vault tools and utilities.Utilities

Describes how to perform various administrative tasks byrunning the Enterprise Vault PowerShell cmdlets.

PowerShell Cmdlets

A reference document that lists the registry values with whichyou can modify many aspects of Enterprise Vault behavior.

Registry Values

The online Help for the Enterprise Vault AdministrationConsole.

Help for AdministrationConsole

The online Help for Enterprise Vault Operations Manager.Help for Enterprise VaultOperations Manager

For the latest information on supported devices and versions of software, see theEnterprise Vault Compatibility Charts book, which is available from this address:

http://www.symantec.com/docs/TECH38537

“How To” articles on the Symantec Support websiteMost of the information in the Enterprise Vault administration guides is also availableonline as articles on the Symantec Support website. You can access these articlesby searching the Internet with any popular search engine, such as Google, or byfollowing the procedure below.

10About this guideWhere to get more information about Enterprise Vault

Page 11: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

To access the “How To” articles on the Symantec Support website

1 Type the following in the address bar of your web browser, and then pressEnter:

http://www.symantec.com/business/support/all_products.jsp

2 In the Supported Products A-Z page, choose the required product, such asEnterprise Vault for Microsoft Exchange.

3 Search for a word or phrase by using the Knowledge Base Search feature, orbrowse the list of most popular subjects.

Enterprise Vault training modulesThe Enterprise Vault Tech Center (http://go.symantec.com/education_evtc) providesfree, publicly available training modules for Enterprise Vault. Modules are addedregularly and currently include the following:

■ Installation

■ Configuration

■ Getting Started Wizard

■ Preparing for Exchange 2010 Archiving

■ Assigning Exchange 2007 and Exchange 2010 Permissions for Enterprise Vault

■ Enterprise Vault File System Archiving

More advanced instructor-led training, virtual training, and on-demand classes arealso available. For information about them, seehttp://go.symantec.com/education_enterprisevault.

Comment on the documentationLet us know what you like and dislike about the documentation. Were you able tofind the information you needed quickly? Was the information clearly presented?Report errors and omissions, or tell us what you would find useful in future versionsof our guides and online help.

Please include the following information with your comment:

■ The title and product version of the guide on which you want to comment.

■ The topic (if relevant) on which you want to comment.

■ Your name.

11About this guideComment on the documentation

Page 12: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Email your comment to [email protected]. Please only use this address tocomment on product documentation.

We appreciate your feedback.

12About this guideComment on the documentation

Page 13: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Accessing the EnterpriseVault cmdlets

This chapter includes the following topics:

■ Enterprise Vault Management Shell

■ Importing modules

Enterprise Vault Management ShellMany of Enterprise Vault’s PowerShell cmdlets are available as part of the EnterpriseVault Management Shell.

When you run the Enterprise Vault Management Shell, it loads the Enterprise Vaultsnapin, Symantec.EnterpriseVault.PowerShell.Snapin.dll, which makesavailable the cmdlets it contains, in addition to PowerShell’s native cmdlets.

In this guide, each cmdlet’s reference section indicates whether or not it is providedas part of the Enterprise Vault Management Shell.

Importing modulesTo use the Enterprise Vault PowerShell cmdlets that are not loaded automaticallyby the Enterprise Vault Management Shell, you must load a separate module. Youcan do this in an Enterprise Vault Management Shell, or directly in a PowerShellshell.

In this guide, if it is necessary to load a module to use a cmdlet, the cmdlet’sreference section tells you which module you must load.

2Chapter

Page 14: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

To load an Enterprise Vault PowerShell cmdlet module

1 Run PowerShell, or the Enterprise Vault Management Shell.

2 At the command prompt, run the Import-Module cmdlet and provide the nameof the module you want to load.

For example, to load the Monitoring module, use the following command:

Import-Module .\Symantec.EnterpriseVault.PowerShell.Monitoring.dll

When you have loaded the module, you can use all the Enterprise Vault cmdletsthat it contains.

14Accessing the Enterprise Vault cmdletsImporting modules

Page 15: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Help for Enterprise VaultPowerShell cmdlets

This chapter includes the following topics:

■ Getting help for Enterprise Vault PowerShell cmdlets

Getting help for Enterprise Vault PowerShell cmdletsHelp is available for all Enterprise Vault’s PowerShell cmdlets. For example, thefollowing command shows the detailed help for Clear-VaultStoreBackupMode:

Get-Help Clear-VaultStoreBackupMode -detailed

You can also use the -examples parameter to output only the examples of cmdletusage from the help, and the -full parameter to output the most detailed helpavailable.

For more information about using PowerShell’s Get-Help cmdlet, use the followingcommand:

Get-Help Get-Help

3Chapter

Page 16: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Enterprise Vault PowerShellcmdlet reference

This chapter includes the following topics:

■ Get-EVArchive

■ Set-EVArchive

■ Get-EVComputers

■ Get-EVDatabase

■ Get-EVDatabaseFileInfo

■ Get-EVDependencyService

■ Get-EVDependencyServiceState

■ Remove-EVExchangeFolderPolicy

■ Get-EVFileLocation

■ Get-EVIISWebsite

■ Set-EVIMAPServerDisabled

■ Set-EVIMAPServerEnabled

■ Get-EVIMAPUsers

■ Get-EVIMAPUserSettings

■ Get-EVIndexLocation

■ New-EVMDSBuildTask

4Chapter

Page 17: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Get-EVMDSStatus

■ Add-EVPstComputer

■ Add-EVPstFile

■ Get-EVServer

■ Get-EVService

■ Get-EVServiceState

■ Get-EVSite

■ Get-EVSMTPHoldingFolder

■ Get-EVSMTPPolicy

■ New-EVSMTPPolicy

■ Remove-EVSMTPPolicy

■ Set-EVSMTPPolicy

■ Get-EVSMTPServerSettings

■ New-EVSMTPServerSettings

■ Set-EVSMTPServerSettings

■ Sync-EVSMTPServerSettings

■ Get-EVSMTPTarget

■ New-EVSMTPTarget

■ Remove-EVSMTPTarget

■ Set-EVSMTPTarget

■ Get-EVStorageDatabase

■ Get-EVTask

■ Get-EVTaskState

■ Get-EVVaultStore

■ Get-EVVaultStorePartition

■ Clear-IndexLocationBackupMode

■ Get-IndexLocationBackupMode

17Enterprise Vault PowerShell cmdlet reference

Page 18: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Set-IndexLocationBackupMode

■ Set-IndexMetadataSyncLevel

■ Get-IndexServerForIndexLocation

■ Start-PartitionRollover

■ Clear-VaultStoreBackupMode

■ Get-VaultStoreBackupMode

■ Set-VaultStoreBackupMode

Get-EVArchiveGet-EVArchive returns a list of the Enterprise Vault archives in which a specifieduser has various permissions, either directly or through membership of an ActiveDirectory group. You can filter the list by a number of archive properties. Forexample, you can choose to list only those archives in which the user has permissionto delete the archived items, or only those archives that are on legal hold.

Get-EVArchive is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVArchive [[-Server] <String>] [[-User] <String>]

[-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]]

[-OnHold [<Boolean>]] [-Permissions [<String>]] [<CommonParameters>]

Parameters

Table 4-1 Get-EVArchive parameters

DescriptionParameter

Identifies the Enterprise Vault server for which to retrieve thearchive list. For example: localhost,evserver.domain.com.

-Server (required)

Identifies the user for which to retrieve the list of archives. Typethe user’s Windows logon name, user principal name, or Dominouser ID. For example: [email protected], domain\user.

-User

18Enterprise Vault PowerShell cmdlet referenceGet-EVArchive

Page 19: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-1 Get-EVArchive parameters (continued)

DescriptionParameter

Filters the archive list according to whether the user canmanually delete the items in the archives. Set to $false to listthe archives in which the user can manually delete items, or$true to list the archives in which the user cannot delete items.

-DeleteProtected

Filters the archive list according to whether Enterprise Vault canautomatically delete the archived items whose retention periodshave expired. Set to $false to list the archives in whichEnterprise Vault does not delete expired items, or $true to listthe archives in which it does.

-DeleteExpiredItems

Filters the archive list according to the legal hold status of thearchives. Set to $false to list the archives in which either theuser or Enterprise Vault (or both) can delete items, or $true tolist the archives that are on legal hold. (Legal hold is equivalentto DeleteProtected set to $true andDeleteExpiredItems set to $false.)

-OnHold

Filters the archive list according to the permissions that the userhas on the archives. Specify the permissions as a combinationof r (for read), w (for write), and d (for delete). For example: rwand rwd. A blank value () denotes any permission. The defaultpermission if not specified is d (delete)

-Permissions

Examples■ Get-EVArchive MyEVServer Domain\User

Lists the archives on the Enterprise Vault server MyEVServer in which the userDomain\User has delete permissions.

■ Get-EVArchive localhost [email protected] -DeleteProtected:$false

-DeleteExpiredItems:$false -Permissions rw

Lists the archives on the local server in which the user [email protected] hasboth read and write permissions. Get-EVArchive filters the list to show onlythose archives in which the user can manually delete items but in whichEnterprise Vault cannot automatically delete expired items.

■ Get-EVArchive localhost Domain\User -OnHold:$false | format-table

-auto

Lists the archives on the local server in which the user Domain\User has deletepermissions. Get-EVArchive excludes from the list all the archives that are onlegal hold and writes the output to format-table.

19Enterprise Vault PowerShell cmdlet referenceGet-EVArchive

Page 20: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

OutputTable 4-2 lists the properties that are available.

Table 4-2 Get-EVArchive properties

DescriptionTypeName

The ArchiveId of an archive to which thespecified user has access.

StringArchiveId

The ArchiveName of an archive to which thespecified user has access.

StringArchiveName

The type of archive. Possible values:"Exchange", "Internet Mail".

ArchiveTypeArchiveType

Indicates whether Enterprise Vault canautomatically delete items from the archive.Possible values are $true (can delete),$false (cannot delete).

BooleanDeleteExpiredItems

Indicates whether the user can manuallydelete items from the archive.

BooleanDeleteProtected

Indicates whether the archive contains itemsthat are on legal hold. Possible values are$true (archive does contain items on legalhold), $false (archive does not containitems on legal hold).

BooleanOnHold

Indicates the status of the archive. Can beany of the following: "Available","Unavailable","Closed","Beingcreated","Being deleted".

StatusStatus

Related cmdlets■ See “Set-EVArchive” on page 20.

Set-EVArchiveSet-EVArchive sets a number of properties of the nominated archive, includingwhether users can manually delete the items in the archive and whether EnterpriseVault can automatically delete the archived items when their retention period hasexpired. You can also specify a description and administrative note for the archivefor display in the Administration Console.

20Enterprise Vault PowerShell cmdlet referenceSet-EVArchive

Page 21: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Set-EVArchive is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-EVArchive [[-ArchiveID] <String>] [-DeleteProtected [<Boolean>]]

[-DeleteExpiredItems [<Boolean>]] [-Description [<String>]]

[-AdminNote [<String>]] [<CommonParameters>]

Parameters

Table 4-3 Set-EVArchive parameters

DescriptionParameter

Specifies the ID of the archive for which to set the properties. Youcan obtain the required ID with the Get-EVArchive cmdlet.

-ArchiveID (required)

Specifies whether to permit users manually to delete the items inthe archive. Set to $false to permit users to delete items, or$true to prevent deletion.

-DeleteProtected

Specifies whether to permit Enterprise Vault automatically todelete the archived items when their retention period has expired.Set to $false to prevent deletion, or $true to permit EnterpriseVault to delete the expired items.

-DeleteExpiredItem

Provides a short description for display in the archive propertiesin the Administration Console.

-Description

Provides an administrative note for display in the archiveproperties in the Administration Console.

-AdminNote

Examples■ Set-EVArchive

14BC45D9EE238494DAB7B94DBA90BB3401110000EVSERVER.LOCAL

-DeleteProtected:$true -DeleteExpiredItems:$false

Stops both users and Enterprise Vault from deleting the items in the nominatedarchive, and so places it on legal hold.

■ Set-EVArchive

14BC45D9EE238494DAB7B94DBA90BB3401110000EVSERVER.LOCAL

-DeleteProtected:$false -AdminNote "Item deletion allowed

$(get-date) by $(gc env:username)"

Allows users manually to delete the items in the nominated archive, and modifiesits administrative note.

21Enterprise Vault PowerShell cmdlet referenceSet-EVArchive

Page 22: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Get-EVArchive localhost Domain\User -OnHold:$false | Set-EVArchive

-DeleteProtected:$true -DeleteExpiredItems:$false -Description

"Archive placed on legal hold $(get-date) by $(gc env:username)

from $(gc env:computername)"

With Get-EVArchive, generates a list of the archives on the local EnterpriseVault server which are not on legal hold and in which the user Domain\User hasdelete permissions. Get-EVArchive passes the list to Set-EVArchive, whichplaces the archives on hold and sets the archive description accordingly.

OutputTable 4-4 lists the properties that are available.

Table 4-4 Set-EVArchive properties

DescriptionTypeName

The ArchiveId of the archive to modifyStringArchiveId

The name of the archive to modify.StringArchiveName

Indicates whether the archive was updated bythe command. Possible values are: $true(archive was updated), $false (archive was notupdated).

BooleanUpdated

Related cmdlets■ See “Get-EVArchive” on page 18.

Get-EVComputersGet-EVComputers returns the collection of computers listed in the ComputerEntrytable of the Directory database.

Get-EVComputers is provided bySymantec.EnterpriseVault.PowerShell.IMAP.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVComputers [<CommonParameters>]

ParametersPowerShell common parameters only.

22Enterprise Vault PowerShell cmdlet referenceGet-EVComputers

Page 23: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-EVComputers

Returns the collection of computers listed in the ComputerEntry table of theDirectory database.

■ Get-EVComputers | Where-Object {$_.EnabledForIMAP -eq 1} |

ForEach-Object {Set-EVIMAPServerDisabled $_.ComputerNameAlternate}

This command finds all Enterprise Vault servers that are enabled for IMAP anddisables each one in turn, stopping the IMAP server in the process.

OutputTable 4-5 lists the properties that are available.

Table 4-5 Get_EVComputers properties

DescriptionTypeName

An Enterprise Vault unique identifier for thisserver.

Int32ComputerIdentity

The computer name.StringComputerName

The computer alternate name.StringComputerNameAlternate

Indicates whether the server has been enabledfor IMAP. Possible values $true (server isenabled for IMAP), $false (server is notenabled for IMAP), null (server has never beenenabled for IMAP).

BooleanEnabledForIMAP

The IMAP Endpoint Entry Id.StringIMAPEndPointEntryId

The IMAP Endpoint name.StringIMAPEndpointName

Related cmdlets■ See “Set-EVIMAPServerDisabled” on page 32.

■ See “Set-EVIMAPServerEnabled” on page 33.

■ See “Get-EVIMAPUsers” on page 34.

■ See “Get-EVIMAPUserSettings” on page 36.

23Enterprise Vault PowerShell cmdlet referenceGet-EVComputers

Page 24: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVDatabaseGet-EVDatabase returns Enterprise Vault Directory database details for an EnterpriseVault server.

Get-EVDatabase is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVDatabase

ParametersPowerShell common parameters only.

Examples■ Get-EVDatabase

Returns database details for the Enterprise Vault Directory database.

OutputTable 4-6 lists the properties that are available.

Table 4-6 Get-EVDatabase properties

DescriptionTypeName

The name of the Enterprise Vaultdatabase. For example,"EnterpriseVaultDirectory".

StringDBName

Indicates whether SQL Server is clustered.BooleanIsClustered

The name of the SQL Server instance thathosts the Directory database.

StringSQLInstanceName

The name of the SQL Server computerthat hosts the Directory database.

StringSQLServerName

The version of SQL Server on the SQLServer computer that hosts the Directorydatabase.

StringSQLServerVersion

The only possible value is "Directory".EVDatabaseTypeType

24Enterprise Vault PowerShell cmdlet referenceGet-EVDatabase

Page 25: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Related cmdlets■ See “Get-EVStorageDatabase” on page 84.

■ See “Get-EVDatabaseFileInfo” on page 25.

Get-EVDatabaseFileInfoGet-EVDatabaseFileInfo returns database file and disk space information for theEnterprise Vault databases on the current Enterprise Vault server.

Get-EVDatabaseFileInfo is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVDatabaseFileInfo [-DatabaseType] <string> [<CommonParameters>]

Get-EVDatabaseFileInfo [-DatabaseType] <string> [-EntryId] <string>

[-StorageServiceEntryId] <string> [<CommonParameters>]

Parameters

Table 4-7 Get-EVDatabaseFileInfo properties

DescriptionParameter

EVDatabaseFileInfo. The type of database for which youwant details. You can specify any of the following:

■ Directory. Returns details of the Directory database.■ VaultStore. Returns details of Vault Store databases.■ Fingerprint. Returns details of fingerprint databases.

-DatabaseType

To find the values for EntryId you can use theGet-EVStorageDatabase cmdlet.

See “Get-EVStorageDatabase” on page 84.

-EntryID

To find the value for StorageServiceEntryId you canuse the Get-EVStorageDatabase cmdlet.

See “Get-EVStorageDatabase” on page 84.

-StorageServiceEntryId

Examples■ Get-EVDatabaseFileInfo -DatabaseType Directory

25Enterprise Vault PowerShell cmdlet referenceGet-EVDatabaseFileInfo

Page 26: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Returns database file and disk space information for the Enterprise VaultDirectory database.

■ Get-EVDatabaseFileInfo -DatabaseType VaultStore -EntryId

21EC2020-3AEA-1069-A2DD-08002B30909D -StorageServiceEntryId

21EC2020-3ACC-1069-A2DD-08002B30309D

Returns the database file and disk space information for a specific vault storedatabase. The command specifies the Storage service to use to obtain theinformation.To find the values for EntryId and StorageServiceEntryId you can use theGet-EVStorageDatabase cmdlet.

OutputTable 4-8 lists the properties that are available.

Table 4-8 Get-EVDatabaseFileInfo properties

DescriptionTypeName

The name of the Enterprise Vaultdatabase. For example,"EnterpriseVaultDirectory".

StringDatabaseName

One of the following: "Log", "Data".EVDatabaseTypeFileType

The number of hours since the file waslast backed up.

Int32HoursSinceLastBackup

The date and time when the file was lastbacked up. This value is null if the file hasnever been backed up.

DateTimeLastBackupDate

The logical file name.StringLogicalFileName

The full path to the physical file.StringPhysicalFileName

The total space available, in gigabytes.This value can be null.

DoubleTotalQuotaGBytesAvailable

The amount of unused space, ingigabytes. This value can be null.

DoubleTotalQuotaGBytesFree

The amount of used space, in gigabytes.This value can be null.

DoubleTotalQuotaGBytesUsed

Related cmdlets■ See “Get-EVDatabase” on page 24.

26Enterprise Vault PowerShell cmdlet referenceGet-EVDatabaseFileInfo

Page 27: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ See “Get-EVStorageDatabase” on page 84.

Get-EVDependencyServiceGets the dependency services information for all the Enterprise Vault services thatare on the current Enterprise Vault server.

Get-EVDependencyService is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVDependencyService [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVDependencyService

Gets the dependency information for all the Enterprise Vault services that areon the current Enterprise Vault server.

OutputTable 4-9 lists the properties that are available.

Table 4-9 Get-EVDependencyService properties

DescriptionTypeName

The name of the dependency service, suchas "Message Queuing" or "World WidePublishing Service".

StringDisplayName

This value is always empty.StringEntryID

The dependency name, such as "MSMQ" or"W3SVC".

StringName

One of the following:"MSMQService","IISService".

ServiceTypeType

Related cmdlets■ See “Get-EVDependencyServiceState ” on page 28.

27Enterprise Vault PowerShell cmdlet referenceGet-EVDependencyService

Page 28: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVDependencyServiceState

Note:This cmdlet is deprecated. To obtain the status of Enterprise Vault dependencyservices, use the Get-Service cmdlet.

Gets the current state for the specified dependency service. The state can be either"Running" or "Stopped".

Get-EVDependencyServiceState is provided bySymantec.EnterpriseVault.PowerShell.Monitoring.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVDependencyServiceState [-ServiceName] <String>

ParametersTable 4-10 lists the properties that are available.

Table 4-10 Get-EVDependencyServiceState parameters

DescriptionParameter

The name of the service whose details you require.

You can use the Get-EVDependencyService cmdlet to get the servicenames.

-ServiceName

Examples■ Get-EVDependencyServiceState msmq

Gets the state of the Message Queuing service.

■ Get-EVDependencyServiceState W3SVC

Gets the state of the World Wide Web Publishing Service (IIS).

OutputTable 4-11 lists the properties that are available.

28Enterprise Vault PowerShell cmdlet referenceGet-EVDependencyServiceState

Page 29: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-11 Get-EVDependencyServiceState properties

DescriptionTypeName

One of the following: "Stopped","StartPending", "StopPending","Running", "ContinuePending","PausePending", "Paused".

ServiceControllerStatusValue

Related cmdlets■ See “Get-EVDependencyService” on page 27.

Remove-EVExchangeFolderPolicyRemove-EVExchangeFolderPolicy removes Enterprise Vault filter settings fromfolders within a mailbox. The folders affected can be restricted to only includeExchange Managed Folders.

Remove-EVExchangeFolderPolicy is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxRemove-EVExchangeFolderPolicy -PrimarySMTPAddress <String>

[-DomainController <String>] [-DontUseSSL] [-Credential

<PSCredential>] [-ManagedFolders] [-MailServer <String>] [-LogFile

<String>] [-ExchangeWebServicesURL <String>] [<CommonParameters>]

Parameters

Table 4-12 Remove-EVExchangeFolderPolicy parameters

DescriptionParameter

Specifies the primary SMTP address of the mailbox to beused.

-PrimarySMTPAddress(required)

Specifies the domain controller that the LDAP lookup queryshould be run against.

-DomainController

Specifies that SSL should not be used when connectingto the Exchange Server.

-DontUseSSL

29Enterprise Vault PowerShell cmdlet referenceRemove-EVExchangeFolderPolicy

Page 30: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-12 Remove-EVExchangeFolderPolicy parameters (continued)

DescriptionParameter

Specifies the PSCredentials that should be used to connectto the Exchange Server. This should be your EnterpriseVault administrator account.

-Credential

Restricts the delete to only folders that have an ExchangeManaged Folder policy set against them.

-ManagedFolders

Overrides the mailbox server value associated with themailbox and attempts to use the server specified.

-MailServer

Log the output to the file specified instead of to the console.-LogFile

Specifies the Exchange Web Services URL in Exchange2010 environments. Use this parameter ifRemove-EVExchangeFolderPolicy fails to determinethe Exchange Web Services URL automatically.

-ExchangeWebServicesURL

Examples■ Remove-EVExchangeFolderPolicy -PrimarySMTPAddress [email protected]

-ManagedFolders

This command removes any Enterprise Vault filter settings from ExchangeManaged Folders located in the mailbox with the SMTP address [email protected].

Get-EVFileLocationGets details of the Enterprise Vault file locations that are configured on the currentEnterprise Vault server.

Get-EVFileLocation is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVFileLocation [[-Type] <string>] [<CommonParameters>]

30Enterprise Vault PowerShell cmdlet referenceGet-EVFileLocation

Page 31: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-13 Get-EVFileLocation parameters

DescriptionParameter

The Enterprise Vault file location for which you want details. You can specifyany of the following:

■ Application. Gets the path to the Enterprise Vault program folder.■ Cache. Gets the path to the Enterprise Vault cache location.■ Temporary. Gets the path to the folder that Enterprise Vault uses for

temporary files.

-Type

Examples■ Get-EVFileLocation

Gets details of the Enterprise Vault file locations that are configured on thecurrent server.

OutputTable 4-14 lists the properties that are available.

Table 4-14 Get-EVFileLocation properties

DescriptionTypeName

Path to the folder location.StringPath

The total available space at the location, ingigabytes.

DoubleTotalQuotaGBytesAvailable

The free space at the location, in gigabytes.DoubleTotalQuotaGBytesFree

The space used at the location, in gigabytes.DoubleTotalQuotaGBytesUsed

One of the following: "Application"; "Cache";"Temporary".

FileLocationType

Get-EVIISWebsiteGets details of the Enterprise Vault virtual directories that are configured on thecurrent Enterprise Vault server.

Get-EVIISWebsite is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not imported

31Enterprise Vault PowerShell cmdlet referenceGet-EVIISWebsite

Page 32: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

automatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVIISWebsite [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVIISWebsite

Gets details of the Enterprise Vault virtual directories that have been configuredon the current Enterprise Vault server.

OutputTable 4-15 lists the properties that are available.

Table 4-15 Get-EVIISWebsite properties

DescriptionTypeName

One of the following:"EVMOD_ENTERPRISEVAULT";"EVMOD_FSAREPORTING";"EVMOD_EVINDEXING";"EVMOD_ENTERPRISEVAULTAPI";"EVMOD_EVSEARCHCLIENT";"EVMOD_EVSEARCHSERVER".

EVWebsiteModuleEnterpriseVaultModule

An Enterprise Vault URL.StringWebAddress

Set-EVIMAPServerDisabledSet-EVIMAPServerDisabled disables the specified server for IMAP and stops theIMAP server.

Set-EVIMAPServerDisabled is provided bySymantec.EnterpriseVault.PowerShell.IMAP.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-EVIMAPServerDisabled -ComputerNameAlternate [<CommonParameters>]

32Enterprise Vault PowerShell cmdlet referenceSet-EVIMAPServerDisabled

Page 33: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-16 Set-EVIMAPServerDisabled parameters

DescriptionParameter

The alias for the Enterprise Vault server on whichyou want to stop and disable the IMAP server.

-ComputerNameAlternate (required)

Examples■ Get-EVComputers | Where-Object {$_.EnabledForIMAP -eq 1} |

ForEach-Object {Set-EVIMAPServerDisabled $_.ComputerNameAlternate}

This command finds all Enterprise Vault servers that are enabled for IMAP anddisables each one in turn, stopping the IMAP server in the process.

■ Set-EVIMAPServerDisabled ACME_LAB_1

This command finds the Enterprise Vault server with the Computer name'ACME_LAB_1' and disables it for IMAP, stopping the IMAP server in the process.

Related cmdlets■ See “Get-EVComputers” on page 22.

■ See “Set-EVIMAPServerEnabled” on page 33.

■ See “Get-EVIMAPUsers” on page 34.

■ See “Get-EVIMAPUserSettings” on page 36.

Set-EVIMAPServerEnabledSet-EVIMAPServerEnabled enables the specified server for IMAP and starts theIMAP server.

Set-EVIMAPServerEnabled is provided bySymantec.EnterpriseVault.PowerShell.IMAP.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-EVIMAPServerEnabled -ComputerNameAlternate [<CommonParameters>]

33Enterprise Vault PowerShell cmdlet referenceSet-EVIMAPServerEnabled

Page 34: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-17 Set-EVIMAPServerEnabled parameters

DescriptionParameter

The alias for the Enterprise Vault server on whichyou want to enable and start the IMAP server.

-ComputerNameAlternate (required)

Examples■ Get-EVComputers | Where-Object {$_.EnabledForIMAP -eq 0} |

ForEach-Object {Set-EVIMAPServerEnabled $_.ComputerNameAlternate}

This command finds all Enterprise Vault servers that are not enabled for IMAPand enables each one in turn, starting the IMAP server in the process.

■ Set-EVIMAPServerEnabled ACME_LAB_1

This command finds the Enterprise Vault server with the Computer name'ACME_LAB_1' and enables it for IMAP, starting the IMAP server in the process.

OutputThere is a confirmation message on completion.

Related cmdlets■ See “Get-EVComputers” on page 22.

■ See “Set-EVIMAPServerDisabled” on page 32.

■ See “Get-EVIMAPUsers” on page 34.

■ See “Get-EVIMAPUserSettings” on page 36.

Get-EVIMAPUsersGet-EVIMAPUsers gets the list of users enabled for IMAP access.

Get-EVIMAPUsers is provided bySymantec.EnterpriseVault.PowerShell.IMAP.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVIMAPUsers -ArchiveName -NTUserName [<CommonParameters>]

34Enterprise Vault PowerShell cmdlet referenceGet-EVIMAPUsers

Page 35: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-18 Get-EVIMAPUsers parameters

DescriptionParameter

Use -ArchiveName to display only the IMAP enabled users whosearchive name matches the value you provide.

-ArchiveName

Use -NTUserName to display only the IMAP enabled users whose ActiveDirectory user name matches the value you provide.

-NTUserName

Examples■ Get-EVIMAPUsers -ArchiveName John

This command returns the users matching the Archive name 'John'.

■ Get-EVIMAPUsers -NTUserName "Steve_B"

This command returns the users matching the username entry 'Steve_B'.

OutputTable 4-19 lists the properties that are available.

Table 4-19 Get-EVIMAPUsers properties

DescriptionTypeName

Indicates whether the user is enabled for IMAPaccess. Possible values are: $true (user isenabled), $false (user is not enabled).

BooleanEnabledForIMAP

The name of the user's mailbox archive.StringMbxArchiveName

The Windows domain.StringMbxNTDomain

The user's login name.StringMbxNTUser

Indicates whether the metadata store has beenbuilt for the archive. Possible values: $true (themetadata store has been built), $false (themetadata store has not yet been built). Internetmail archives always have a metadata store, soReadyForIMAP is always true for Internet mailarchives.

BooleanReadyForIMAP

The SID (security identifier) of the ActiveDirectory user.

StringSID

35Enterprise Vault PowerShell cmdlet referenceGet-EVIMAPUsers

Page 36: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-19 Get-EVIMAPUsers properties (continued)

DescriptionTypeName

The type of archive. Possible values:"Exchange", "Internet Mail".

StringType

Related cmdlets■ See “Get-EVComputers” on page 22.

■ See “Set-EVIMAPServerDisabled” on page 32.

■ See “Set-EVIMAPServerEnabled” on page 33.

■ See “Get-EVIMAPUserSettings” on page 36.

Get-EVIMAPUserSettingsGet-EVIMAPUserSettings gets the IMAP/SMTP client settings for the given userSID.

Get-EVIMAPUserSettings is provided bySymantec.EnterpriseVault.PowerShell.IMAP.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVIMAPUserSettings -SID [<CommonParameters>]

Parameters

Table 4-20 Get-EVIMAPUserSettings parameters

DescriptionParameter

The SID (security identifier) of the Active Directory user whose IMAPsettings you want to display.

-SID (required)

Examples■ Get-EVIMAPUserSettings S-1-5-21-750406912-2207124990-322363385-3682

This command returns the IMAP/SMTP server settings for the archives that theuser represented by the SID parameter has access to.

OutputTable 4-21 lists the properties that are available.

36Enterprise Vault PowerShell cmdlet referenceGet-EVIMAPUserSettings

Page 37: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-21 Get-EVIMAPUserSettings properties

DescriptionTypeName

The name of the user's archive.StringArchivename

Indicates whether the user is the owner of thearchive. Possible values: $true (user owns thearchive), $false (user does not own thearchive).

BooleanArchiveOwner

The type of archive. Possible values:"Exchange", "Internet Mail".

StringArchiveType

The security to use for the IMAP connection.StringIMAP_Connection_Security

Specifies which account's password to use whenconnecting to the archive.

StringIMAP_Password

The port number to use for the IMAP connection.Int32IMAP_Port

The IMAP server to which to connect.StringIMAP_Server

The account name to use when connecting tothe IMAP server.

StringIMAP_UserName

Indicates whether the metadata store has beenbuilt for the archive. Possible values: $true (themetadata store has been built), $false (themetadata store has not yet been built). Internetmail archives always have a metadata store, soReadyForIMAP is always true for Internet mailarchives.

BooleanReadyForIMAP

The type of security to use for the SMTPconnection.

StringSMTP_Connection_Security

Possible values: "SMTP account username" (theSMTP server requires authentication), "Notapplicable" (the SMTP server does not requireauthentication).

StringSMTP_Password

The port to use for the SMTP connection.Int32SMTP_Port

The SMTP server to which to connect.StringSMTP_Server

If the SMTP server requires authentication thisstring contains "SMTP account username".

StringSMTP_UserName

37Enterprise Vault PowerShell cmdlet referenceGet-EVIMAPUserSettings

Page 38: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-21 Get-EVIMAPUserSettings properties (continued)

DescriptionTypeName

The Windows account to use to connect to theIMAP server.

StringWindowsUser

Related cmdlets■ See “Get-EVComputers” on page 22.

■ See “Set-EVIMAPServerDisabled” on page 32.

■ See “Set-EVIMAPServerEnabled” on page 33.

■ See “Get-EVIMAPUsers” on page 34.

Get-EVIndexLocationGets details of the Enterprise Vault index locations that are configured on the currentEnterprise Vault server.

Get-EVIndexLocation is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVIndexLocation [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVIndexLocation

Gets details of the Enterprise Vault index locations that are configured on thecurrent Enterprise Vault server.

OutputTable 4-22 lists the properties that are available.

38Enterprise Vault PowerShell cmdlet referenceGet-EVIndexLocation

Page 39: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-22 Get-EVIndexLocation properties

DescriptionTypeName

Index location backup mode.

One of the following: "On"; "Off".

IndexLocationBackupModeBackupMode

The name of the computer thathosts the index location.

StringComputerName

The name of the indexing groupthat the location is in, if any.

StringIndexingGroup

The index root path. For example,E:\EVStorage\Index\index8

StringIndexRootPath

The Index Root Path Entry Id.StringIndexRootPathEntryId

The Index Service Entry ID.StringIndexServiceEntryID

The index location status. One ofthe following: "Open"; "Closed".

IndexLocationStatusStatus

The total amount of spaceavailable, in gigabytes. This valuecan be null.

DoubleTotalQuotaGBytesAvailable

The amount of unused space, ingigabytes. This value can be null

DoubleTotalQuotaGBytesFree

The amount of used space, ingigabytes. This value can be null.

DoubleTotalQuotaGBytesUsed

New-EVMDSBuildTaskNew-EVMDSBuildTask creates an indexing task that builds (or rebuilds) a MetadataStore for an archive. The command must be run by a user with permission to manageindexes.

New-EVMDSBuildTask is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxNew-EVMDSBuildTask [-ArchiveId] <String> -Mode <MDSBuildTaskMode>

[-VerifyIndex [<MDSBuildTaskVerifyIndex>]] [-Force

39Enterprise Vault PowerShell cmdlet referenceNew-EVMDSBuildTask

Page 40: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

[<CommonParameters>]

Parameters

Table 4-23 New-EVMDSBuildTask parameters

DescriptionParameter

Identifies an Enterprise Vault archive.-ArchiveId (required)

Build, Rebuild. Use Build to create a new Metadata Storefor the archive, or fill in gaps in the existing one. Use Rebuild torecreate the entire Metadata Store for the archive, overwriting anyexisting data.

-Mode (required)

Default, Verify, NoVerify. In some cases the Metadata Storebuild task triggers an index verify task to ensure the MetadataStore is complete. This parameter can be used to enable or disablethis behavior, overriding any default.

-VerifyIndex

Creates the Metadata Store build task without prompting forconfirmation.

-Force

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

-WhatIf

Examples■ New-EVMDSBuildTask -Mode Build -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

This command creates an indexing task that builds the Metadata Store for thespecified archive. If the archive already has a Metadata Store, any missing itemswill be added where possible, but existing data will not be recreated.

■ New-EVMDSBuildTask -Mode Rebuild -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

This command creates an indexing task that rebuilds the Metadata Store forthe specified archive. Any existing data in the archive's Metadata Store will beoverwritten.

■ New-EVMDSBuildTask -Mode Build -VerifyIndex NoVerify -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

This command creates an indexing task that builds the Metadata Store for thespecified archive, but will NOT allow the task to trigger a verification of thearchive's index.

■ Import-Csv c:\archives.csv | New-EVMDSBuildTask -Mode Build

40Enterprise Vault PowerShell cmdlet referenceNew-EVMDSBuildTask

Page 41: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

This command reads a list of archives from a CSV file, and creates a MetadataStore build task for each archive. One of the columns in the CSV file must becalled 'ArchiveId'.

■ Get-Content c:\archives.txt | New-EVMDSBuildTask -Mode Build

This command reads a list of archive IDs from a text file (one per line), andcreates a Metadata Store build task for each archive.

■ New-EVMDSBuildTask -Force -Mode Build -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

This command uses the -Force switch to suppress confirmation prompting.

■ New-EVMDSBuildTask -WhatIf -Mode Build -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

This command uses the -WhatIf switch to display the Metadata Store build tasksthat would be created by the command, without actually creating the tasks.

OutputNewMDSBuildTaskResult

Table 4-24 lists the properties that are available.

Table 4-24 New-EVMDSBuildTask properties

DescriptionTypeName

The ArchiveId of the archive forwhich a task has been created.

StringArchiveId

The name of the archive for whicha task has been created.

StringArchiveName

The mode that is being used whenbuilding the archive. Possiblevalues:"Build", "Rebuild".

MDSBuildTaskModeMode

Indicates whether an index verifytask will be created to verify thatthe Metadata Store is complete.Possible values: "Default", "Verify","NoVerify".

MDSBuildTaskVerifyIndexVerifyIndex

Related cmdlets■ See “Get-EVMDSStatus” on page 42.

41Enterprise Vault PowerShell cmdlet referenceNew-EVMDSBuildTask

Page 42: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVMDSStatusGet-EVMDSStatus gets the current status of the metadata store for an archive. Thecommand can also be used to get the number of items that are missing from themetadata store for an archive.

Get-EVArchive is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVMDSStatus [[-ArchiveId] <String>] [[-VaultStoreId] <String>]

[[-SiteId] <String>] [-IncludeMissingItems [<SwitchParameter>]]

[<CommonParameters>]

Parameters

Table 4-25 Get-EVMDSStatus parameters

DescriptionParameter

Identifies an archive. This is the default operation.-ArchiveId (required)

Identifies a vault store. If this parameter is used instead ofArchiveId, the command will operate on all applicable archivesin the specified vault store.

-VaultStoreId (required)

Identifies a site. If this parameter is used the commandoperates on all appropriate archives in the specified site.

-SiteId (required)

Whether the command should return the count of items thatare present in the archive but are missing from the metadatastore. This option can be slow if you have specified thousandsof archives.

-IncludeMissingItems

Examples■ Get-EVMDSStatus -ArchiveId

1B2D4933D7227A141A9D30D56A71415701110000@ev

Gets the current status of the metadata store for the specified archive.

■ Get-EVMDSStatus -IncludeMissingItems -VaultStoreId

1CAD4933D9987A111B3E42E26A71984301110000@ev

Gets the current status of the metadata store for all archives supported bymetadata store in the specified vault store. Also includes a count of the numberof items that are present in the archive but are missing from the metadata store.

42Enterprise Vault PowerShell cmdlet referenceGet-EVMDSStatus

Page 43: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Import-CSV example.csv | Get-EVMDSStatus

Gets the current status of the metadata store for each archive that is specifiedin a CSV file.

■ Import-CSV example.csv | Select VaultStoreEntryId | Get-EVMDSStatus

Imports a record set from a CSV file and, for each value in the VaultStoreEntryIdcolumn, returns the current status of the metadata store for each archive thatis supported by metadata store.

■ Get-EVMDSStatus -VaultStoreId

1CAD4933D9987A111B3E42E26A71984301110000@ev -IncludeMissingItems

| Where-Object {$_.MDSStatus –ne 'EV_MDS_DISABLED' -and

$_.MDSMissingItems -gt 0} | New-EVMDSBuildTask -Mode Build -Force

Creates a metadata store build task for each Fast Browsing or IMAP enabledarchive in the specified vault store, if there are items missing from that archive'smetadata store.

OutputMDSStatus

MDSMissingItems

Table 4-26 lists the properties that are available.

Table 4-26 Get-EVMDSStatus properties

DescriptionTypeName

The ArchiveId.StringArchiveId

The current status of the metadata store.Possible values: "EV_MDS_DISABLED","EV_MDS_BUILD_PENDING","EV_MDS_BUILDING", "EV_MDS_READY","EV_MDS_BUILD_FAILED".

MDSStatusMDSStatus

Related cmdlets■ See “New-EVMDSBuildTask” on page 39.

Add-EVPstComputerAdd-EVPstComputer adds a computer as a locate and migrate PST migration target.Depending on configuration, Enterprise Vault can search the computer for PST filesto be migrated to Enterprise Vault. For example, you can add computers that belong

43Enterprise Vault PowerShell cmdlet referenceAdd-EVPstComputer

Page 44: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

to individual users, and you can add file servers that host PST files belonging tomany users.

Add-EVPstComputer is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxAdd-EVPstComputer -Name <String> [-Mailbox <String>] [-EnableSearch]

[-SiteName <String>] [-DirectoryServer <String>] [<CommonParameters>]

Parameters

Table 4-27 Add-EVPstComputer parameters

DescriptionParameter

The name of the computer you want to add as a PST migrationtarget.

-Name (required)

The name of the mailbox in which Enterprise Vault places shortcutsfor items migrated from PST files found on the computer. If you donot specify a mailbox, Add-EVPstComputer uses the mailbox thateach PST file is associated with. Typically, you would not specify amailbox for any computer that hosts PST files that belong to differentusers, such as a file server.

-Mailbox

Use -EnableSearch if you want Enterprise Vault to search thetarget computer for PST files.

-EnableSearch

If you have more than one Enterprise Vault site in your environment,use -SiteName to specify the site in which you want to add thecomputer.

-SiteName

If you execute Add-EVPstComputer from a server other than anEnterprise Vault server, specify the name of the Enterprise Vaultserver that Add-EVPstComputer should connect to.

-DirectoryServer

Examples■ Add-EVPstComputer -Name FileServer1 -EnableSearch

Adds FileServer1 as a PST migration target, and specifies that Enterprise Vaultshould search the server for PST files.

■ Add-EVPstComputer -Name JohnDoeLaptop -Mailbox "John Doe"

-EnableSearch

Adds John Doe’s laptop as a PST migration target, and also specifies John’smailbox, in which Enterprise Vault will place shortcuts for migrated items.

44Enterprise Vault PowerShell cmdlet referenceAdd-EVPstComputer

Page 45: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Related cmdlets■ See “Add-EVPstFile” on page 45.

Add-EVPstFileAdd-EVPstFile specifies the UNC path and name of a PST file whose contentsyou want to migrate to Enterprise Vault.

Add-EVPstFile is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxAdd-EVPstFile -UNCPath <String> [-Archive <String>] [-Mailbox

<String>] [-RetentionCategory <String>] [-PasswordProtected]

[-Language <String>] [-Priority <String>] [-SiteName <String>]

[-DirectoryServer <String>] [<CommonParameters>]

Parameters

Table 4-28 Add-EVPstFile parameters

DescriptionParameter

The complete UNC path to the PST file you want to migrate,including the name of the PST file itself.

-UNCPath (required)

The name of the archive to which you want to migrate the contentsof the PST file. If you do not specify the archive, Add-EVPstFilemigrates items to the archive that is associated with the mailboxthat owns the PST file.

-Archive

The name of the mailbox in which Enterprise Vault placesshortcuts for the migrated items. If you do not specify a mailbox,Add-EVPstFile uses the mailbox that the PST file is associatedwith.

-Mailbox

The retention category that is applied to the migrated items. Ifyou do not specify a retention category, Add-EVPstFile usesthe retention category set in the applicable PST migration policy.

-RetentionCategory

Indicates that the PST file is password protected. If you use-PasswordProtected, Add-EVPstFile prompts for thepassword.

-PasswordProtected

45Enterprise Vault PowerShell cmdlet referenceAdd-EVPstFile

Page 46: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-28 Add-EVPstFile parameters (continued)

DescriptionParameter

The language used in the PST file. If you do not specify alanguage, Add-EVPstFile uses the language set in theapplicable PST migration policy.

-Language

Sets the PST file's migration priority. You can specify any one ofthe following priorities, or their associated numerical values whichare shown in brackets: Critical (1), Important (2), High (3), Medium(4), Low (5), or Lowest (6). The default priority is Medium (4).

-Priority

If you have more than one Enterprise Vault site in yourenvironment, use -SiteName to specify the site in which you wantto migrate the PST file.

-SiteName

If you execute Add-EVPstFile from a server other than anEnterprise Vault server, specify the name of the Enterprise Vaultserver that Add-EVPstFile should connect to.

-DirectoryServer

Examples■ Add-EVPstFile -UNCPath

\\FileServer1\UserShares\VIPs\JohnDoe\PSTs\2012.pst

Adds the specified PST file for migration to Enterprise Vault.

Related cmdlets■ See “Add-EVPstComputer” on page 43.

Get-EVServerGets information about the current Enterprise Vault server.

Get-EVServer is provided by Symantec.EnterpriseVault.PowerShell.Core.dll,which is not imported automatically by the Enterprise Vault Management Shell. Youmust import this DLL module.

SyntaxGet-EVServer [<CommonParameters>]

ParametersPowerShell common parameters only.

46Enterprise Vault PowerShell cmdlet referenceGet-EVServer

Page 47: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-EVServer

Gets details of the current Enterprise Vault server.

OutputTable 4-29 lists the properties that are available.

Table 4-29 Get-EVServer properties

DescriptionTypeName

Alias names for the Enterprise Vault server.List<String>Aliases

The server Id.StringID

The server name.StringName

The version of Enterprise Vault that is on theserver.

StringVersion

Get-EVServiceGets details of the Enterprise Vault services that are configured on the currentEnterprise Vault server.

Get-EVService is provided by Symantec.EnterpriseVault.PowerShell.Core.dll,which is not imported automatically by the Enterprise Vault Management Shell. Youmust import this DLL module.

SyntaxGet-EVService [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVService

Lists the Enterprise Vault services that are configured on the current EnterpriseVault server.

OutputTable 4-30 lists the properties that are available.

47Enterprise Vault PowerShell cmdlet referenceGet-EVService

Page 48: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-30 Get-EVService properties

DescriptionTypeName

The service display name as shown in theAdministration Console. For example,"Enterprise Vault Directory Service".

StringDisplayName

The service EntryID.StringEntryID

The service name. For example,"EnterpriseVaultAdminService".

StringName

One of the following: "DirectoryService";"AdminService"; "ShoppingService";"IndexingService"; "StorageService";"TaskControllerService"

ServiceTypeType

Get-EVServiceState

Note: This cmdlet is deprecated. To obtain the status of Enterprise Vault services,use the Get-Service cmdlet.

Gets the current state of the specified Enterprise Vault service. The state can beeither "Running" or "Stopped".

Get-EVServiceState is provided bySymantec.EnterpriseVault.PowerShell.Monitoring.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVServiceState [-ServiceName] <String> [<CommonParameters>]

ParametersTable 4-31 lists the properties that are available.

Table 4-31 Get-EVServiceState properties

DescriptionParameter

The name of the service whose details you require.-ServiceName

48Enterprise Vault PowerShell cmdlet referenceGet-EVServiceState

Page 49: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-EVServiceState -ServiceName EnterpriseVaultShoppingService

Returns the current state of the EnterpriseVaultShoppingService. You canuse the Get-EVService to find the names of the Enterprise Vault services.

OutputTable 4-32 lists the properties that are available.

Table 4-32 Get-EVServiceState properties

DescriptionTypeName

One of the following: "Stopped";"StartPending"; "StopPending";"Running"; "ContinuePending";"PausePending"; "Paused".

Service ControllerStatus

Value

Related cmdlets■ See “Get-EVService” on page 47.

Get-EVSiteGets the Enterprise Vault site information for current Enterprise Vault server.

Get-EVSite is provided by Symantec.EnterpriseVault.PowerShell.Core.dll,which is not imported automatically by the Enterprise Vault Management Shell. Youmust import this DLL module.

SyntaxGet-EVSite [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVSite

Gets details of the Vault Site of which the current server is a member.

OutputTable 4-33 lists the properties that are available.

49Enterprise Vault PowerShell cmdlet referenceGet-EVSite

Page 50: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-33 Get-EVSite properties

DescriptionTypeName

The name of the SQL Server computer that hoststhe Directory database.

StringDirectorySQLServer

The Site ID.StringID

The name of the Enterprise Vault site.StringName

Get-EVSMTPHoldingFolderGet-EVSMTPHoldingFolder displays details of the SMTP holding folder that isconfigured on the Enterprise Vault server where you run the command. If the SMTParchiving task is not configured, Get-EVSMTPHoldingFolder produces no output.

Get-EVSMTPHoldingFolder is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import thismodule.

SyntaxGet-EVSMTPHoldingFolder [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVSMTPHoldingFolder

Displays details of the SMTP holding folder that is configured on the EnterpriseVault server where you run the command.

Get-EVSMTPPolicyGet-EVSMTPPolicy retrieves details of all the SMTP policies for the Enterprise Vaultsite you specify. If you do not specify a site ID using the -SiteID parameter, andGet-EVSMTPPolicy cannot determine the site, you are prompted to enter the siteID. You can also retrieve the properties of a specific policy using the -Name

parameter.

50Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPHoldingFolder

Page 51: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVSMTPPolicy is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVSMTPPolicy [-SiteId] <string> [[-Name] <string>]

[<CommonParameters>]

Parameters

Table 4-34 Get-EVSMTPPolicy parameters

DescriptionParameter

The ID of the site whose policies you want to retrieve.-SiteId (required)

The name of the SMTP policy you want to retrieve.-Name

Examples■ Get-EVSMTPPolicy -SiteId 13E9...EV1101.example.com

Retrieves all the SMTP policies configured in the specified Enterprise Vault site.

■ Get-EVSMTPPolicy -SiteId 13E9...EV1101.example.com -Name "SMTP

policy"

Or:Get-EVSMTPPolicy "SMTP policy"

Retrieves the properties of the SMTP policy, “SMTP policy”. For example:

SiteId : 13E9...EV1101.example.com

XHeaders : Symantec.EnterpriseVault.Admin.SMTPXHeaders

Name : SMTP policy

Description : SMTP policy

IsADefaultPolicy : True

EntryId : 1250...EV1101.example.com

■ You can use the following sequence of commands to view the properties of anSMTP policy and its X-Header details:

■ $sp = Get-EVSMTPPolicy 13E9...EV1101.example.com "SMTP policy"

Retrieves the SMTP policy into the $sp variable.

■ $sp

Displays the information contained in the $sp variable. For example:

51Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPPolicy

Page 52: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

SiteId : 13E9...EV1101.example.

XHeaders : Symantec.EnterpriseVault.Admin.SMTPXHeaders

Name : SMTP policy

Description :

IsADefaultPolicy : False

EntryId : 1700...EV1101.example.com

■ $sp.XHeaders

Displays X-Headers. For example:

HeadersList

-----------

{x-sender}

■ $sp.XHeaders.HeadersList

Displays a detailed listing of X-Headers. For example:

Name ValueType Searchable Retrievable

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

x-sender 0 0 0

■ You can use the following sequence of commands to list the SMTP targetsassociated with the specified SMTP policy:

■ $sp = Get-EVSMTPPolicy 13E9...EV1101.example.com "SMTP policy"

Retrieves the SMTP policy into the $sp variable.

■ $sp.GetTargets()

Lists all the SMTP targets associated with the policy. For example:

[email protected]

[email protected]

[email protected]

OutputGet-EVSMTPPolicy returns objects of the typeSymantec.EnterpriseVault.Admin.SMTPPolicy, which contains the propertieslisted in the following table.

Table 4-35 Symantec.EnterpriseVault.Admin.SMTPPolicy properties

DescriptionTypeName

The description of the SMTP policy.StringDescription

52Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPPolicy

Page 53: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-35 Symantec.EnterpriseVault.Admin.SMTPPolicy properties (continued)

DescriptionTypeName

The directory entry ID of the SMTP policy.StringEntryId

$true if the SMTP policy is a default policy, or $false if itis not.

BooleanIsADefaultPolicy

The name of the SMTP policy.StringName

The site ID to which the SMTP policy belongs.StringSiteId

Symantec.EnterpriseVault.Admin.SMTPXHeaders:Provides a list of X-Headers associated with the SMTP policy.For more information on X-Header lists, type get-helpabout_SMTPXHeaders at the PowerShell prompt.

ObjectXHeaders

Related cmdlets■ See “New-EVSMTPPolicy” on page 53.

■ See “Remove-EVSMTPPolicy” on page 55.

■ See “Set-EVSMTPPolicy” on page 56.

New-EVSMTPPolicyNew-EVSMTPPolicy creates a new SMTP policy with the specified name, description,and X-Header list. If you do not specify a site ID using the -SiteID parameter, andNew-EVSMTPPolicy cannot determine the site, you are prompted to enter the siteID. New-EVSMTPPolicy fails if you specify a policy name that already exists.

New-EVSMTPPolicy is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxNew-EVSMTPPolicy [-SiteId] <string> [-Name] <string> [-Description

<string>] [-XHeaders <Symantec.EnterpriseVault.Admin.SMTPXHeaders>]

[<CommonParameters>]

53Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPPolicy

Page 54: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-36 New-EVSMTPPolicy parameters

DescriptionParameter

The ID of the site to which you want to add the new SMTP policy.-SiteId (required)

The name of the new SMTP policy.-Name (required)

The description for the new SMTP policy.-Description

The X-Headers to add to the new SMTP policy.

For more information about the management of X-Header lists, typeget-help about_SMTPXHeaders at the PowerShell prompt.

-XHeaders

Examples■ New-EVSMTPPolicy -SiteId 13E9...EV1101.example.com -Name "SMTP

policy" -Description "SMTP policy created using PowerShell"

This command creates a new SMTP policy called “SMTP policy”, with thedescription “SMTP policy created using PowerShell”.

■ You can use the following sequence of commands to create an X-Headersobject, add two X-Headers to the object, then create a new SMTP policy:

■ $xheaders = New-Object

Symantec.EnterpriseVault.Admin.SMTPXHeaders

Creates an X-Headers object.

■ $xheaders.Add('x-code1')

$xheaders.Add('x-code2')

These commands add X-Headers “x-code1” and “x-code2” to the X-Headersobject.

■ New-EVSMTPPolicy -Name "SMTP policy" -XHeaders $xheaders

Creates a new SMTP policy called “SMTP policy”, adds the new X-Headersto it, and produces the following output:

SiteId : 13E9...EV1101.example.com

EntryId : 11E1...EV1101.example.com

IsADefaultPolicy : False

XHeaders : Symantec.EnterpriseVault.Admin.SMTPXHeaders

Name : SMTP policy

Description :

54Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPPolicy

Page 55: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

OutputNew-EVSMTPPolicy returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPPolicy, which contains the propertieslisted in the following table.

Table 4-37 Symantec.EnterpriseVault.Admin.SMTPPolicy properties

DescriptionTypeName

The description of the SMTP policy.StringDescription

The directory entry ID of the SMTP policy.StringEntryId

$true if the SMTP policy is a default policy, or $false if itis not.

BooleanIsADefaultPolicy

The name of the SMTP policy.StringName

The site ID to which the SMTP policy belongs.StringSiteId

Symantec.EnterpriseVault.Admin.SMTPXHeaders:Provides a list of X-Headers associated with the SMTP policy.For more information on X-Header lists, type get-helpabout_SMTPXHeaders at the PowerShell prompt.

ObjectXHeaders

Related cmdlets■ See “Get-EVSMTPPolicy” on page 50.

■ See “Remove-EVSMTPPolicy” on page 55.

■ See “Set-EVSMTPPolicy” on page 56.

Remove-EVSMTPPolicyRemove-EVSMTPPolicy deletes the SMTP policy you specify. You are prompted toconfirm the deletion. If you do not specify a site ID using the -SiteID parameter,and Remove-EVSMTPPolicy cannot determine the site, you are prompted to enterthe site ID.

Remove-EVSMTPPolicy is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxRemove-EVSMTPPolicy [-SiteId] <string> [-Name] <string>

[<CommonParameters>]

55Enterprise Vault PowerShell cmdlet referenceRemove-EVSMTPPolicy

Page 56: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-38 Remove-EVSMTPPolicy parameters

DescriptionParameter

The ID of the site to which the SMTP policy belongs.-SiteId (required)

The name of SMTP policy you want to remove.-Name (required)

Examples■ Remove-EVSMTPPolicy -SiteId 13E9...EV1101.example.com -Name "SMTP

policy"

Deletes the SMTP policy called “SMTP policy”.

■ You can use the following sequence of commands to add the SMTP policy called“SMTP policy” into the variable $sp, then delete it.

■ $sp = Get-EVSMTPPolicy 13E9...EV1101.example.com 'SMTP policy'

■ Remove-EVSMTPPolicy -AdminObject $sp

OutputRemove-EVSMTPPolicy returns no output.

Related cmdlets■ See “Get-EVSMTPPolicy” on page 50.

■ See “New-EVSMTPPolicy” on page 53.

■ See “Set-EVSMTPPolicy” on page 56.

Set-EVSMTPPolicySet-EVSMTPPolicy sets or updates the properties of an existing SMTP policy. Ifyou do not specify a site ID using the -SiteID parameter, and Set-EVSMTPPolicy

cannot determine the site, you are prompted to enter the site ID. If you specifyX-Headers, Set-EVSMTPPolicy overwrites the existing X-Headers in the policy.

Set-EVSMTPPolicy is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

56Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPPolicy

Page 57: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

SyntaxSet-EVSMTPPolicy [-SiteId] <string> [-Name] <string> [-Description

<string>] [-XHeaders <Symantec.EnterpriseVault.Admin.SMTPXHeaders>]

[<CommonParameters>]

Parameters

Table 4-39 Set-EVSMTPPolicy parameters

DescriptionParameter

The ID of the site to which the SMTP policy belongs.-SiteId (required)

The name of the SMTP policy you want to update.-Name (required)

The new description for the SMTP policy.-Description

The new X-Header list you want to add to the SMTP policy.Set-EVSMTPPolicy automatically removes any existing X-Headers,and replaces them with the new list.

For more information about the management of X-Header lists, typeget-help about_SMTPXHeaders at the PowerShell prompt.

-XHeaders

Examples■ Set-EVSMTPPolicy -SiteId '13E9...EV1101.example.com' -Name 'SMTP

policy' -Description 'SMTP journal archiving policy'

Updates the description of the SMTP policy called “SMTP policy”. The existingX-Headers are unchanged.

■ You can use the following sequence of commands to add a new X-Header tothe SMTP policy called “SMTP policy”:

■ $xh = New-Object Symantec.EnterpriseVault.Admin.SMTPXHeader

'x-Encoding'

The New-Object cmdlet creates a new X-Header object with the followingproperties: Name: 'x-Encoding', ValueType: 0 (string), Searchable: 0 (notsearchable), Retrievable: 0 (not retrievable).

■ $sp = Get-EVSMTPPolicy '13E9...EV1101.example.com' 'SMTP policy'

Retrieves the SMTP policy into the $sp variable.

■ $sp.XHeaders.Add($xh)

Adds the newly created X-Header to the list of X-Headers using the Add()

function of the XHeaders object. $sp now holds the modified SMTP policy.

■ Set-EVSMTPPolicy -AdminObject $sp

57Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPPolicy

Page 58: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Or:Set-EVSMTPPolicy -SiteId '13E9...EV1101.example.com' -Name 'SMTP

policy' -XHeaders $sp.XHeaders

Overwrites the Enterprise Vault copy of the SMTP policy with the new version.The first use of Set-EVSMTPPolicy updates the whole policy object. Thesecond use of Set-EVSMTPPolicy updates the policy object according tothe parameters that are provided.

■ You can use the following sequence of commands to modify the X-Header thatis already associated with the SMTP policy called “SMTP policy”.

■ $sp = Get-EVSMTPPolicy 13E9...EV1101.example.com "SMTP policy"

Retrieves the SMTP policy into the $sp variable.

■ $xh = $sp.XHeaders.GetXHeader('x-Encoding')

Retrieves the X-Header called “x-Encoding” into the $xh variable usingGetXHeader() function of the X-Headers object.

■ $xh.Name = 'x-Encoder'

$xh.Searchable = 0

Updates the in-memory copy of the X-Header with new values for the Name

property and then the Searchable property.

■ $sp.XHeaders.SetXHeader($xh.Name, $xh.ValueType, $xh.Searchable,

$xh.Retrievable)

Or:$sp.XHeaders.SetXHeader($xh)

Updates the in-memory X-Header list of the SMTP policy with the in-memorycopy of the X-Header.

■ Set-EVSMTPPolicy -AdminObject $sp

Updates the SMTP policy with the in-memory copy of the policy.

OutputSet-EVSMTPPolicy returns no output.

Related cmdlets■ See “Get-EVSMTPPolicy” on page 50.

■ See “New-EVSMTPPolicy” on page 53.

■ See “Remove-EVSMTPPolicy” on page 55.

58Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPPolicy

Page 59: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVSMTPServerSettingsGet-EVSMTPServerSettings displays the settings for all Enterprise Vault SMTPservers in the specified site. If you do not specify a site ID,Get-EVSMTPServerSettings uses the ID of the site to which the local EnterpriseVault server belongs. If you run the command a remote computer,Get-EVSMTPServerSettings prompts for a site ID.

Get-EVSMTPServerSettings is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVSMTPServerSettings [[-SiteId] <string>] [<CommonParameters>]

Parameters

Table 4-40 Get-EVSMTPServerSettings parameters

DescriptionParameter

The ID of the site to which the SMTP settings belong.-SiteId

Examples■ Get-EVSMTPServerSettings -SiteId 13E9...EV1101.example.com

This command returns the SMTP server settings that apply to all the SMTPservers in the specified site.

■ You can use the following sequence of commands to view the SMTP serversettings for the site:

■ $sp = Get-EVSMTPServerSettings 13E9...EV1101.example.com

Retrieves the SMTP server settings into the $sp variable.

■ $sp

Displays the information held in the $sp variable. For example:

SiteId : 13E9...EV1101.example.com

Port : 25

MaxMessageSize : 0

Authentication : EV_SMTP_AUTHENTICATION_ENABLE

AuthenticationEmailAddress : [email protected]

AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION

_ALLOWPLAINTEXT_TLS

Tls : EV_SMTP_TLS_ENCRYPTED

59Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPServerSettings

Page 60: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

TlsCertificateInfo : Symantec.EnterpriseVault.Admin

.TlsCertificate

SMTPConnectionControl : Symantec.EnterpriseVault.Admin

.SMTPConnectionControlList

■ $sp.SMTPConnectionControl.SMTPConnectionList

Displays the connection control list. The list contains the names or IPaddresses of the hosts that are allowed to connect to the Enterprise VaultSMTP servers. The host names should be fully qualified domain names.

Connections

-----------

{test.example.com}

■ $sp.SMTPConnectionControl.SMTPConnectionList.Connections

Displays a detailed list of connection controls. Type shows the value of the_EV_SMTP_CONNECTION enumeration.

Type Value

---- -----

EV_SMTP_CONNECTION_HOSTNAME test.example.com

OutputGet-EVSMTPServerSettings returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPServerSettings, which contains theproperties listed in the following table.

Table 4-41 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

DescriptionTypeName

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATIONenumeration value: Specifies whether authentication is required for incomingconnections. For details of the enumeration values, type get-helpabout_SMTPEnumerations at the PowerShell prompt.

ObjectAuthentication

The identity of the authentication user, if authentication is enabled.StringAuthenticationEmailAddress

60Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPServerSettings

Page 61: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-41 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties(continued)

DescriptionTypeName

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value:Specifies whether plain text authentication is allowed for incoming connections.If authentication is disabled this value defaults toEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER. For details of theenumeration values, type get-help about_SMTPEnumerations at thePowerShell prompt.

ObjectAuthenticationAllowPlainText

Maximum SMTP message size (in MB).IntegerMaxMessageSize

The port number on which the SMTP servers listen.IntegerPort

The ID of the site to which the SMTP server settings belong.StringSiteId

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList:Provides a list of allowed connections to the SMTP servers. For moreinformation on managing the list of allowed connections, type get-helpabout_SMTPConnectionControlList at the PowerShell prompt.

ObjectSMTPConnectionControl

Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value:Enumeration value that specifies the support for encrypted and unencryptedconnections to the SMTP servers. For details of the enumeration values, typeget-help about_SMTPEnumerations at the PowerShell prompt.

ObjectTls

Symantec.EnterpriseVault.Admin.TlsCertificate: Providesinformation about the TLS certificate used for SMTP connections.

ObjectTlsCertificateInfo

Related cmdlets■ See “New-EVSMTPServerSettings” on page 61.

■ See “Set-EVSMTPServerSettings” on page 67.

■ See “Sync-EVSMTPServerSettings” on page 72.

New-EVSMTPServerSettingsNew-EVSMTPServerSettings creates the initial settings for all Enterprise VaultSMTP servers in the specified site. If you do not specify a site ID using the -SiteID

parameter, and New-EVSMTPServerSettings cannot determine the site, you areprompted to enter the site ID.

This command fails if SMTP settings for site already exist.

61Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 62: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

New-EVSMTPServerSettings is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxNew-EVSMTPServerSettings [[-SiteId] <string>] -Port <integer>

[-MaxMessageSize <integer>] -Authentication

<Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration

value> [-AuthenticationCredentials

<System.Management.Automation.PSCredential>]

-AuthenticationAllowPlainText

<Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT

enumeration value> -Tls <Symantec.EnterpriseVault.Admin._EV_SMTP_TLS

enumeration value> [-TlsCertificateFile <string>]

[-TlsSecurePassphrase <System.Security.SecurseString>]

[-SMTPConnectionControl

<Symantec.EnterpriseVault.Admin.SMTPConnectionControlList>]

[<CommonParameters>]

Parameters

Table 4-42 New-EVSMTPServerSettings parameters

DescriptionParameter

The ID of the site to which the SMTP settingsapply.

-SiteId

The port number to be used by the SMTP serversin the site.

-Port (required)

The maximum message size that the SMTPservers accept (in MB). The SMTP servers willreject messages that are larger than the specifiedsize.

-MaxMessageSize

62Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 63: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-42 New-EVSMTPServerSettings parameters (continued)

DescriptionParameter

The enumeration value specifies whetherauthentication is enabled for SMTP connectionsto the SMTP servers. If the valueEV_SMTP_AUTHENTICATION_ENABLE isspecified, hosts that connect to the SMTP serversmust supply the credentials specified by theparameter -AuthenticationCredentials. Ifthe valueEV_SMTP_AUTHENTICATION_DISABLEis specified, then-AuthenticationCredentials is not required.For details of the enumerations used, typeget-help about_SMTPEnumerations.

-Authentication (required)

The credentials that hosts must use whenconnecting to SMTP servers in the site. Thisparameter is only required if -Authenticationis set to EV_SMTP_AUTHENTICATION_ENABLE.

-AuthenticationCredentials

Enumeration value that specifies whether plaintext authentication is enabled for SMTPconnections to the SMTP servers. If-Authentication is set toEV_SMTP_AUTHENTICATION_DISABLE, thisvalue is always set toEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

IfEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLSis specified, then TLS must be enabled on theSMTP servers or an appropriate exceptionmessage is generated.

For details of the enumerations used, typeget-help about_SMTPEnumerations at thePowerShell prompt.

-AuthenticationAllowPlainText(required)

63Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 64: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-42 New-EVSMTPServerSettings parameters (continued)

DescriptionParameter

The enumeration value specifies the support forencrypted and unencrypted connections to theSMTP servers. The protocol supported forencrypted connections is Transport Layer Security(TLS). If encrypted connections are supported,then you must specify values for the parameters-TlsCertificateFile and-TlsSecurePassphrase. For details of theenumerations used, type get-helpabout_SMTPEnumerations.

-Tls (required)

The path of the TLS certificate file to use forencrypted connections to the SMTP servers. Thisparameter is not required if only unencryptedconnections are supported.

-TlsCertificateFile

The TLS certificate file secure passphrase requiredfor encrypted connections to the SMTP servers.This parameter is not required if only unencryptedconnections are supported.

-TlsSecurePassphrase

A list of hosts that can connect to the SMTPservers. For details of SMTPConnectionControlListobject, type get-helpabout_SMTPConnectionControlList.

-SMTPConnectionControl

Examples■ New-EVSMTPServerSettings -Port 25 -Authentication

EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials

(New-Object System.Management.Automation.PSCredential -ArgumentList

"[email protected]", ("admin@123" | ConvertTo-SecureString

-AsPlainText -Force)) -AuthenticationAllowPlainText

EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS -Tls

EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED -TlsCertificateFile

"C:\rsa.p12" -TlsSecurePassphrase ("admin@123" |

ConvertTo-SecureString -AsPlainText -Force)

Creates the initial SMTP server settings for all SMTP servers in the specifiedsite. The SMTP servers listen on port 25, authentication is enabled, plain textauthentication is enabled on TLS, and both encrypted and unencryptedconnections are supported.

64Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 65: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ C:\PS> $xConnectionList = new-object

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAME", "Test")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMESUFFIX",

"smtp.example.com")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMEPATTERN",

"as-[a-z0-9]*-[a-z0-9]*.example.local")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4",

"192.168.1.1")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4INCIDR",

"192.168.1.1/24")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6",

"0000:0000:0000:0000:0000:0000:0000:0001")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6INCIDR",

"0000:0000:0000:0000:0000:0000:0000:0001/128")

C:\PS> New-EVSMTPServerSettings -Port 25 -Authentication

EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials

(New-Object System.Management.Automation.PSCredential -ArgumentList

"[email protected]", ("admin@123" | ConvertTo-SecureString

-AsPlainText -Force)) -Tls EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED

-TlsC ertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123"

| ConvertTo-SecureString -AsPlainText -Force)

-SMTPConnectionControl $xConnectionList

SiteId : 13E9...EV1101.example.com

Port : 25

MaxMessageSize : 0

Authentication : EV_SMTP_AUTHENTICATION_ENABLE

AuthenticationEmailAddress : [email protected]

AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION

_ALLOWPLAINTEXT_TLS

Tls : EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED

TlsCertificateInfo : Symantec.EnterpriseVault.Admin

.TlsCertificate

SMTPConnectionControl : Symantec.EnterpriseVault.Admin

.SMTPConnectionControlList

This sequence of commands creates the initial SMTP server settings for allSMTP servers in the specified site. The SMTP servers listen on port 25,authentication is enabled, plain text authentication is enabled on TLS, and bothencrypted and unencrypted connections are supported. The allowed connections

65Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 66: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

are added to the SMTPConnectionControlList object using different addressformats.

OutputNew-EVSMTPServerSettings returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPServerSettings, which contains theproperties listed in the following table.

Table 4-43 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

DescriptionTypeName

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATIONenumeration value: Specifies whether authentication is required for incomingconnections. For details of the enumeration values, type get-helpabout_SMTPEnumerations at the PowerShell prompt.

ObjectAuthentication

The identity of the authentication user, if authentication is enabled.StringAuthenticationEmailAddress

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value:Enumeration value that specifies whether plain text authentication is allowedfor incoming connections.

If authentication is disabled this value defaults toEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

For details of the enumeration values, type get-helpabout_SMTPEnumerations at the PowerShell prompt.

ObjectAuthenticationAllowPlainText

Maximum SMTP message size (in MB).IntegerMaxMessageSize

The port number on which the SMTP servers listen.IntegerPort

The ID of the site to which the SMTP server settings belong.StringSiteId

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList:Provides a list of allowed connections to the SMTP servers. For moreinformation on managing the list of allowed connections, type get-helpabout_SMTPConnectionControlList at the PowerShell prompt.

ObjectSMTPConnectionControl

Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value:Enumeration value that specifies the support for encrypted and unencryptedconnections to the SMTP servers. For details of the enumeration values, typeget-help about_SMTPEnumerations at the PowerShell prompt.

ObjectTls

66Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPServerSettings

Page 67: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-43 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties(continued)

DescriptionTypeName

Symantec.EnterpriseVault.Admin.TlsCertificate: Providesinformation about the TLS certificate used for SMTP connections.

For more information on the TlsCertificate object, type get-helpabout_TlsCertificate at the PowerShell prompt.

ObjectTlsCertificateInfo

Related cmdlets■ See “Get-EVSMTPServerSettings” on page 59.

■ See “Set-EVSMTPServerSettings” on page 67.

■ See “Sync-EVSMTPServerSettings” on page 72.

Set-EVSMTPServerSettingsSet-EVSMTPServerSettings updates the settings for all Enterprise Vault SMTPservers in the specified site. If you do not specify a site ID using the -SiteID

parameter, and Set-EVSMTPServerSettings cannot determine the site, you areprompted to enter the site ID.

This command fails if SMTP server settings for site do not exist.

Set-EVSMTPServerSettings is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-EVSMTPServerSettings [[-SiteId] <string>] [-Port <integer>]

[-MaxMessageSize <integer>] [-Authentication

<Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration

value>] [-AuthenticationCredentials

<System.Management.Automation.PSCredential>]

[-AuthenticationAllowPlainText

<Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT

enumeration value>] [-Tls <Symantec.EnterpriseVault.Admin._EV_SMTP_TLS

enumeration value>] [-TlsCertificateFile <string>]

[-TlsSecurePassphrase <System.Security.SecurseString>]

[-SMTPConnectionControl

<Symantec.EnterpriseVault.Admin.SMTPConnectionControlList>]

[<CommonParameters>]

67Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPServerSettings

Page 68: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-44 Set-EVSMTPServerSettings parameters

DescriptionParameter

The ID of the site to which the SMTP settingsapply.

-SiteId

The port number to be used by the SMTP serversin the site.

-Port

The maximum message size that the SMTPservers will accept (in MB). The SMTP servers willreject messages that are larger than the specifiedsize.

-MaxMessageSize

The enumeration value specifies whetherauthentication is enabled for SMTP connectionsto the SMTP servers. If the valueEV_SMTP_AUTHENTICATION_ENABLE isspecified, hosts that connect to the SMTP serversmust supply the credentials specified by theparameter -AuthenticationCredentials. Ifthe valueEV_SMTP_AUTHENTICATION_DISABLEis specified, then-AuthenticationCredentials is not required.For details of the enumerations used, typeget-help about_SMTPEnumerations.

-Authentication

The Authentication credentials of SMTP serversin the site. This parameter is only required if-Authentication is set toEV_SMTP_AUTHENTICATION_ENABLE.

-AuthenticationCredentials

68Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPServerSettings

Page 69: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-44 Set-EVSMTPServerSettings parameters (continued)

DescriptionParameter

Enumeration value that specifies whether plaintext authentication is enabled for SMTPconnections to the SMTP servers.

If -Authentication is set toEV_SMTP_AUTHENTICATION_DISABLE, thisvalue is always set toEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

IfEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLSis specified, then -TLS must be enabled on theSMTP servers or an appropriate exceptionmessage is generated.

For details of the enumerations used, typeget-help about_SMTPEnumerations at thePowerShell prompt.

-AuthenticationAllowPlainText

The enumeration value specifies the support forencrypted and unencrypted connections to theSMTP servers. The protocol supported forencrypted connect ions is Transport Layer Security(TLS). If encrypted connections are supported,then you must specify values for the parameters-TlsCertificateFile and-TlsSecurePassphrase. For details of theenumerations used, type get-helpabout_SMTPEnumerations.

-Tls

The path of the TLS certificate file to use forencrypted connections to the SMTP servers. Thisparameter is not required if only unencryptedconnections are supported.

-TlsCertificateFile

The TLS certificate file secure passphrase requiredfor encrypted connections to the SMTP servers.This parameter is not required if only unencryptedconnections are supported.

-TlsSecurePassphrase

A list of hosts that can connect to the SMTPservers. For details of SMTPConnectionControlListobject, type get-helpabout_SMTPConnectionControlList.

-SMTPConnectionControl

69Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPServerSettings

Page 70: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Set-EVSMTPServerSettings -SiteId 13E9...EV1101.example.com

-Authentication EV_SMTP_AUTHENTICATION_ENABLE

-AuthenticationCredentials (New-Object

System.Management.Automation.PSCredential -ArgumentList

"[email protected]", ("admin@123" | ConvertTo-SecureString

-AsPlainText -Force)) -AuthenticationAllowPlainText

EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS -Tls EV_SMTP_TLS_ENCRYP

TED_AND_UNENCRYPTED -TlsCertificateFile "C:\rsa.p12"

-TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString

-AsPlainText -Force)

This command updates SMTP server settings for all SMTP servers in thespecified site. The SMTP servers continue to listen on the port previouslyconfigured , authentication is enabled, and both encrypted and unencryptedconnections are supported.

■ C:\PS> $xConnectionList = new-object

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAME", "Test")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMESUFFIX",

"smtp.example.com")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMEPATTERN",

"as-[a-z0-9]*-[a-z0-9]*.example.Local")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4",

"192.168.1.1")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4INCIDR",

"192.168.1.1/24")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6",

"0000:0000:0000:0000:0000:0000:0000:0001")

C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6INCIDR",

"0000:0000:0000:0000:0000:0000:0000:0001/128")

C:\PS> Set-EVSMTPServerSettings -Port 25 -Authentication

EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials

(New-Object System.Management.Automation.PSCredential -ArgumentList

"[email protected]", ("admin@123" | ConvertTo-SecureString

-AsPlainText -Force)) -AuthenticationAllowPlainText

EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER -Tls

EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED -TlsC ertificateFile

"C:\rsa.p12" -TlsSecurePassphrase ("admin@123" |

ConvertTo-SecureString -AsPlainText -Force) -SMTPConnectionControl

$xConnectionList

70Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPServerSettings

Page 71: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

C:\PS> Get-EVSMTPServerSettings

SiteId : 13E9...EV1101.example.com

Port : 25

MaxMessageSize : 0

Authentication : EV_SMTP_AUTHENTICATION_ENABLE

AuthenticationEmailAddress : [email protected]

AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION

_ALLOWPLAINTEXT_NEVER

Tls : EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED

TlsCertificateInfo : Symantec.EnterpriseVault.Admin

.TlsCertificate

SMTPConnectionControl : Symantec.EnterpriseVault.Admin

.SMTPConnectionControlList

This sequence of commands updates SMTP server settings for all SMTP serversin the specified site. The SMTP servers listen on port 25, authentication isenabled, plain text authentication is not allowed, and both encrypted andunencrypted connections are supported. The allowed connections are addedto the SMTPConnectionControlList object using different address formats.

OutputSet-EVSMTPServerSettings returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPServerSettings, which contains theproperties listed in the following table.

Table 4-45 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

DescriptionTypeName

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATIONenumeration value: Specifies whether authentication is required for incomingconnections. For details of the enumeration values, type get-helpabout_SMTPEnumerations at the PowerShell prompt.

ObjectAuthentication

The identity of the authentication user, if authentication is enabled.StringAuthenticationEmailAddress

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value:Specifies whether plain text authentication is allowed for incoming connections.

If authentication is disabled this value defaults toEV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

For details of the enumeration values, type get-helpabout_SMTPEnumerations at the PowerShell prompt.

ObjectAuthenticationAllowPlainText

71Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPServerSettings

Page 72: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-45 Symantec.EnterpriseVault.Admin.SMTPServerSettings properties(continued)

DescriptionTypeName

Maximum SMTP message size (in MB).IntegerMaxMessageSize

The port number on which the SMTP servers listen.IntegerPort

The ID of the site to which the SMTP server settings belong.StringSiteId

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList:Provides a list of allowed connections to the SMTP servers. For moreinformation on managing the list of allowed connections, type get-helpabout_SMTPConnectionControlList at the PowerShell prompt.

ObjectSMTPConnectionControl

Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value:Enumeration value that specifies the support for encrypted and unencryptedconnections to the SMTP servers. For details of the enumeration values, typeget-help about_SMTPEnumerations at the PowerShell prompt.

ObjectTls

Symantec.EnterpriseVault.Admin.TlsCertificate: Providesinformation about the TLS certificate used for SMTP connections.

For more information on the TlsCertificate object, type get-helpabout_TlsCertificate at the PowerShell prompt.

ObjectTlsCertificateInfo

Related cmdlets■ See “Get-EVSMTPServerSettings” on page 59.

■ See “New-EVSMTPServerSettings” on page 61.

■ See “Sync-EVSMTPServerSettings” on page 72.

Sync-EVSMTPServerSettingsSync-EVSMTPServerSettings synchronizes the SMTP server settings in theEnterprise Vault directory with those on the SMTP server you specify. If you do notspecify a server, Sync-EVSMTPServerSettings synchronizes the settings on theserver on which you run the command.

If you use -Recreate $True, Sync-EVSMTPServerSettings recreates all the SMTPserver settings on the specified server using the settings that are stored in theEnterprise Vault directory.

Sync-EVSMTPServerSettings is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

72Enterprise Vault PowerShell cmdlet referenceSync-EVSMTPServerSettings

Page 73: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

SyntaxSync-EVSMTPServerSettings [[-Server] <string>] [[-Recreate] <boolean>]

[<CommonParameters>]

Parameters

Table 4-46 Sync-EVSMTPServerSettings parameters

DescriptionParameter

The name of the SMTP server on which you want to synchronize or recreatethe SMTP server settings. You must specify the server’s host name or aliasas a fully qualified domain name.

-Server

Forces recreation the SMTP server settings, rather than synchronization.-Recreate

Examples■ Sync-EVSMTPServerSettings

Synchronizes the SMTP server settings on the server where you run thecommand.

■ Sync-EVSMTPServerSettings -Server smtp.example.com

Synchronizes the SMTP server settings on smtp.example.com.

■ Sync-EVSMTPServerSettings -Recreate $True

Deletes the existing SMTP server settings on the server where you run thecommand, and recreates them from the SMTP server settings that are storedin the Enterprise Vault directory.

■ Sync-EVSMTPServerSettings -Server smtp.example.com -Recreate $True

Deletes the existing SMTP server settings on smtp.example.com, and recreatesthem from the SMTP server settings that are stored in the Enterprise Vaultdirectory.

OutputSync-EVSMTPServerSettings returns no output.

Related cmdlets■ See “Get-EVSMTPServerSettings” on page 59.

■ See “New-EVSMTPServerSettings” on page 61.

■ See “Set-EVSMTPServerSettings” on page 67.

73Enterprise Vault PowerShell cmdlet referenceSync-EVSMTPServerSettings

Page 74: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVSMTPTargetGet-EVSMTPTarget returns all the SMTP target addresses that are configured inthe Enterprise Vault site. If you do not specify a site ID using the -SiteID parameter,and Get-EVSMTPTarget cannot determine the site, you are prompted to enter thesite ID. If you specify the name of an SMTP target, then Get-EVSMTPTarget getsthe properties of that target address. See the help for New-EVSMTPTarget for adescription of the properties.

When you run New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget,Enterprise Vault updates the SMTP target information in the Enterprise Vaultdirectory, and on each Enterprise Vault SMTP server in the site. If Enterprise Vaultis unable to update the SMTP target on any of the SMTP servers, you can use theGetFailedEVServerList function to list the servers that Enterprise Vault could notupdate.

Get-EVSMTPTarget is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-EVSMTPTarget [-SiteId] <string> [[-Name] <string>]

[<CommonParameters>]

Parameters

Table 4-47 Get-EVSMTPTarget parameters

DescriptionParameter

The ID of the site whose SMTP target you want to retrieve.-SiteId (required)

The address of the SMTP target to retrieve.-Name

Examples■ Get-EVSMTPTarget -SiteId 13E9...EV1101.example.com

This command returns all the SMTP targets that are configured in the EnterpriseVault site.

■ You can use the following sequence of commands to return information aboutthe SMTP target [email protected]:

■ $st = New-Object Symantec.EnterpriseVault.Admin.SMTPTarget

Uses New-Object to create a new variable called $st to hold an SMTPTarget

object.

74Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPTarget

Page 75: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ $st.Name = "[email protected]"

Specifies [email protected] as the target to be retrieved, using theName parameter.

■ $st.Read()

Retrieves Information about the specified SMTP target into $st using theRead method.

■ $st

Displays the target information contained in $st variable. For example:

SiteId : 13E9...EV1101.example.com

Name : [email protected]

PolicyId : 138C...EV1101.example.com

PolicyName : Default SMTP Policy

RetentionCategoryId : 100C...EV1101.example.com

RetentionCategory : Default Retention Category

ArchiveId : 11F2...EV1101.example.com

ArchiveType : SMTP

ArchiveName : SMTPLocal

VaultStoreName : Express Vault Store

ArchivingEnabled : true

RetryCount : 0

You can also display this information using either of the following commands:

■ Get-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name

[email protected]

■ Get-EVSMTPTarget 13E9...EV1101.example.com [email protected]

■ You can use the following sequence of commands to return information aboutan SMTP target, and find the list of servers on which the target was not up datedby any of New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget:

■ $st = Get-EVSMTPTarget 13E9...EV1101.example.com

[email protected]

Retrieves the SMTP target into the $st variable.

■ $st

Displays the target information held in $st. For example:

SiteId : 13E9...EV1101.example.com

Name : [email protected]

PolicyId : 138C...EV1101.example.com

PolicyName : Default SMTP Policy

75Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPTarget

Page 76: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

RetentionCategoryId : 100C...EV1101.example.com

RetentionCategory : Default Retention Category

ArchiveId : 11F2...EV1101.example.com

ArchiveType : SMTP

ArchiveName : SMTPLocal

VaultStoreName : Express Vault Store

ArchivingEnabled : true

RetryCount : 0

■ $st.GetFailedEVServerList()

Displays the list of Enterprise Vault servers on which the target was notupdated. For example:

EV1101, EVSMTP11

OutputGet-EVSMTPTarget returns objects of the typeSymantec.EnterpriseVault.Admin.SMTPTarget, which contains the propertieslisted in the following table.

Table 4-48 Symantec.EnterpriseVault.Admin.SMTPTarget properties

DescriptionTypeName

The ID of the archive associated with the SMTP target.StringArchiveId

The name of the archive associated with the SMTP target.StringArchiveName

_DV_DS_E_VAULT_TYPE: The type of the archiveassociated with the SMTP target.

ObjectArchiveType

$true if messages sent to or from the SMTP target arecurrently being archived, or $false if they are not.

BooleanArchivingEnabled

The SMTP target address.StringName

The ID of the SMTP policy associated with the SMTP target.StringPolicyId

The SMTP policy associated with the SMTP target.StringPolicyName

The name of the retention category associated with theSMTP target.

StringRetentionCategory

The ID of the retention category associated with the SMTPtarget.

StringRetentionCategoryId

The ID of the site to which the target belongs.StringSiteId

76Enterprise Vault PowerShell cmdlet referenceGet-EVSMTPTarget

Page 77: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-48 Symantec.EnterpriseVault.Admin.SMTPTarget properties (continued)

DescriptionTypeName

The name of the vault store associated with the SMTPtarget.

StringVaultStoreName

Related cmdlets■ See “New-EVSMTPTarget” on page 77.

■ See “Remove-EVSMTPTarget” on page 80.

■ See “Set-EVSMTPTarget” on page 81.

New-EVSMTPTargetNew-EVSMTPTarget adds a new SMTP target with the specified SMTP address andother properties. If you do not specify a site ID using the -SiteID parameter, andNew-EVSMTPTarget cannot determine the site, you are prompted to enter the siteID.

New-EVSMTPTarget adds the SMTP target information to the directory, and to eachEnterprise Vault SMTP server in the site.

To add a new SMTP target you must specify the following:

■ The target SMTP email address (use -Name)

■ An existing SMTP policy (use -PolicyName or -PolicyId)

■ An existing retention category (use -RetentionCategory or-RetentionCategoryId)

■ An existing archive (use -ArchiveName or -ArchiveId)

■ The type of archive (use -ArchiveType or -ArchiveId)

You can specify each of the policy, retention category, and archive using its name,its ID, or both. If you use both a name and an ID, the two must relate to the samepolicy, retention category, or archive.

Use -ArchivingEnabled $True to enable archiving for the target, or-ArchivingEnabled $False to disable archiving.

New-EVSMTPTarget fails if you specify a target that already exists, or if you specifySMTP settings that do not exist in the site.

77Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPTarget

Page 78: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

If New-EVSMTPTarget fails to update the SMTP settings on any of the EnterpriseVault SMTP servers, the GetFailedEVServerList function can list the servers thatwere not updated. See the help for Get-EVSMTPTarget for an example.

New-EVSMTPTarget is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxNew-EVSMTPTarget [-SiteId] <string> [-Name] <string> [-PolicyId

<string>] [-PolicyName <string>] [-RetentionCategoryId <string>]

[-RetentionCategory <string>] [-ArchiveId <string>] [-ArchiveName

<string>] -ArchiveType <string> [-ArchivingEnabled <Boolean>]

[-RetryCount <string>] [<CommonParameters>]

Parameters

Table 4-49 New-EVSMTPTarget parameters

DescriptionParameter

The ID of the site in which you want to add the SMTP target.-SiteId (required)

The SMTP address of the target.-Name (required)

The ID of an existing SMTP policy to be associated with theSMTP target.

-PolicyId

The name of an existing SMTP policy to be associated withthe SMTP target.

-PolicyName

The ID of an existing retention category to be associated withthe SMTP target.

-RetentionCategoryId

The name of an existing retention category to be associatedwith the SMTP target.

-RetentionCategory

The ID of the archive in which Enterprise Vault will archive thetarget’s messages.

-ArchiveId

The name of the archive in which Enterprise Vault will archivethe target’s messages.

-ArchiveName

The type of archive in which Enterprise Vault will archive thetarget’s messages.

-ArchiveType (required)

Set to $True to archive the target’s messages (incoming andoutgoing). Set to $False to disable archiving for the target.

-ArchivingEnabled

78Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPTarget

Page 79: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-49 New-EVSMTPTarget parameters (continued)

DescriptionParameter

The maximum number of times New-EVSMTPTarget willattempt to update the target information on the Enterprise VaultSMTP servers in the site.

-RetryCount

Examples■ New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name

[email protected] -PolicyName 'SMTP policy' -RetentionCategory

'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP

-ArchivingEnabled $true

Adds a new SMTP target, “[email protected]”, with the specifiedproperties.

OutputNew-EVSMTPTarget returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPTarget, which contains the propertieslisted in the following table.

Table 4-50 Symantec.EnterpriseVault.Admin.SMTPTarget properties

DescriptionTypeName

The ID of the archive associated with the SMTP target.StringArchiveId

The name of the archive associated with the SMTP target.StringArchiveName

_DV_DS_E_VAULT_TYPE: The type of the archiveassociated with the SMTP target.

ObjectArchiveType

$true if messages sent to or from the SMTP target arecurrently being archived, or $false if they are not.

BooleanArchivingEnabled

The SMTP target address.StringName

The ID of the SMTP policy associated with the SMTP target.StringPolicyId

The SMTP policy associated with the SMTP target.StringPolicyName

The name of the retention category associated with theSMTP target.

StringRetentionCategory

The ID of the retention category associated with the SMTPtarget.

StringRetentionCategoryId

79Enterprise Vault PowerShell cmdlet referenceNew-EVSMTPTarget

Page 80: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-50 Symantec.EnterpriseVault.Admin.SMTPTarget properties (continued)

DescriptionTypeName

The ID of the site to which the target belongs.StringSiteId

The name of the vault store associated with the SMTPtarget.

StringVaultStoreName

Related cmdlets■ See “Get-EVSMTPTarget” on page 74.

■ See “Remove-EVSMTPTarget” on page 80.

■ See “Set-EVSMTPTarget” on page 81.

Remove-EVSMTPTargetRemove-EVSMTPTarget removes the specified SMTP target. You are prompted toconfirm the removal of the target. If you do not specify a site ID using the -SiteID

parameter, and Remove-EVSMTPTarget cannot determine the site, you are promptedto enter the site ID.

Enterprise Vault removes the SMTP target information from the directory, and fromeach Enterprise Vault SMTP server in the site. If Remove-EVSMTPTarget fails toupdate the SMTP settings on any of the Enterprise Vault SMTP servers, theGetFailedEVServerList function can list the servers that were not updated. Seethe help for Get-EVSMTPTarget for an example.

Remove-EVSMTPTarget is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxRemove-EVSMTPTarget [-SiteId] <string> [-Name] <string> [-RetryCount

<string>] [<CommonParameters>]

Parameters

Table 4-51 Remove-EVSMTPTarget parameters

DescriptionParameter

The ID of the site from which to remove the SMTP target.-SiteId (required)

The SMTP address of the target you want to remove.-Name (required)

80Enterprise Vault PowerShell cmdlet referenceRemove-EVSMTPTarget

Page 81: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-51 Remove-EVSMTPTarget parameters (continued)

DescriptionParameter

The maximum number of times Remove-EVSMTPTargetwill attemptto update the target information on the Enterprise Vault SMTP serversin the site.

-RetryCount

Examples■ Remove-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name

[email protected]

This command removes the SMTP target, “[email protected]”.

■ This sequence of commands first adds the SMTP target“[email protected]” into the $st variable, then removes it.

■ $st = Get-EVSMTPTarget 13E9...EV1101.example.com

[email protected]

Adds the SMTP target “[email protected]” into the $st variable.

■ Remove-EVSMTPTarget -AdminObject $st -RetryCount 3

Makes a maximum of three attempts to remove the target.

OutputRemove-EVSMTPTarget returns no output.

Related cmdlets■ See “Get-EVSMTPTarget” on page 74.

■ See “New-EVSMTPTarget” on page 77.

■ See “Set-EVSMTPTarget” on page 81.

Set-EVSMTPTargetSet-EVSMTPTarget sets or updates the specified properties of an existing SMTPtarget. If you do not specify a site ID using the -SiteID parameter, andSet-EVSMTPTarget cannot determine the site, you are prompted to enter the siteID.

Set-EVSMTPTarget sets the SMTP target information in the directory, and on eachEnterprise Vault SMTP server in the site.

Use -ArchivingEnabled $True to enable archiving for the target, or-ArchivingEnabled $False to disable archiving.

81Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPTarget

Page 82: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

If Set-EVSMTPTarget fails to update the SMTP settings on any of the EnterpriseVault SMTP servers, the GetFailedEVServerList function can list the servers thatwere not updated. See the help for Get-EVSMTPTarget for an example.

Set-EVSMTPTarget is provided bySymantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-EVSMTPTarget [-SiteId] <string> [-Name] <string> [-PolicyId

<string>] [-PolicyName <string>] [-RetentionCategoryId <string>]

[-RetentionCategory <string>] [-ArchiveId <string>] [-ArchiveName

<string>] [-ArchiveType <_DV_DS_E_VAULT_TYPE>] [-ArchivingEnabled

<Boolean>] [<CommonParameters>]

Parameters

Table 4-52 New-EVSMTPTarget parameters

DescriptionParameter

The ID of the site in which you want update the SMTP target.-SiteId (required)

The SMTP address of the target.-Name (required)

The ID of an existing SMTP policy to be associated with theSMTP target.

-PolicyId

The name of an existing SMTP policy to be associated withthe SMTP target.

-PolicyName

The ID of an existing retention category to be associated withthe SMTP target.

-RetentionCategoryId

The name of an existing retention category to be associatedwith the SMTP target.

-RetentionCategory

The ID of the archive in which Enterprise Vault will archive thetarget’s messages.

-ArchiveId

The name of the archive in which Enterprise Vault will archivethe target’s messages.

-ArchiveName

The type of archive in which Enterprise Vault will archive thetarget’s messages.

-ArchiveType

Set to $True to archive the target’s messages (incoming andoutgoing). Set to $False to disable archiving for the target.

-ArchivingEnabled

82Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPTarget

Page 83: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Set-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name

[email protected] -PolicyName 'SMTP policy' -RetentionCategory

'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP

-ArchivingEnabled $true

Updates the SMTP target, “[email protected]” with the propertiesspecified.

■ Set-EVSMTPTarget 13E9...EV1101.example.com -Name

[email protected] -PolicyId 162D38C860C202443AAA64F0E661F2F

761s10000EV1004.example.com -RetentionCategoryId

11B6C2AAB7B83DD45AEC3AE28F0D341AE1b10000EV1004.example.com

-ArchiveName SMTPLocal -ArchiveType SMTP -ArchivingEnabled $True

Updates the policy, retention category, and archive of the SMTP target,“[email protected]”, and enables archiving. The new policy and retentioncategory are specified using ID values.

■ You can use the following sequence of commands to associate a new SMTPpolicy called "Sales SMTP policy" with the target:

■ $st = Get-EVSMTPTarget 13E9...EV1101.example.com

'[email protected]'

Retrieves the SMTP target, “[email protected]”, into the $st variable.

■ $st.PolicyName="Sales SMTP policy'

Updates the $st variable with the new SMTP policy.

■ Set-EVSMTPTarget -AdminObject $st

Uses the copy of the SMTP target held in $st to update the SMTP targetinformation in the directory and on each Enterprise Vault SMTP server inthe site.

OutputSet-EVSMTPTarget returns an object of the typeSymantec.EnterpriseVault.Admin.SMTPTarget, which contains the propertieslisted in the following table.

Table 4-53 Symantec.EnterpriseVault.Admin.SMTPTarget properties

DescriptionTypeName

The ID of the archive associated with the SMTP target.StringArchiveId

The name of the archive associated with the SMTP target.StringArchiveName

83Enterprise Vault PowerShell cmdlet referenceSet-EVSMTPTarget

Page 84: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-53 Symantec.EnterpriseVault.Admin.SMTPTarget properties (continued)

DescriptionTypeName

_DV_DS_E_VAULT_TYPE: The type of the archiveassociated with the SMTP target.

ObjectArchiveType

$true if messages sent to or from the SMTP target arecurrently being archived, or $false if they are not.

BooleanArchivingEnabled

The SMTP target address.StringName

The ID of the SMTP policy associated with the SMTP target.StringPolicyId

The SMTP policy associated with the SMTP target.StringPolicyName

The name of the retention category associated with theSMTP target.

StringRetentionCategory

The ID of the retention category associated with the SMTPtarget.

StringRetentionCategoryId

The ID of the site to which the target belongs.StringSiteId

The name of the vault store associated with the SMTPtarget.

StringVaultStoreName

Related cmdlets■ See “Get-EVSMTPTarget” on page 74.

■ See “New-EVSMTPTarget” on page 77.

■ See “Remove-EVSMTPTarget” on page 80.

Get-EVStorageDatabaseGets vault store and fingerprint database details for the current Enterprise Vaultserver.

Get-EVStorageDatabase is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVStorageDatabase [<CommonParameters>]

84Enterprise Vault PowerShell cmdlet referenceGet-EVStorageDatabase

Page 85: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

ParametersPowerShell common parameters only.

Examples■ Get-EVStorageDatabase

This command gets vault store and fingerprint databases details for an EnterpriseVault server.

OutputTable 4-54 lists the properties that are available.

Table 4-54 Get-EVStorageDatabase properties

DescriptionTypeName

A database name.StringDBName

The vault store Entry Id.StringEntryId

Indicates whether SQL Server isclustered.

BooleanIsClustered

The name of the SQL Instance that hoststhe database.

StringSQLInstanceName

The name of the SQL Server that hoststhe database.

StringSQLServerName

The version of SQL Server on the serverthat hosts the database.

StringSQLServerVersion

The Storage Service Entry Id.StringStorageServiceEntryId

One of the following: "VaultStore";"Fingerprint".

EVDatabaseTypeType

The name of the Vault Store Group thathosts the vault store.

StringVaultStoreGroupName

The name of the Vault Store.StringVaultStoreName

Related cmdlets■ See “Get-EVDatabase” on page 24.

■ See “Get-EVDatabaseFileInfo” on page 25.

85Enterprise Vault PowerShell cmdlet referenceGet-EVStorageDatabase

Page 86: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVTaskGets details of the Enterprise Vault tasks that are configured on the currentEnterprise Vault server.

Get-EVTask is provided by Symantec.EnterpriseVault.PowerShell.Core.dll,which is not imported automatically by the Enterprise Vault Management Shell. Youmust import this DLL module.

SyntaxGet-EVTask [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVTask

This command gets details of the Enterprise Vault tasks that are configured onthe current server.

OutputTable 4-55 lists the properties that are available.

Table 4-55 Get-EVTask properties

DescriptionTypeName

The description of the task, as shown the task'sproperties in the Administration Console.

StringDescription

The task's Entry ID.StringEntryID

The task's name, as shown in the AdministrationConsole.

StringName

86Enterprise Vault PowerShell cmdlet referenceGet-EVTask

Page 87: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-55 Get-EVTask properties (continued)

DescriptionTypeName

One of the following:"EV_TASK_TYPE_ARCHIVING";"EV_TASK_TYPE_CLIENTACCESS_POLICY_SYNC";"EV_TASK_TYPE_DOMINO_MAILBOX_ARCHIVING";"EV_TASK_TYPE_DOMINO_MAILBOX_POLICY_SYNC";"EV_TASK_TYPE_EXCHANGE_POLICY_SYNC";"EV_TASK_TYPE_FSA";"EV_TASK_TYPE_INDEXING";"EV_TASK_TYPE_JOURNALING";"EV_TASK_TYPE_MOVE_ARCHIVE";"EV_TASK_TYPE_NOTES_JOURNALING";"EV_TASK_TYPE_PSTCOLLECTOR";"EV_TASK_TYPE_PSTLOCATOR";"EV_TASK_TYPE_PSTMIGRATOR";"EV_TASK_TYPE_PUBLICFOLDER";"EV_TASK_TYPE_SHAREPOINT".

StringType

Related cmdlets■ See “Get-EVTaskState” on page 87.

Get-EVTaskStateGets the current state of the specified Enterprise Vault task.

Get-EVDatabase is provided bySymantec.EnterpriseVault.PowerShell.Monitoring.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVTaskState [-TaskEntryID] <String> [<CommonParameters>]

Parameters

Table 4-56 Get-EVTaskState parameters

DescriptionParameter

The TaskEntryID of the task whose details you require. You can use theGet-EVTask cmdlet to get the TaskEntryID.

-TaskEntryID

87Enterprise Vault PowerShell cmdlet referenceGet-EVTaskState

Page 88: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-EVTask | foreach{$_.EntryID;Get-EVTaskState $_.EntryID}

Uses Get-EVTask to get the TaskEntryID of each task on the current EnterpriseVault

OutputTable 4-57 lists the properties that are available.

Table 4-57 Get-EVTaskState properties

DescriptionTypeName

A text string that describes the current status ofthe task. Possible values: "Stopping", "Stopped","Running", "Refreshing", "Paused", "Loading","Failed", "Disabled", "CntrSvcNotRunning","Error", "Processing", "Invalid".

String(None)

Related cmdlets■ See “Get-EVTask” on page 86.

Get-EVVaultStoreGets information about the Vault Stores that are hosted by the current EnterpriseVault server.

Get-EVVaultStore is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLmodule.

SyntaxGet-EVVaultStore [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVVaultStore

Returns details of all the Vault Stores on the current Enterprise Vault server.

88Enterprise Vault PowerShell cmdlet referenceGet-EVVaultStore

Page 89: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

OutputTable 4-58 lists the properties that are available.

Table 4-58 Get-EVVaultStore properties

DescriptionTypeName

One of the following: "True" (backupmode is on); "False" (backup modeis off).

BooleanBackupMode

The name of the server that hoststhe vault store.

StringComputer

The name of the vault storedatabase.

StringDatabaseName

The vault store Entry Id.StringEntryId

This property is "True" when a vaultstore is enabled for indexing,otherwise it is "False".

BooleanIndexed

The vault store name.StringName

The safety copy removal setting.One of the following: "Never","Immediately", "AfterBackup","AfterBackupImmediateForJournaling".

RemovalStatusRemovalStatus

One of the following:"ShareWithinVaultStore";"ShareWithinGroup"; "NoSharing".

VaultStoreSharingLevelSharingLevel

The SQL Server that hosts the vaultstore.

StringSQLServer

One of the following: "Available","MarkedForDeletion","BackupMode", "BeingCreated".

VaultStoreStatusStatus

The name of the vault store groupthat the vault store is in.

StringVaultStoreGroupName

Get-EVVaultStorePartitionGets information about Vault Store partitions.

89Enterprise Vault PowerShell cmdlet referenceGet-EVVaultStorePartition

Page 90: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVVaultStorePartition is provided bySymantec.EnterpriseVault.PowerShell.Core.dll, which is not importedautomatically by the Enterprise Vault Management Shell. You must import this DLLfile.

SyntaxGet-EVVaultStorePartition [<CommonParameters>]

ParametersPowerShell common parameters only.

Examples■ Get-EVVaultStorePartition

Returns database details about all the Vault Store partitions on the currentserver.

OutputTable 4-59 lists the properties that are available.

Table 4-59 Get-EVVaultStorePartition properties

DescriptionTypeName

An indication of the collector type.StringCollectorType

The name of the server that hosts thepartition.

StringComputer

The date and time that the partition wascreated.

DateTimeCreationDate

The type of device on which the partitionresides. For example, "NTFS Volume".

StringDeviceType

The vault store partition Entry Id.StringEntryId

The number of hours since the partitionwas last backed up.

Int32HoursSinceLastBackup

One of the following: "Unknown","NonWorm", "VolumeLevelRetPolicy","Snaplock", "Snaplike", "Atime","Streamer", "Max".

VaultStorePartitionInterfaceType

InterfaceType

90Enterprise Vault PowerShell cmdlet referenceGet-EVVaultStorePartition

Page 91: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-59 Get-EVVaultStorePartition properties (continued)

DescriptionTypeName

The date and time that the partition waslast backed up. This value is null if thepartition has never been backed up.

DateTimeLastBackupDate

The date and time that the partition waslast placed in an open state. This value isnull if the partition has never been open.

DateTimeLastOpenedDate

The path to the partition.StringLocation

An indication of the migrator type.StringMigratorType

The name of the partition.StringName

One of the following: "NotEnabled","EnabledBasedOnVolumeSize","EnabledBasedOnVolumePercentage","EnabledBasedOnDateTime","EnabledBasedOnVolumeSizeAndDateTime","EnabledBasedOnVolumePercentageAndDateTime","EnabledBasedOnTimerAfter","EnabledBasedOnVolumeSizeAndTimerAfter","EnabledBasedOnVolumePercentageAndTimerAfter".

RolloverTypeRollOver

One of the following: "Undefined","Closed", "Open", "Standby","BeingDeleted", "Ready".

PartitionStateStatus

The total amount of space available, ingigabytes. This value can be null.

DoubleTotalQuotaGBytesAvailable

The total amount of free space, ingigabytes. This value can be null.

DoubleTotalQuotaGBytesFree

The amount of used space, in gigabytes.This value can be null.

DoubleTotalQuotaGBytesUsed

The vault store Entry Id.StringVaultStoreEntryId

The vault store group name.StringVaultStoreGroupName

The vault store name.StringVaultStoreName

91Enterprise Vault PowerShell cmdlet referenceGet-EVVaultStorePartition

Page 92: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Clear-IndexLocationBackupModeClear-IndexLocationBackupMode decrements the backup mode count on oneindexing location, on all the indexing locations associated with a server, or on allthe indexing locations in a site.

Enterprise Vault maintains a count of backup mode requests for each indexinglocation. For example, if you use concurrent backup scripts in your environment,the backup mode count can be higher than 1. Backup mode is not cleared until thebackup mode count reduces to 0.

Clear-IndexLocationBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxClear-IndexLocationBackupMode [-EVServerName] <String>

[[-IndexRootPath] <String>] [-EVSiteName <String>]

[-ForceClearBackupMode <Boolean>] [-SuppressConfirm]

[<CommonParameters>]

Clear-IndexLocationBackupMode [-EntryId <String>]

[-ForceClearBackupMode <Boolean>] [-SuppressConfirm]

[<CommonParameters>]

Parameters

Table 4-60 Clear-IndexLocationBackupMode parameters

DescriptionParameter

The Enterprise Vault server that owns the indexing locations.You must provide this parameter if you specify a site orindexing location by name rather than ID. This allowsClear-IndexLocationBackupMode to find the ID of thesite or indexing location.

-EVServerName (required)

The root path of an indexing location.-IndexRootPath

The name of the site.-EVSiteName

The ID of the indexing location, service, server, or site.-EntryId

Use -ForceClearBackupMode:$true to forcibly clearbackup mode. Clear-IndexLocationBackupMode thenignores the existing backup mode count and sets it to 0.

-ForceClearBackupMode

92Enterprise Vault PowerShell cmdlet referenceClear-IndexLocationBackupMode

Page 93: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-60 Clear-IndexLocationBackupMode parameters (continued)

DescriptionParameter

Use -SuppressConfirm to suppress the prompt forconfirmation when you use-ForceClearBackupMode:$true. This parameter is onlyavailable when you use -ForceClearBackupMode:$true.

-SuppressConfirm

Examples■ Clear-IndexLocationBackupMode EVServer-Win2k3

Decrements the backup mode count on all the indexing locations associatedwith server EVServer-Win2k3.

■ Clear-IndexLocationBackupMode EVServer-Win2k3

-ForceClearBackupMode:$true

Forcibly clears backup mode from all the indexing locations associated withserver EVServer-Win2k3. Clear-IndexLocationBackupMode ignores the existingbackup mode count and sets it to 0. In this example, Windows PowerShellprompts for confirmation before it executes the command.

■ Clear-IndexLocationBackupMode EVServer-Win2k3

-ForceClearBackupMode:$true -SuppressConfirm

Forcibly clears backup mode from all the indexing locations associated withserver EVServer-Win2k3. Clear-IndexLocationBackupMode ignores the existingbackup mode count and sets it to 0. In this example, Windows PowerShell doesnot prompt for confirmation before it executes the command.

■ Clear-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath

f:\indexing\index0

Decrements the backup mode count on indexing location f:\indexing\index0.

■ Clear-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1

Decrements the backup mode count on all indexing locations in Site1.

■ Clear-IndexLocationBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Decrements the backup mode count on the object that has the specified ID. TheID can be that of an indexing location, a server, or a site.If you specify the ID of an indexing location, backup mode is decremented onthat indexing location.If you specify the ID of a server or a site, backup mode is decremented on theindexing locations associated with the server, or in the site.

93Enterprise Vault PowerShell cmdlet referenceClear-IndexLocationBackupMode

Page 94: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

OutputThere is a confirmation message on completion.

Related cmdlets■ See “Get-IndexLocationBackupMode” on page 94.

■ See “Set-IndexLocationBackupMode” on page 96.

■ See “Clear-VaultStoreBackupMode” on page 101.

■ See “Get-VaultStoreBackupMode” on page 103.

■ See “Set-VaultStoreBackupMode” on page 105.

Get-IndexLocationBackupModeGet-IndexLocationBackupMode reports the current backup mode settings of oneindexing location, of all the indexing locations associated with a server, or of all theindexing locations in a site.

Get-IndexLocationBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-IndexLocationBackupMode [-EVServerName] <String> [[-IndexRootPath]

<String>] [-EVSiteName <String>] [<CommonParameters>]

Get-IndexLocationBackupMode [-EntryId <String>] [<CommonParameters>]

Parameters

Table 4-61 Get-IndexLocationBackupMode parameters

DescriptionParameter

The Enterprise Vault server that owns the indexing locations.You must provide this parameter if you specify a site orindexing location by name rather than ID. This allowsGet-IndexLocationBackupMode to find the ID of the siteor indexing location.

-EVServerName (required)

The root path of an indexing location.-IndexRootPath

The name of the site.-EVSiteName

The ID of the indexing location, service, server, or site.-EntryId

94Enterprise Vault PowerShell cmdlet referenceGet-IndexLocationBackupMode

Page 95: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-IndexLocationBackupMode EVServer-Win2k3

Reports the current backup mode settings of all the indexing locations associatedwith server EVServer-Win2k3.

■ Get-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath

f:\indexing\index0

Reports the current backup mode setting of indexing location f:\indexing\index0.

■ Get-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1

Reports the current backup mode settings of all indexing locations in Site1.

■ Get-IndexLocationBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Reports the current backup mode settings of the object that has the specifiedID. The ID can be that of an indexing location, a service, a server, or a site.If you specify the ID of an indexing location, the current backup mode settingof that indexing location is reported.If you specify the ID of a service, server or a site, the current backup modesettings of the indexing locations associated with the server or site are reported.

OutputTable 4-62 lists the properties that are available.

Table 4-62 Get-IndexLocationBackupMode properties

DescriptionTypeName

Indicates whether the index location is in backupmode. Possible values: $true (index locationis in backup mode), $false (index location isnot in backup mode).

BooleanBackupMode

The IndexingServiceId.StringIndexingServiceId

The IndexRootPath.StringIndexRootPath

The IndexRootPathId.StringIndexRootPathId

Related cmdlets■ See “Clear-IndexLocationBackupMode” on page 92.

■ See “Set-IndexLocationBackupMode” on page 96.

■ See “Clear-VaultStoreBackupMode” on page 101.

■ See “Get-VaultStoreBackupMode” on page 103.

95Enterprise Vault PowerShell cmdlet referenceGet-IndexLocationBackupMode

Page 96: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ See “Set-VaultStoreBackupMode” on page 105.

Set-IndexLocationBackupModeSet-IndexLocationBackupMode increments the backup mode count on one indexinglocation, on all the indexing locations associated with a server, or on all the indexinglocations in a site.

Enterprise Vault maintains a count of backup mode requests for each indexinglocation. For example, if you use concurrent backup scripts in your environment,the backup mode count can be higher than 1. Backup mode is not cleared until thebackup mode count reduces to 0.

Set-IndexLocationBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-IndexLocationBackupMode [-EVServerName] <String> [[-IndexRootPath]

<String>] [-EVSiteName <String>] [<CommonParameters>]

Set-IndexLocationBackupMode [-EntryId <String>] [<CommonParameters>]

Parameters

Table 4-63 Set-IndexLocationBackupMode parameters

DescriptionParameter

The Enterprise Vault server that owns the indexing locations.You must provide this parameter if you specify a site orindexing location by name rather than ID. This allowsSet-IndexLocationBackupMode to find the ID of the siteor indexing location.

-EVServerName (required)

The root path of an indexing location.-IndexRootPath

The name of the site.-EVSiteName

The ID of the indexing location, service, server, or site.-EntryId

Examples■ Set-IndexLocationBackupMode EVServer-Win2k3

Increments the backup mode count on all the indexing locations associated withserver EVServer-Win2k3.

96Enterprise Vault PowerShell cmdlet referenceSet-IndexLocationBackupMode

Page 97: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ Set-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath

f:\indexing\index0

Increments the backup mode count on indexing location f:\indexing\index0.

■ Set-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1

Increments the backup mode count on all indexing locations in Site1.

■ Set-IndexLocationBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Increments the backup mode count on the object that has the specified ID. TheID can be that of an indexing location, a server, or a site.If you specify the ID of an indexing location, the backup mode count isincremented on that indexing location.If you specify the ID of a server or a site, the backup mode count is incrementedon the indexing locations associated with the server, or in the site.

OutputThere is a confirmation message on completion.

Related cmdlets■ See “Clear-IndexLocationBackupMode” on page 92.

■ See “Get-IndexLocationBackupMode” on page 94.

■ See “Clear-VaultStoreBackupMode” on page 101.

■ See “Get-VaultStoreBackupMode” on page 103.

■ See “Set-VaultStoreBackupMode” on page 105.

Set-IndexMetadataSyncLevelSet-IndexMetadataSyncLevel sets the index metadata synchronization flag toensure that a synchronization between index volume entries in Directory databaseand those stored in Indexing engine's metadata takes place at next index servicestartup.

Set-IndexMetadataSyncLevel is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-IndexMetadataSyncLevel -EntryId <String> -SyncLevel <String>

[<CommonParameters>]

97Enterprise Vault PowerShell cmdlet referenceSet-IndexMetadataSyncLevel

Page 98: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Parameters

Table 4-64 Set-IndexMetadataSyncLevel parameters

DescriptionParameter

The ID of the indexing service or EV Server hosting that indexingservice.

-EntryId (required)

The type of synchronization level to be done at startup of IndexingService. Synchronization will be done for all index volumes linkedto input indexing service entry Id.

If this is set to 0 (EV_INDEX_METADATA_SYNC_NONE), nosynchronization of index volume entries will take place.

If this is set to 1 (EV_INDEX_METADATA_SYNC_BASIC), missingindex volume entries that are in the Directory database and not inthe indexing engine's metadata will be added to the index enginemetadata. Those that are present in the indexing engine but not inthe Directory database will be removed from the indexing enginemetadata.

If this is set to 2(EV_INDEX_METADATA_SYNC_CHECK_LOCATION_PATH),additionally the index location of every index volume in the Directorydatabase will be compared with that stored in the indexing engine'smetadata and updated if required.

-SyncLevel(required)

Examples■ Set-IndexMetadataSyncLevel -EntryId

15B63FA16EF2BD4418934B87F2F6651A51710000.Domain1.local -SyncLevel

1

Sets the index metadata synchronisation level to 1 for indexing service havingentry Id 15B63FA16EF2BD4418934B87F2F6651A51710000.Domain1.local.This ensures that a synchronisation between index volume entries in Directorydatabase and those stored in Indexing engine's metadata takes place at nextindex service startup.As a result of synchronisation missing index volume entries that are in Directorydatabase and not in indexing engine's metadata will be added to index enginemetadata and those present in indexing engine but not in Directory databasewill be removed from indexing engine metadata.

OutputThere is a confirmation message on completion.

98Enterprise Vault PowerShell cmdlet referenceSet-IndexMetadataSyncLevel

Page 99: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Related cmdlets■ See “Get-IndexServerForIndexLocation” on page 99.

Get-IndexServerForIndexLocationGet-IndexServerForIndexLocation gets the index server name and server entryID for a given index location.

Get-IndexServerForIndexLocation is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-IndexServerForIndexLocation -Location <String>

[<CommonParameters>]

Parameters

Table 4-65 Get-IndexServerForIndexLocation parameters

DescriptionParameter

The root path entry id or root path of the index location.-Location (required)

Examples■ Get-IndexServerForIndexLocation -Location

10AA6CBA47F403244A85E3CF172B00DEC1810000Server.Domain.local

Gets the index server name and server entry id for a given index location as aroot path entry id.

■ Get-IndexServerForIndexLocation -Location "F:\Test Index

Location\index7"

Gets the index server name and server entry id for a given index location as aroot path.

OutputTable 4-66 lists the properties that are available.

Table 4-66 Get-IndexServerForIndexLocation properties

DescriptionTypeName

The ServerEntryId.StringServerEntryId

99Enterprise Vault PowerShell cmdlet referenceGet-IndexServerForIndexLocation

Page 100: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-66 Get-IndexServerForIndexLocation properties (continued)

DescriptionTypeName

The ServerName.StringServerName

Related cmdlets■ See “Set-IndexMetadataSyncLevel” on page 97.

Start-PartitionRolloverStart-PartitionRollover forcibly closes the open partition in the specified vaultstore, and opens the first ready partition if one exists. You must also specify theserver that runs the storage service for the vault store in which you want to forcepartition rollover.

Start-PartitionRollover is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxStart-PartitionRollover [-EVServerName] <String> [-VaultStore]

<String> [<CommonParameters>]

Parameters

Table 4-67 Start-PartitionRollover parameters

DescriptionParameter

The Enterprise Vault server that runs the storage service forthe vault store in which you want to force partition rollover.

-EVServerName (required)

The name or ID of the vault store in which you want to forcepartition rollover.

-VaultStore (required)

Examples■ Start-PartitionRollover EVServer-Win2k3 VS1

Connects to the Enterprise Vault server EVServer-Win2k3 and verifies that vaultstore VS1 uses the storage service on this server. If it does,Start-PartitionRollover forces partition rollover in vault store VS1.

OutputThere is a confirmation message on completion.

100Enterprise Vault PowerShell cmdlet referenceStart-PartitionRollover

Page 101: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Clear-VaultStoreBackupModeClear-VaultStoreBackupMode decrements the backup mode count on one vaultstore, on all the vault stores in a vault store group, or on all the vault stores in asite.

Enterprise Vault maintains a count of backup mode requests for each vault store.For example, if you use concurrent backup scripts in your environment, the backupmode count can be higher than 1. Backup mode is not cleared until the backupmode count reduces to 0.

Clear-VaultStoreBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxClear-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String>

[-EvObjectType] <EVObjectType> [-ForceClearBackupMode <Boolean>]

[-SuppressConfirm] [<CommonParameters>]

Clear-VaultStoreBackupMode -EntryId <String> [-ForceClearBackupMode

<Boolean>] [-SuppressConfirm] [<CommonParameters>]

Parameters

Table 4-68 Clear-VaultStoreBackupMode parameters

DescriptionParameter

The name of the vault store, vault store group, or site.-Name (required)

The Enterprise Vault server that owns the vault store, vaultstore group, or site. You must provide this parameter if youspecify a vault store, vault store group, or site by name ratherthan ID. This allows Clear-VaultStoreBackupMode tofind the ID of the vault store, vault store group, or site.

-EVServerName (required)

The type of object passed by the Name parameter. Acceptablevalues are VaultStore, VaultStoreGroup and Site.You must provide this parameter if you specify a vault store,vault store group, or site by name rather than ID.

-EvObjectType (required)

The ID of the vault store, vault store group, or site.-EntryId (required)

Use -ForceClearBackupMode:$true to forcibly clearbackup mode. Clear-VaultStoreBackupMode thenignores the existing backup mode count and sets it to 0.

-ForceClearBackupMode

101Enterprise Vault PowerShell cmdlet referenceClear-VaultStoreBackupMode

Page 102: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Table 4-68 Clear-VaultStoreBackupMode parameters (continued)

DescriptionParameter

Use -SuppressConfirm to suppress the prompt forconfirmation when you use-ForceClearBackupMode:$true. This parameter is onlyavailable when you use -ForceClearBackupMode:$true.

-SuppressConfirm

Examples■ Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

Decrements the backup mode count on vault store VS1.

■ Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

-ForceClearBackupMode:$true

Forcibly clears backup mode from vault store VS1. Clear-VaultStoreBackupModeignores the existing backup mode count and sets it to 0. In this example,Windows PowerShell prompts for confirmation before it executes the command.

■ Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

-ForceClearBackupMode:$true -SuppressConfirm

Forcibly clears backup mode from vault store VS1. Clear-VaultStoreBackupModeignores the existing backup mode count and sets it to 0. In this example,Windows PowerShell does not prompt for confirmation before it executes thecommand.

■ Clear-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup

Decrements the backup mode count on all the vault stores in vault store groupVSG1.

■ Clear-VaultStoreBackupMode Site1 EVServer-Win2k3 Site

Decrements the backup mode count on all the vault stores in Site1.

■ Clear-VaultStoreBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Decrements the backup mode count on the object that has the specified ID. TheID can be that of a vault store, a vault store group, or a site.If you specify the ID of a vault store, the backup mode count is decremented onthat vault store.If you specify the ID of a vault store group or a site, the backup mode count isdecremented on the vault stores that belong to the group or site.

OutputThere is a confirmation message on completion.

102Enterprise Vault PowerShell cmdlet referenceClear-VaultStoreBackupMode

Page 103: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Related cmdlets■ See “Clear-IndexLocationBackupMode” on page 92.

■ See “Get-IndexLocationBackupMode” on page 94.

■ See “Set-IndexLocationBackupMode” on page 96.

■ See “Get-VaultStoreBackupMode” on page 103.

■ See “Set-VaultStoreBackupMode” on page 105.

Get-VaultStoreBackupModeGet-VaultStoreBackupMode reports the current backup mode settings of one vaultstore, of all the vault stores in a vault store group, or of all the vault stores in a site.

Get-VaultStoreBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxGet-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String>

[-EvObjectType] <EVObjectType> [<CommonParameters>]

Get-VaultStoreBackupMode -EntryId <String> [<CommonParameters>]

Parameters

Table 4-69 Get-VaultStoreBackupMode parameters

DescriptionParameter

The name of the vault store, vault store group, or site.-Name (required)

The Enterprise Vault server that owns the vault store, vaultstore group, or site.

You must provide this parameter if you specify a vault store,vault store group, or site by name rather than ID. This allowsGet-VaultStoreBackupMode to find the ID of the vaultstore, vault store group, or site.

-EVServerName (required)

The type of object passed by the Name parameter. Acceptablevalues are VaultStore, VaultStoreGroup and Site.

You must provide this parameter if you specify a vault store,vault store group, or site by name rather than ID.

-EvObjectType (required)

The ID of the vault store, vault store group, or site.-EntryId (required)

103Enterprise Vault PowerShell cmdlet referenceGet-VaultStoreBackupMode

Page 104: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Get-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

Reports the current backup mode setting of vault store VS1.

■ Get-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup

Reports the current backup mode settings of all the vault stores in vault storegroup VSG1.

■ Get-VaultStoreBackupMode Site1 EVServer-Win2k3 Site

Reports the current backup mode settings of all the vault stores in Site1.

■ Get-VaultStoreBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Reports the current backup mode settings of the object that has the specifiedID. The ID can be that of a vault store, a vault store group, or a site.If you specify the ID of a vault store, the current backup mode setting of thatvault store is reported.If you specify the ID of a vault store group or a site, the current backup modesettings of the vault stores that belong to the group or site are reported.

■ Get-VaultStoreBackupMode -EVServerName EVServer-Win2k3

-EVObjectType VaultStore -Name VS1

Reports the current backup mode setting on vault store VS1.In this example, the parameters must be named because they are not in thedefault order.

OutputTable 4-70 lists the properties that are available.

Table 4-70 Get-VaultStoreBackupMode properties

DescriptionTypeName

Indicates whether the vault store is in backupmode. Possible values: $true (the vault storeis in backup mode), $false (the vault store isnot in backup mode).

BooleanBackupMode

The VaultStoreEntryId.StringThe VaultStoreEntryId.

The name of the vault store.StringVaultStoreName

Related cmdlets■ See “Clear-IndexLocationBackupMode” on page 92.

■ See “Get-IndexLocationBackupMode” on page 94.

104Enterprise Vault PowerShell cmdlet referenceGet-VaultStoreBackupMode

Page 105: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

■ See “Set-IndexLocationBackupMode” on page 96.

■ See “Clear-VaultStoreBackupMode” on page 101.

■ See “Set-VaultStoreBackupMode” on page 105.

Set-VaultStoreBackupModeSet-VaultStoreBackupMode increments the backup mode count on one vault store,on all the vault stores in a vault store group, or on all the vault stores in a site.

Enterprise Vault maintains a count of backup mode requests for each vault store.For example, if you use concurrent backup scripts in your environment, the backupmode count can be higher than 1. Backup mode is not cleared until the backupmode count reduces to 0.

Set-VaultStoreBackupMode is provided bySymantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by theEnterprise Vault Management Shell.

SyntaxSet-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String>

[-EvObjectType] <EVObjectType> [<CommonParameters>]

Set-VaultStoreBackupMode -EntryId <String> [<CommonParameters>]

Parameters

Table 4-71 Set-VaultStoreBackupMode parameters

DescriptionParameter

The name of the vault store, vault store group, or site.-Name (required)

The Enterprise Vault server that owns the vault store, vaultstore group, or site.

You must provide this parameter if you specify a vault store,vault store group, or site by name rather than ID. This allowsSet-VaultStoreBackupMode to find the ID of the vaultstore, vault store group, or site.

-EVServerName (required)

The type of object passed by the Name parameter. Acceptablevalues are VaultStore, VaultStoreGroup and Site.

You must provide this parameter if you specify a vault store,vault store group, or site by name rather than ID.

-EvObjectType (required)

The ID of the vault store, vault store group, or site.-EntryId (required)

105Enterprise Vault PowerShell cmdlet referenceSet-VaultStoreBackupMode

Page 106: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Examples■ Set-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

Increments the backup mode count on vault store VS1.

■ Set-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup

Increments the backup mode count on all the vault stores in vault store groupVSG1.

■ Set-VaultStoreBackupMode Site1 EVServer-Win2k3 Site

Increments the backup mode count on all the vault stores in Site1.

■ Set-VaultStoreBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

Increments the backup mode count on the object that has the specified ID. TheID can be that of a vault store, a vault store group, or a site.If you specify the ID of a vault store, the backup mode count is incremented onthat vault store.If you specify the ID of a vault store group or a site, the backup mode count isincremented on the vault stores that belong to the group or site.

■ Set-VaultStoreBackupMode -EVServerName EVServer-Win2k3

-EVObjectType VaultStore -Name VS1

Increments the backup mode count on vault store VS1.In this example, the parameters must be named because they are not in thedefault order.

OutputThere is a confirmation message on completion.

Related cmdlets■ See “Clear-IndexLocationBackupMode” on page 92.

■ See “Get-IndexLocationBackupMode” on page 94.

■ See “Set-IndexLocationBackupMode” on page 96.

■ See “Clear-VaultStoreBackupMode” on page 101.

■ See “Get-VaultStoreBackupMode” on page 103.

106Enterprise Vault PowerShell cmdlet referenceSet-VaultStoreBackupMode

Page 107: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

AAdd-EVPstComputer 43

examples 44parameters 44syntax 44

Add-EVPstFile 45examples 46parameters 45syntax 45

CClear-IndexLocationBackupMode 92

examples 93output 94parameters 92syntax 92

Clear-VaultStoreBackupMode 101examples 102output 102parameters 101syntax 101

cmdlet 20, 42Get-EVSMTPHoldingFolder 50Get-EVSMTPPolicy 51Get-EVSMTPServerSettings 59Get-EVSMTPTarget 74New-EVSMTPPolicy 54New-EVSMTPServerSettings 62New-EVSMTPTarget 78Remove-EVSMTPPolicy 56Remove-EVSMTPTarget 80Set-EVSMTPPolicy 57Set-EVSMTPServerSettings 68Set-EVSMTPTarget 82Set-VaultStoreBackupMode 105Sync-EVSMTPServerSettings 73

GGet-EVArchive 18

examples 19

Get-EVArchive (continued)output 20parameters 18syntax 18

Get-EVComputers 22examples 23output 23parameters 22

Get-EVDatabase 24examples 24output 24parameters 24syntax 24

Get-EVDatabaseFileInfo 25examples 25output 26parameters 25syntax 25

Get-EVDependencyService 27examples 27output 27parameters 27syntax 27

Get-EVDependencyServiceState 28examples 28output 28parameters 28syntax 28

Get-EVFileLocation 30examples 31output 31parameters 31syntax 30

Get-EVIISWebsite 31examples 32output 32parameters 32syntax 32

Get-EVIMAPUsers 34examples 35output 35parameters 35

Index

Page 108: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

Get-EVIMAPUsers (continued)syntax 34

Get-EVIMAPUserSettings 36examples 36output 36parameters 36syntax 36

Get-EVIndexLocation 38examples 38output 38parameters 38syntax 38

Get-EVMDSStatusexamples 42output 43parameters 42syntax 42

Get-EVServer 46examples 47output 47parameters 46syntax 46

Get-EVService 47examples 47output 47parameters 47syntax 47

Get-EVServiceState 48examples 49output 49parameters 48syntax 48

Get-EVSite 49examples 49output 49parameters 49syntax 49

Get-EVSMTPHoldingFolder 50examples 50syntax 50

Get-EVSMTPPolicy 50examples 51output 52syntax 51

Get-EVSMTPServerSettings 59examples 59output 60syntax 59

Get-EVSMTPTarget 74examples 74output 76syntax 74

Get-EVStorageDatabase 84examples 85output 85parameters 85syntax 84

Get-EVTask 86examples 86output 86parameters 86syntax 86

Get-EVTaskState 87examples 88output 88parameters 87syntax 87

Get-EVVaultStore 88examples 88output 89parameters 88syntax 88

Get-EVVaultStorePartition 89examples 90output 90parameters 90syntax 90

Get-IndexLocationBackupMode 94examples 95output 95parameters 94syntax 94

Get-IndexServerForIndexLocation 99examples 99output 99parameters 99syntax 99

Get-VaultStoreBackupMode 103examples 104output 104parameters 103syntax 103

NNew-EVMDSBuildTask 39

examples 40output 41

108Index

Page 109: Symantec Enterprise Vault - Veritas 11... · Symantec Enterprise Vault™ PowerShell Cmdlets 11.0. SymantecEnterpriseVault:PowerShellCmdlets ...

New-EVMDSBuildTask (continued)parameters 40syntax 39

New-EVSMTPPolicy 53examples 54output 55syntax 53

New-EVSMTPServerSettings 61examples 64output 66syntax 62

New-EVSMTPTarget 77examples 79output 79syntax 78

RRemove-EVExchangeFolderPolicy 29

examples 30parameters 29syntax 29

Remove-EVSMTPPolicy 55examples 56output 56syntax 55

Remove-EVSMTPTarget 80examples 81output 81syntax 80

SSet-EVArchive

examples 21output 22parameters 21syntax 21

Set-EVIMAPServerDisabled 32examples 33parameters 33syntax 32

Set-EVIMAPServerEnabled 33examples 34output 34parameters 34syntax 33

Set-EVSMTPPolicy 56examples 57output 58

Set-EVSMTPPolicy (continued)syntax 57

Set-EVSMTPServerSettings 67examples 70output 71syntax 67

Set-EVSMTPTarget 81examples 83output 83syntax 82

Set-IndexLocationBackupMode 96examples 96output 97parameters 96syntax 96

Set-IndexMetadataSyncLevel 97examples 98output 98parameters 98syntax 97

Set-VaultStoreBackupMode 105examples 106output 106syntax 105

Start-EVComputerssyntax 22

Start-PartitionRollover 100examples 100output 100parameters 100syntax 100

Sync-EVSMTPServerSettings 72examples 73output 73syntax 73

109Index