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

New-EVSMTPTarget

New-EVSMTPTarget 将添加具有指定 SMTP 地址和其他属性的新 SMTP 目标。如果您未使用 -SiteId 参数指定站点 ID,且 New-EVSMTPTarget 无法确定站点,则将提示您输入站点 ID。

New-EVSMTPTarget 将 SMTP 目标信息添加到目录以及站点的各 Enterprise Vault SMTP 服务器。

要添加新 SMTP 目标,必须指定以下各项:

  • 目标 SMTP 电子邮件地址(使用 -Name)。

  • 现有 SMTP 策略(使用 -PolicyName-PolicyId)。

  • 现有保留类别(使用 -RetentionCategory-RetentionCategoryId)。

  • 要与目标关联的归档列表。使用 -ArchiveName-ArchiveId 关联单个归档。使用 -ArchiveNames-ArchiveIds 添加多个归档。无法同时指定归档 ID 和归档名称。

  • SMTP 日记记录配置的类型(使用 -TargetType

  • 要使用的归档类型(使用 -ArchiveType

可以使用其名称和/或 ID 指定策略和保留类别。如果同时使用名称和 ID,则这两者必须与相同策略或保留类别关联。

可使用 -ArchivingEnabled $True 为目标启用归档,或者使用 -ArchivingEnabled $False 禁用归档。

如果指定一个已经存在的目标或指定站点中不存在的 SMTP 设置,则 New-EVSMTPTarget 将失败。

如果 New-EVSMTPTarget 未能更新任何 Enterprise Vault SMTP 服务器上的 SMTP 设置,可以使用 GetFailedEVServerList 函数列出未更新的服务器。有关示例,请参见 Get-EVSMTPTarget 的帮助。

如果您没有在站点上安装或配置 SMTP 服务器,则 New-EVSMTPTarget 会显示警告。Enterprise Vault 无法归档目标邮件,直到您在 Enterprise Vault 服务器上安装并配置了 SMTP 服务器和 SMTP 归档任务。有关从 Enterprise Vault 介质安装 SMTP 归档组件的信息,请参见“安装和配置”。有关如何配置 SMTP 归档的信息,请参见“设置 SMTP 归档”

New-EVSMTPTarget 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll 提供。

语法

New-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-ArchiveId <String>] [-ArchiveName <String>] [-TargetType] <object> [-ArchiveType] <object> [-ArchivingEnabled <Boolean>] [-RetryCount <String>] [<CommonParameters>]

New-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-ArchiveIds <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs>] [-ArchiveNames <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames>] [-TargetType] <object> [-ArchiveType] <object> [-ArchivingEnabled <Boolean>] [-RetryCount <String>] [<CommonParameters>]

参数

表:New-EVSMTPTarget 参数

参数

说明

-SiteId(必填)

要添加 SMTP 目标的站点 ID。

-Name(必填)

目标的 SMTP 地址。

-PolicyId

要与 SMTP 目标关联的现有 SMTP 策略 ID。

-PolicyName

要与 SMTP 目标关联的现有 SMTP 策略名称。

-RetentionCategoryId

要与 SMTP 目标关联的现有保留类别 ID。

-RetentionCategory

要与 SMTP 目标关联的现有保留类别名称。

-ArchiveId

-ArchiveName

(必填)

使用 ArchiveIdArchiveName 指定 Enterprise Vault 将用于归档目标邮件的归档。

请注意以下内容:

  • 无法同时指定归档 ID 和归档名称。

  • 要将多个归档与 SMTP 日记记录或 SMTP 组日记记录目标关联,请使用 ArchiveIdsArchiveNames

-ArchiveIds

-ArchiveNames

(必填)

使用 ArchiveIdsArchiveNames 将多个归档与 SMTP 日记记录或 SMTP 组日记记录目标关联。有关 SMTPTargetArchiveIDs 对象的详细信息,请键入 get-help about_SMTPTargetArchiveIDs

请注意以下内容:

  • 无法同时指定归档 ID 和归档名称。

  • 与某个目标关联的所有归档必须具有相同的保留设置。

  • 要将单个归档与 SMTP 日记记录或 SMTP 组日记记录目标关联,请使用 ArchiveIdArchiveName

  • 创建 SMTP 邮箱日记记录目标时,不能使用这些参数。

-TargetType(必需)

SMTP 日记记录配置的类型。有效目标类型包括:

  • SMTPJournaling

  • SMTPMailboxJournaling

  • SMTPGroupJournaling

可以指定的值取决于您配置 SMTP 站点设置的方式,选择性日记归档。 要将目标添加为 SMTP 邮箱日记记录或 SMTP 组日记记录目标,请确保“选择性日记归档”设置为“全含”“不全含”。如果“选择性日记归档”设置为“非选择性”,则只能将此目标添加为 SMTP 日记记录目标。

-ArchiveType(必需)

