Enterprise Vault™ PowerShell cmdlet

Last Published:
Product(s): Enterprise Vault (12.3)
  1. Enterprise Vault PowerShell cmdlet の概要
    1.  
      Enterprise Vault 管理シェルについて
    2.  
      Enterprise Vault PowerShell cmdlet のヘルプの使用方法
    3.  
      PowerShell 文字列のルール
    4. 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-EVFSAFileServer
    2.  
      Get-EVFSAFolder
    3.  
      Get-EVFSAVolume
    4.  
      New-EVFSAFileServer
    5.  
      New-EVFSAFolder
    6.  
      New-EVFSAVolume
    7.  
      Remove-EVFSAFileServer
    8.  
      Remove-EVFSAFolder
    9.  
      Remove-EVFSAVolume
    10.  
      Set-EVFSAFileServer
    11.  
      Set-EVFSAFolder
    12.  
      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.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  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.  
      New-EVClassificationPolicy
    10.  
      Publish-EVClassificationFCIRules
    11.  
      Remove-EVClassificationPolicy
    12.  
      Set-EVClassificationPolicy
    13.  
      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
  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-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Remove-EVArchive
    6.  
      Set-EVArchive
    7.  
      Start-PartitionRollover

New-EVSMTPTarget

New-EVSMTPTarget は指定された SMTP アドレスなどのプロパティを伴う新しい SMTP ターゲットを追加します。-SiteId パラメータを使ってサイト ID を指定しない場合で、New-EVSMTPTarget がサイトを判別できない場合は、サイト ID を入力するように求められます。

New-EVSMTPTarget は、ディレクトリと、サイト内の各 Enterprise Vault SMTP サーバーに SMTP ターゲット情報を追加します。

新しい SMTP ターゲットを追加するには、次の項目を指定する必要があります。

  • ターゲット SMTP の電子メールアドレス(-Name を使用)

  • 既存の SMTP ポリシー(-PolicyName または -PolicyId を使用)

  • 既存の保持カテゴリ (-RetentionCategory または -RetentionCategoryId を使用) または保持計画 (-RetentionPlan を使用)。保持カテゴリと保持計画の両方を指定することはできません。

  • ターゲットに関連付けるアーカイブのリスト。-ArchiveName または -ArchiveId を使用して、1 つのアーカイブを関連付けます。-ArchiveNames または -ArchiveIds を使用して、複数のアーカイブを追加します。アーカイブ ID とアーカイブ名の両方を指定することはできません。

  • SMTP ジャーナル設定の種類 (-TargetType を使用)

  • 使用するアーカイブの種類 (-ArchiveType を使用)

名前または ID、またはこれら両方によってポリシーと保持カテゴリを指定することができます。名前と ID の両方を使う場合、これら 2 つは同じポリシーまたは保持カテゴリに関連している必要があります。

ターゲットのアーカイブを有効にするには -ArchivingEnabled $true を、アーカイブを無効にするには -ArchivingEnabled $false を使用します。

すでに存在するターゲットを指定したり、サイト内に存在しない SMTP 設定を指定したりすると、New-EVSMTPTarget は失敗します。

New-EVSMTPTarget がいずれかの Enterprise Vault SMTP サーバー上の SMTP 設定を更新できない場合、GetFailedEVServerList 機能で更新されなかったサーバーを一覧表示できます。例については、Get-EVSMTPTarget のヘルプを参照してください。

New-EVSMTPTarget は、サイト内で SMTP サーバーがインストールまたは構成されていない場合には警告を表示します。Enterprise Vault サーバー上で SMTP サーバーと SMTP アーカイブタスクがインストールされて構成されていないと、Enterprise Vault ではターゲットメッセージをアーカイブできません。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>] [-RetentionPlan <String>] [-ArchiveId <String>] [-ArchiveName <String>] [-TargetType] <object> [-ArchiveType] <object> [-ArchivingEnabled <Boolean>] [-RetryCount <String>] [-Force <Boolean>] [<CommonParameters>]

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

パラメータ

表: New-EVSMTPTarget パラメータ

パラメータ

説明

-SiteId (必須)

SMTP ターゲットを追加するサイトの ID。

-Name (必須)

ターゲットの SMTP アドレス。

-PolicyId

SMTP ターゲットに関連付けされる既存の SMTP ポリシーの ID。

-PolicyName

SMTP ターゲットに関連付けされる既存の SMTP ポリシーの名前。

-RetentionCategoryId

SMTP ターゲットに関連付けされる既存の保持カテゴリの ID。

-RetentionCategory

SMTP ターゲットに関連付けされる既存の保持カテゴリの名前。

-RetentionPlan

SMTP ターゲットに関連付けされる既存の保持計画の名前。この計画で定義した保持カテゴリはターゲットのメッセージおよび Enterprise Vault がそれらを格納するアーカイブに割り当てられます。ターゲットのアーカイブが他のアーカイブに関連付けられている可能性のある 1 つ以上のターゲットに関連付けられている場合、このコマンドは影響を受けるすべてのアーカイブの保持計画を更新します。

このアーカイブにすでに保持期間がある場合、New-EVSMTPTarget はその計画を保持し、新しい計画を適用しません。

次の点に注意してください。

  • 保持カテゴリと保持計画の両方を指定することはできません。

  • Exchange メールボックスとインターネットメールアーカイブに保持計画を割り当てることはできません。保持設定を変更する場合は、アーカイブのプロパティを編集する必要があります。

