Enterprise Vault™ PowerShell Cmdlet

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Enterprise Vault PowerShell Cmdlet 简介
    1.  
      关于 Enterprise Vault Management Shell
    2.  
      获取 Enterprise Vault PowerShell cmdlet 的帮助
    3.  
      PowerShell 字符串规则
    4.  
      关于使用 Import-Csv cmdlet 时导入的布尔值
    5. 从何处获取有关 Enterprise Vault 的详细信息
      1.  
        Enterprise Vault 培训模块
  2. 归档:Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Get-EVExchangeMailboxPolicy
    4.  
      New-EVExchangeMailboxPolicy
    5.  
      Remove-EVExchangeFolderPolicy
    6.  
      Remove-EVExchangeMailboxPolicy
    7.  
      Set-EVExchangeMailboxPolicy
  3. 归档:FSA
    1.  
      Get-EVFSAComputerSettings
    2.  
      Get-EVFSAFileServer
    3.  
      Get-EVFSAFolder
    4.  
      Get-EVFSASiteSettings
    5.  
      Get-EVFSAVolume
    6.  
      New-EVFSAFileServer
    7.  
      New-EVFSAFolder
    8.  
      New-EVFSAVolume
    9.  
      Remove-EVFSAFileServer
    10.  
      Remove-EVFSAFolder
    11.  
      Remove-EVFSAVolume
    12.  
      Set-EVFSAComputerSettings
    13.  
      Set-EVFSAFileServer
    14.  
      Set-EVFSAFolder
    15.  
      Set-EVFSASiteSettings
    16.  
      Set-EVFSAVolume
  4. 归档:Skype for Business
    1.  
      Get-EVSkypeForBusinessTarget
    2.  
      New-EVSkypeForBusinessTarget
    3.  
      Remove-EVSkypeForBusinessTarget
    4.  
      Set-EVSkypeForBusinessTarget
  5. 归档:SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPMessageTrackingLogLocation
    3.  
      Get-EVSMTPPolicy
    4.  
      Get-EVSMTPServerSettings
    5.  
      Get-EVSMTPTarget
    6.  
      New-EVSMTPPolicy
    7.  
      New-EVSMTPServerSettings
    8.  
      New-EVSMTPTarget
    9.  
      Remove-EVSMTPPolicy
    10.  
      Remove-EVSMTPTarget
    11.  
      Set-EVSMTPMessageTrackingLogLocation
    12.  
      Set-EVSMTPPolicy
    13.  
      Set-EVSMTPServerSettings
    14.  
      Set-EVSMTPTarget
    15.  
      Sync-EVSMTPServerSettings
  6. 备份
    1.  
      Get-EVIndexSnapshotLocationBackupMode
    2.  
      Set-EVIndexSnapshotLocationBackupMode
    3.  
      Clear-EVIndexSnapshotLocationBackupMode
    4.  
      Get-IndexLocationBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Clear-IndexLocationBackUpMode
    7.  
      Get-VaultStoreBackupMode
    8.  
      Set-VaultStoreBackupMode
    9.  
      Clear-VaultStoreBackupMode
    10.  
      Set-EVIndexSnapshotLocation
    11.  
      Get-EVIndexSnapshotLocation
    12.  
      Remove-EVIndexSnapshotLocation
    13.  
      New-EVIndexSnapshot
    14.  
      Get-EVIndexSnapshot
    15.  
      Remove-EVIndexSnapshot
    16.  
      Restore-EVIndexSnapshot
    17.  
      Get-EVIndexSnapshotRepository
    18.  
      Remove-EVIndexSnapshotRepository
    19.  
      Export-EVIndexData
    20.  
      Import-EVIndexData
  7. 分类
    1.  
      Disable-EVClassification
    2.  
      Get-EVClassificationFCITags
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Import-EVClassificationFCIRules
    8.  
      Initialize-EVClassificationVIC
    9.  
      Set-EVClassificationVICFIPSMode
    10.  
      New-EVClassificationPolicy
    11.  
      Publish-EVClassificationFCIRules
    12.  
      Remove-EVClassificationPolicy
    13.  
      Set-EVClassificationPolicy
    14.  
      Set-EVClassificationTestMode
  8. 数据库
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  9. IMAP 访问
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  10. 索引
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
    6.  
      Submit-EVIndexingSubTask
    7.  
      Get-EVIndexVolume
    8.  
      Get-EVElasticsearchIndex
  11. 记录管理
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  12. 保留计划
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  13. 基于角色的管理
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  14. 站点和服务器
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
    6.  
      Get-EVSiteInfo
    7.  
      Set-EVServiceAccountPassword
  15. 任务和服务
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  16. 保管库存储和归档
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVArchivePermission
    4.  
      Get-EVVaultStore
    5.  
      Get-EVVaultStorePartition
    6.  
      Remove-EVArchive
    7.  
      New-EVArchive
    8.  
      Remove-EVArchivePermission
    9.  
      Set-EVArchive
    10.  
      Set-EVArchivePermission
    11.  
      Start-PartitionRollover

