Enterprise Vault™ PowerShell Cmdlet

Last Published:
Product(s): Enterprise Vault (14.4)
  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
  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
  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

Remove-EVArchive

Remove-EVArchive 删除指定归档及其包含的项目。

在下列情况下,Remove-EVArchive 不会删除归档:

  • 归档已标记为删除。

  • 与归档关联的保管库存储处于备份模式。

  • 归档受到保护,无法删除。

  • 归档具有“可用”或“已关闭”以外的其他状态。

  • 正在移动归档。

  • 归档与一个或多个 Exchange 日记邮箱、Exchange 公用文件夹、SharePoint 站点集合、Domino 日记记录位置、SMTP、Skype for Business 归档目标或 SMTP 组日记记录配置组关联。

此 cmdlet 会提示您确认是否删除归档。

小心:

您无法停止删除进程或撤消删除操作。

Remove-EVArchive 支持 WhatIf 切换,可以使用该切换查看将发生的更改,而不必应用其中的任何更改。

默认情况下,Remove-EVArchive 不生成任何输出。可以使用 PassThru 切换返回 ArchiveInfo 对象,该对象提供了已删除归档的详细信息。

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

语法

Remove-EVArchive [-ArchiveId] <String> [-PassThru [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

参数

表:Remove-EVArchive 参数

参数

说明

-ArchiveID(必填)

要删除的归档的 ID。您可以使用 Get-EVArchive cmdlet 获取 ID。

-PassThru

返回 ArchiveInfo 对象,该对象提供了要删除的归档的详细信息。默认情况下,此 cmdlet 不生成任何输出。

-Confirm

运行 cmdlet 之前,系统会提示您进行确认。要取消确认提示信息,请使用语法 -Confirm:$False。必须在语法中包括冒号 (:)。

-WhatIf

显示如果 cmdlet 运行会发生的情况。cmdlet 没有实际运行。

WhatIf 切换还显示执行命令时可能出现的任何错误或警告。

示例
  • Remove-EVArchive -ArchiveId "123...example.com"

    删除 ID 为 123...example.com 的归档。

  • Get-EVArchive -ArchiveName "ArchiveToBeDeleted" | Remove-EVArchive

    将从 Get-EVArchive 获取的对象 ArchiveInfo 用管道传输至 Remove-EVArchive 并删除归档。

  • Remove-EVArchive -ArchiveId "123...example.com" -PassThru

    删除 ID 为 123...example.com 的归档。此外,还返回 ArchiveInfo 对象,该对象提供了已删除归档的详细信息。

  • Get-EVArchive -ArchiveName "ArchiveToBeDeleted" | Remove-EVArchive -WhatIf

    将从 Get-EVArchive 获取的对象 ArchiveInfo 用管道传输至 Remove-EVArchive。然后,您可以查看执行命令时可能出现的任何错误或警告。如果未显示任何错误或警告,则命令将显示以下消息:

    'This operation will permanently delete archive 'ArchiveToBeDeleted' and all items stored in it.This action overrides the Retention Category option 'Prevent automatic deletion of expired items'.You cannot cancel the operation.'

  • Get-EVArchive -DeleteProtected:$false | Remove-EVArchive -Confirm:$false

    此命令使用 Get-EVArchive 检索未受到保护以防删除的所有归档,并使用 Remove-EVArchive 将其删除。此命令还会取消确认提示符。

输出

如果指定 -PassThru 参数,Remove-EVArchive 既不返回输出,也不返回修改后的 Symantec.EnterpriseVault.Admin.ArchiveInfo 类型的对象。Symantec.EnterpriseVault.Admin.ArchiveInfo 具有以下属性。

表:Symantec.EnterpriseVault.Admin.ArchiveInfo 属性

名称

类型

说明

ArchiveId

字符串

已删除的归档的 ID。

ArchiveName

字符串

已删除的归档的名称。

ArchiveType

EV_STG_API_​ARCHIVE_TYPE

Enterprise Vault 归档类型枚举。可能值如下:

  • ARCHIVE_TYPE_DOMINO_JOURNAL

  • ARCHIVE_TYPE_DOMINO_MAILBOX

  • ARCHIVE_TYPE_FILE_SYSTEM

  • ARCHIVE_TYPE_INTERNETMAIL

  • ARCHIVE_TYPE_JOURNAL

  • ARCHIVE_TYPE_MAILBOX

  • ARCHIVE_TYPE_PUBLIC_FOLDER

  • ARCHIVE_TYPE_SHARED

  • ARCHIVE_TYPE_SHAREPOINT

  • ARCHIVE_TYPE_SMTP

DeleteExpiredItems

EV_STG_API_​EXPIRE_ITEMS

Enterprise Vault 过期项目枚举。可能值如下:

  • DONT_EXPIRE_ITEMS

  • EXPIRE_ITEMS

DeleteProtected

布尔值

指示用户是否能从归档中手动删除项目:($true) 或 ($false)。

OnHold

布尔值

指示归档是否包含法定保留的项目:($true) 或 ($false)。

Status

EV_STG_API_​STATUS

Enterprise Vault 归档状态枚举。可能值如下:

  • STS_AVAILABLE

  • STS_INBACKUPMODE

  • STS_TEMPORARILY_UNAVAILABLE

  • STS_UNAVAILABLE

RetentionPlanName

字符串

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

相关的 cmdlet