-ArchiveId

-ArchiveName

(必須)

ArchiveId または ArchiveName のいずれかを使用して、Enterprise Vault がターゲットのメッセージをアーカイブするアーカイブを指定します。

次の点に注意してください。

  • アーカイブ ID とアーカイブ名の両方を指定することはできません。

  • 複数のアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けるには、ArchiveIds または ArchiveNames を使用します。

-ArchiveIds

-ArchiveNames

(必須)

ArchiveIds または ArchiveNames のいずれかを使用して、複数のアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けます。SMTPTargetArchiveIDs オブジェクトについて詳しくは、get-help about_SMTPTargetArchiveIDs と入力します。

次の点に注意してください。

  • アーカイブ ID とアーカイブ名の両方を指定することはできません。

  • ターゲットに関連付けられているすべてのアーカイブで、保持設定が同じになっている必要があります。

  • 1 つのアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けるには、ArchiveId または ArchiveName を使用します。

  • SMTP メールボックスジャーナルのターゲットを作成するときに、これらのパラメータは使用できません。

-TargetType (必須)

SMTP ジャーナル設定の種類。有効なターゲットの種類は次のとおりです。

  • SMTPJournaling

  • SMTPMailboxJournaling

  • SMTPGroupJournaling

ここで指定できる値は、SMTP サイトの設定、[選択したジャーナルのアーカイブ]を構成した方法によって決まります。ターゲットを、SMTP メールボックスジャーナルまたは SMTP グループジャーナルのターゲットとして追加するには、[選択したジャーナルのアーカイブ]が[包含]または[除外]になっていることを確認します。[選択したジャーナルのアーカイブ]が[非選択]に設定されている場合、このターゲットは SMTP ジャーナルとしてのみ追加できます。

-ArchiveType (必須)

Enterprise Vault がターゲットからメッセージをアーカイブ化するアーカイブの種類。ここで指定できる値は、-TargetType で指定する値によって決まります。-TargetType が SMTPJournaling または SMTPGroupJournaling の場合は、1 つまたは複数のアーカイブの種類を指定することができます。有効なアーカイブの種類は次のとおりです。

  • DominoJournal

  • ExchangeJournal

  • Shared

  • SMTP

-TargetType が SMTPMailboxJournaling の場合は、次のアーカイブの種類のいずれかを指定することができます。

  • ExchangeMailbox

  • InternetMail

-ArchivingEnabled

ターゲットのメッセージ (受信と送信) をアーカイブするには、$true に設定します。ターゲットのアーカイブを無効にするには、$false に設定します。

-RetryCount

New-EVSMTPTarget がサイト内の Enterprise Vault SMTP サーバーに対してターゲット情報の更新を試行する最大回数。

-Force

確認メッセージを表示することなく、-RetentionPlan で指定される保持計画を適用します。

  • 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("Archive1")

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

    C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name sales@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" ArchiveNames $archNames -TargetType SMTPGroupJournaling -ArchiveType Shared

    保持計画「Projects Retention Plan」を新しい SMTP ターゲットに関連付けます。また、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> $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' -RetentionPlan "Projects Retention Plan" -ArchiveNames $archNames -ArchiveType "SMTP, ExchangeJournal" -TargetType SMTPJournaling

    保持計画「Projects Retention Plan」を新しい SMTP ジャーナルターゲットに関連付けます。種類が 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 ターゲットに関連付けます。

  • C:\PS> New-EVSMTPTarget -Name JohnDoe@example.com -TargetType SMTPJournaling -ArchiveNames $arc -RetentionPlan "Projects Retention Plan" -PolicyName "Smtp Policy" -ArchiveType Smtp

    警告: ターゲットのアーカイブは、他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられています。このアーカイブの保持設定を変更すると、一覧表示されているアーカイブの保持設定が変更されます。

    Express Vault Store\A1

    Express Vault Store\A2

    Express Vault Store\A3

    Confirm Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

    ポリシー、保持計画、アーカイブを新しい SMTP ターゲット「JohnDoe@example.com」に適用します。ターゲットのアーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドはまずアーカイブの一覧を表示し、続行の確認メッセージを表示します。「はい (Y)」を選択すると、コマンドは「Projects Retention Plan」と呼ばれる保持計画を一覧表示したアーカイブに適用します。「N」または「S」を選択すると、コマンドは変更を適用せずに終了します。

  • New-EVSMTPTarget -Name JohnDoe@example.com -TargetType SMTPJournaling -ArchiveNames $arc -RetentionPlan RtnForManagers -PolicyName "Smtp Policy" -ArchiveType Smtp -Force

    保持計画「RtnForManagers」を新しい SMTP ターゲット「JohnDoe@example.com.」に適用します。このターゲットのアーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドは確認メッセージを表示することなく、これらのアーカイブの保持設定を更新します。

出力

New-EVSMTPTargetSymantec.EnterpriseVault.Admin.SMTPTargetSymantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation の種類のオブジェクトを返します。ここには、次の表に一覧表示されているプロパティが含まれています。

表: Symantec.EnterpriseVault.Admin.SMTPTarget プロパティ

名前

種類

説明

ArchivingEnabled

Boolean

現在アーカイブされている 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