New-EVArchive

New-EVArchive 可创建指定类型的归档。必须指定 ArchiveNameArchiveTypeVaultStoreNameBillUsageTo 才能创建归档。

只能创建以下受支持类型的新归档:

  • Domino 日记

  • Exchange 日记

  • Exchange 公用文件夹

  • Shared

  • SMTP

或者,可以指定 DescriptionAdminNoteRetentionPlanName 和索引设置。

New-EVArchive 由管理单元 Symantec.EnterpriseVault.PowerShell.Snapin.dll 提供。

语法

New-EVArchive [-ArchiveName] <String> [-ArchiveType] { DominoJournal | ExchangeJournal | PublicFolder | Shared | SMTP} [-VaultStoreName] <String> [-BillUsageTo] <String> [-SiteId <string>] [-Description <String>] [-AdminNote <String>] [-RetentionPlanName <String>] [-IndexLevel {Brief | Full}] [-IndexPreviewLength {128 | 1000}] [-CreateAttachmentPreview <Boolean>] [<CommonParameters>]

参数

表:New-EVArchive 参数

参数

描述

-SiteId

将在其上创建归档的 Enterprise Vault 站点的 ID。如果忽略此参数,则 cmdlet 将无法通过查找注册表来确定 ID,因此 New-EVArchive cmdlet 随后会提示您输入所需的站点 ID。

您可以使用 Get-EVSite 获取站点 ID。

-ArchiveName (required)

归档的名称。名称最多可以包含 255 个字符。

-ArchiveType (required)

归档的类型。可能的值为:

  • DominoJournal

  • ExchangeJournal

  • PublicFolder

  • Shared

  • SMTP

-VaultStoreName (required)

将用于归档的保管库存储的名称。保管库存储必须至少有一个分区。您可以使用 Get-EVVaultStore cmdlet 获取所需的保管库存储名称。

-BillUsageTo (required)

指定 Windows 帐户名称,该帐户将拥有此归档以用于记帐。

Windows Active Directory 用户或组的帐户名称。用以下任何格式键入值:

  • domain\user

  • domain\group

  • hostname\localuser

  • hostname\localgroup

-Description

提供要显示在管理控制台归档属性中的简要说明。此说明最多可包含 127 个字符。

-AdminNote

提供要显示在管理控制台归档属性中的管理注释。此值最多可包含 127 个字符。

-RetentionPlanName

指定要应用于归档的保留计划的名称。

只能为以下归档类型指定保留计划:

  • DominoJournal

  • ExchangeJournal

  • SMTP

-IndexLevel

要分配给归档索引的索引级别。枚举值如下所示:

  • Brief 或 0:Enterprise Vault 为归档项目的元数据而非其内容编制索引。例如,Enterprise Vault 为发件人和项目日期编制索引。但用户无法搜索这些项目中的任何内容。

  • Full 或 2:Enterprise Vault 为归档项目及其附件的元数据和内容编制索引。用户可以搜索项目和附件的内容。

如果未指定此参数,则将使用站点设置中的值。

-IndexPreviewLength

Enterprise Vault 在搜索结果中为每个项目显示的文本数量。可能的值为 128 和 1000。

如果 IndexLevel 指定为 Brief 或 0,则无法指定此参数。如果未指定,则将使用站点设置中的值。

