Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Enterprise Vault PowerShell cmdlet の概要
    1.  
      Enterprise Vault 管理シェルについて
    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

Get-EVSMTPTarget

Get-EVSMTPTarget は Enterprise Vault サイトで設定されているすべての SMTP ターゲットアドレスを返します。 -SiteID パラメータを使ってサイト ID を指定しない場合で、Get-EVSMTPTarget がサイトを判別できない場合、サイト ID を入力するよう求められます。 SMTP ターゲットの名前を指定している場合、Get-EVSMTPTarget はそのターゲットアドレスのプロパティを取得します。 プロパティの説明については New-EVSMTPTarget のヘルプを参照してください。

New-EVSMTPTargetSet-EVSMTPTarget、または Remove-EVSMTPTarget を実行すると、Enterprise Vault によって Enterprise Vault ディレクトリ内と、サイトの内の各 Enterprise Vault SMTP サーバー上にある SMTP ターゲット情報が更新されます。 Enterprise Vault がいずれかの SMTP サーバー上の SMTP ターゲットを更新できない場合、GetFailedEVServerList 機能でEnterprise Vault が更新できなかったサーバーを一覧表示できます。

Get-EVSMTPTarget は、スナップイン Symantec.EnterpriseVault.PowerShell.AdminAPI.dll によって提供されます。

構文

Get-EVSMTPTarget [-SiteId] <String> [[-Name] <String>] [<CommonParameters>]

パラメータ

表: Get-EVSMTPTarget パラメータ

パラメータ

説明

-SiteId (必須)

取り込む SMTP ターゲットがあるサイトの ID。

-Name

取り込む SMTP ターゲットのアドレス。

  • Get-EVSMTPTarget -SiteId 13E...example.com

    Enterprise Vault サイトで設定されているすべての SMTP ターゲットを返します。

  • 次のコマンドシーケンスを使って、SMTP ターゲット JohnDoe@example.com に関する情報を返すことができます。

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

      New-Object を使って、SMTPTarget オブジェクトを保持するための $st という新しい変数を作成します。

    • $st.Name = "JohnDoe@example.com"

      取得対象のターゲット JohnDoe@example.com が、Name パラメータによって指定されます。

    • $st.Read()

      指定された SMTP ターゲットに関する情報が、Read メソッドによって $st 変数内に取得されます。

    • $st

      $st 変数内に含まれているターゲット情報を表示します。 次に例を示します。

      Name                : JohnDoe@example.com
      PolicyName          : Default SMTP Policy
      PolicyId            : 138...example.com
      RetentionCategory   : Default Retention Category (From Plan)
      RetentionCategoryId : 100...example.com
      ArchivingEnabled    : true
      TargetArchives      : {exchangearchive}
      SiteId              : 13E...example.com
      TargetType          : SMTPMailboxJournaling
      

      この場合、コマンドレットは保持カテゴリ名に「(From Plan)」という語句を追加します。保持計画は SMTP ターゲットに関連付けされているアーカイブに適用されています。Enterprise Vault がアーカイブ済みアイテムに適用する保持カテゴリは、保持計画で定義された保持カテゴリになります。

    次のコマンドのいずれかを使ってこの情報を表示することもできます。

    • Get-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com

    • Get-EVSMTPTarget 13E...example.com JohnDoe@example.com

  • 次のコマンドシーケンスを使って、SMTP ターゲットに関する情報を返すことや、ターゲットが New-EVSMTPTargetSet-EVSMTPTarget、または Remove-EVSMTPTarget のいずれによっても更新されていなかったサーバーの一覧を見つけることができます。

    • $st = Get-EVSMTPTarget 13E...example.com JohnDoe@example.com

      SMTP ターゲットを $st 変数内に取り込みます。

    • $st

      $st に保持されているターゲット情報を表示します。 次に例を示します。

      Name                : JohnDoe@example.com
      PolicyName          : Default SMTP Policy
      PolicyId            : 138...example.com
      RetentionCategory   : Default Retention Category (From Plan)
      RetentionCategoryId : 100...example.com
      ArchivingEnabled    : true
      TargetArchives      : {exchangearchive}
      SiteId              : 13E...example.com
      TargetType          : SMTPMailboxJournaling
      
    • $st.TargetArchives

      $st のターゲットに関連付けられているアーカイブの以下の詳細を表形式で表示します。

      列のタイトル

      値の例

      Name

      JohnDoe@example.com

      ArchiveName

      exchangearchive

      ArchiveType

      ExchangeMailbox

      ArchiveId

      128D...com

      VaultStore

      Express Vault Store

      EVServerName

      ev.example.com

    • $st.GetFailedEVServerList()

      ターゲットが更新されなかった Enterprise Vault サーバーの一覧を表示します。 次に例を示します。

      EV1101, EVSMTP11
出力

Get-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