Enterprise Vault 用于归档从目标发出的邮件的归档类型。可以指定的值取决于在 -TargetType 中指定的值。如果 -TargetType 是 SMTPJournaling 或 SMTPGroupJournaling,您可以指定一个或多个归档类型。有效归档类型包括:

  • DominoJournal

  • ExchangeJournal

  • 已共享

  • SMTP

如果 -TargetType 是 SMTPMailboxJournaling,您可以指定下列归档类型之一:

  • ExchangeMailbox

  • InternetMail

-ArchivingEnabled

设置为 $True 以归档目标邮件(传入和传出)。设置为 $False 以禁用目标归档。

-RetryCount

New-EVSMTPTarget 将尝试更新站点中 Enterprise Vault SMTP 服务器上目标信息的最大次数。

示例
  • New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -ArchiveName SMTPLocal -TargetType SMTPMailboxJournaling -ArchiveType ExchangeMailbox

    添加具有指定属性的新 SMTP 邮箱日记记录目标“JohnDoe@example.com”。

  • C:\PS> $archIds = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs

    C:\PS> $archIds.Add("12DB...110000MW-EV-1-A")

    C:\PS> $archIds.Add("15E1...210000MW-EV-1-A")

    C:\PS> $archIds.Add("132C...410000MW-EV-1-A")

    C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' ArchiveIds $archIds -TargetType SMTPJournaling -ArchiveType SMTP -ArchivingEnabled $true

    添加具有指定属性的新 SMTP 目标“Jrnl@example.com”,并将指定的归档与 SMTP 目标关联。

  • C:\PS> $archNames = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames

    C:\PS> $archNames.Add("SmtpArchive")

    C:\PS> $archNames.Add("ExchJournal")

    C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveNames $archNames -ArchiveType "SMTP, ExchangeJournal" -TargetType SMTPJournaling

    添加具有指定属性的新 SMTP 日记记录目标“Jrnl@example.com”,并将指定的 SMTP 和 ExchangeJournal 归档与 SMTP 目标关联。

  • C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveId B2DE...EV1101.example.com -ArchiveType SMTP -TargetType SMTPJournaling -ArchivingEnabled $true

    添加具有指定属性的新 SMTP 日记记录目标“Jrnl@example.com”,并将指定的 SMTP 归档与 SMTP 目标关联。

  • C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP -TargetType SMTPGroupJournaling -ArchivingEnabled $true

    添加具有指定属性的新 SMTP 组日记记录目标“JohnDoe@example.com”。

  • C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName ExchMbx -ArchiveType ExchangeMailbox -TargetType SMTPMailboxJournaling

    添加具有指定属性的新 SMTP 邮箱日记记录目标“JohnDoe@example.com”,并将指定的 ExchangeMailbox 归档与 SMTP 目标关联。

输出

New-EVSMTPTarget 返回 Symantec.EnterpriseVault.Admin.SMTPTargetSymantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation 类型的对象,其中包含下表中列出的属性。

表:Symantec.EnterpriseVault.Admin.SMTPTarget 属性

名称

类型

说明

ArchivingEnabled

布尔值

如果发送到/自 SMTP 目标的邮件当前已归档,则为 $true,否则为 $false

Name

字符串

SMTP 目标地址。

PolicyId

字符串

与 SMTP 目标相关联的 SMTP 策略的 ID。

PolicyName

字符串

与 SMTP 目标相关联的 SMTP 策略。

RetentionCategory

字符串

Enterprise Vault 应用于新建归档项目的保留类别的名称。

如果 Enterprise Vault 将词语“(From Plan)”附加到保留类别名称,则已将保留计划应用于与 SMTP 目标关联的归档。Enterprise Vault 将在计划中定义的保留类别应用到项目。如果未向归档分配保留计划,则生效的保留类别是在 SMTP 目标属性中定义的保留类别。

RetentionCategoryId

字符串

由 Enterprise Vault 应用于新归档项目的保留类别的 ID。

与 RetentionCategory 一样,这取决于是否已将保留计划分配到 Enterprise Vault 在其中存储项目的归档。

SiteId

字符串

目标所属的站点的 ID。

TargetArchives

对象

Symantec.EnterpriseVault.Admin.​SmtpTargetArchiveInformation:提供与 SMTP 目标地址关联的归档的列表。有关 TargetArchives 的详细信息,请在 PowerShell 提示符中键入 get-help about_SmtpTargetArchiveInformation

TargetType

对象

与目标关联的 SMTP 日记记录配置的类型。

表:Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation 属性

名称

类型

说明

ArchiveId

字符串

与 SMTP 目标相关联的归档的 ID。

ArchiveName

字符串

与 SMTP 目标相关联的归档的名称。

ArchiveType

对象

与 SMTP 目标相关联的归档的类型。

EVServerName

字符串

承载保管库存储的 Enterprise Vault 服务器。

Name

字符串

SMTP 目标地址。

VaultStoreName

字符串

包含用于 SMTP 目标的归档的保管库存储的名称。

相关的 cmdlet