-CreateAttachmentPreview

指定 Enterprise Vault 是否要创建附件内容预览。

如果 IndexLevel 指定为 Brief 或 0,则无法指定此参数。如果未指定,则将使用站点设置中的值。

示例
  • New-EVArchive myArchive SMTP myVaultStore example\john

    创建名为“myArchive”的 SMTP 类型的归档,其中“myVaultStore”是要使用的保管库存储,“example\john”是要用于记帐的 Windows 帐户。

  • New-EVArchive myArchive Shared myVaultStore example\john -Description "Shared Archive" -AdminNote "Administrator Note"

    创建名为“myArchive”的 Shared 类型的归档,其中“myVaultStore”是要使用的保管库存储,“example\john”是记帐帐户。它还将归档说明设置为“Shared Archive”,并将 AdminNote 设置为“Administrator Note”。

  • New-EVArchive myArchive SMTP myVaultStore example\john -Description "SMTP Archive for managers" -RetentionPlanName RetPlanForArchiveManagers

    创建一个归档,其归档说明为“SMTP Archive for managers”,保留计划为“RetPlanForArchiveManagers”。

  • New-EVArchive myArchive SMTP myVaultStore example\john -IndexLevel Brief

    创建归档并为归档索引分配 Brief 索引级别。

  • New-EVArchive myArchive DominoJournal myVaultStore example\john -IndexLevel Full -IndexPreviewLength 1000 -CreateAttachmentPreview $true

    创建具有 Full 索引级别的归档,索引预览长度为 1000。它还支持创建附件预览。

  • Import-Csv archives.csv | New-EVArchive

    使用 CSV 文件创建一组归档。CSV 文件必须具有标题,例如 ArchiveName、ArchiveType、VaultStoreName 和 BillUsageTo。或者,CSV 文件还可以具有其他属性,例如说明、AdminNote、RetentionPlanName 等。

    注意:

    由于 Import-Csv cmdlet 的已知限制,如果将 Import-Csv cmdlet 与管道传递结合使用,则布尔值不会通过管道传递并被指定为 $false。要解决此问题,请在导入字符串值后将其转换为布尔值,然后再将其通过管道传递到管道中的下一个 cmdlet。请参见关于使用 Import-Csv cmdlet 时导入的布尔值

  • Import-Csv archives.csv | New-EVArchive | Set-EVArchivePermission -Trustee example\john -Grant Delete

    使用 CSV 文件创建一组归档,然后授予 Windows 帐户“example\john”对所有归档的删除权限。

  • Get-EVArchive -ArchiveName 'existing archive' -IncludeDetails $true | New-EVArchive -ArchiveName 'new archive' -BillUsageTo example\john

    克隆现有归档并使用 'example\john' 覆盖记帐用户。

输出

New-EVArchive 返回 Symantec.EnterpriseVault.PowerShell.Commands.NewArchive 类型的对象,其中包含以下属性:

表:New-EVArchive 属性

名称

类型

描述

ArchiveName

字符串

已创建的归档的名称。

ArchiveDescription

字符串

已创建的归档的说明。

ArchiveType

EV_STG_API_​ARCHIVE_TYPE

已创建的归档的类型。

ArchiveId

字符串

已创建的归档的 ID。

VaultStoreName

字符串

将用于归档的保管库存储的名称。

VaultStoreId

字符串

将用于归档的保管库存储的 ID。

StorageServerName

字符串

将用于归档的存储服务器的名称。

IndexerName

字符串

将用于编制索引的索引服务器的名称。

IndexServerGroup

字符串

归档所属的索引服务器组的名称

RetentionPlanName

字符串

已将其应用于归档的保留计划的名称。

BillUsageTo

字符串

Windows Active Directory 帐户将拥有此归档以用于记帐。

AdminNote

字符串

已创建的归档的管理员注释。

IndexLevel

EV_STG_API_INDEX_LEVEL

为用户归档设置的索引级别。

IndexPreviewLength

整数

Enterprise Vault 将在搜索结果中为每个项目显示的文本数量。

CreateAttachmentPreview

布尔值

指定 Enterprise Vault 是否将要创建附件内容预览。

相关的 cmdlet