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

Remove-EVArchive

Remove-EVArchive は、指定されたアーカイブとそのアーカイブに含まれているアイテムを削除します。

Remove-EVArchive は、以下の状況ではアーカイブを削除しません。

  • アーカイブにすでに削除のマークが付いている

  • アーカイブに関連付けられているボルトストアがバックアップモードになっている

  • アーカイブが削除されないように保護されている

  • アーカイブが［利用可能］または［クローズ］以外の状態

  • アーカイブを移動中

  • 1 つ以上の 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。ID は Get-EVArchive cmdlet を使って取得できます。

-PassThru

削除するアーカイブの詳細を表示する ArchiveInfo オブジェクトを返します。デフォルトでは、この cmdlet は出力を生成しません。

-Confirm

cmdlet を実行する前に確認するように求められます。確認プロンプトを表示しないようにするには、-Confirm:$False 構文を使います。構文にコロン (:) を含める必要があります。

-WhatIf

cmdlet の実行結果のプレビューが表示されます。 cmdlet は実際には実行されません。

WhatIf スイッチは、コマンドの実行時に発生する可能性があるエラーや警告も表示します。

例

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

    「123...example.com」という ID のアーカイブを削除します。

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

    Get-EVArchive で取得した ArchiveInfo オブジェクトを Remove-EVArchive にパイプして、アーカイブを削除します。

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

    「123...example.com」という ID のアーカイブを削除します。削除したアーカイブの詳細を表示する ArchiveInfo オブジェクトも返します。

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

    Get-EVArchive で取得した ArchiveInfo オブジェクトを Remove-EVArchive にパイプします。コマンドの実行時にエラーや警告が発生する可能性を確認できます。エラーや警告が表示されない場合は、次のメッセージが表示されます。

    「この操作によってアーカイブ「ArchiveToBeDeleted」とこれに格納されるすべてのアイテムが完全に削除されます。この処理を実行すると、保持カテゴリオプション［このカテゴリの期限切れのアイテムが自動的に削除されないようにする］が上書きされます。この操作はキャンセルできません。」

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

    Get-EVArchive を使用して、削除から保護されていないすべてのアーカイブを取得し、Remove-EVArchive を使用して、それらのアーカイブを削除します。このコマンドは確認プロンプトも抑制します。

出力

Remove-EVArchive は何も出力しないか、-PassThru パラメータを指定すると修正された Veritas.EnterpriseVault.Admin.EVRbaRole タイプのオブジェクトを返します。Veritas.EnterpriseVault.Admin.EVRbaRole のプロパティを次に示します。

表: 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

ブール値

ユーザーが手動でアイテムをアーカイブから削除できる ($false) かできないか ($true) を示します。

OnHold

ブール値

アーカイブにリーガルホールドのアイテムを含める ($true) か含めない ($false) かを示します。

Status

EV_STG_API_​STATUS

Enterprise Vault アーカイブの状態の列挙。設定可能な値は次のとおりです。

  • STS_AVAILABLE

  • STS_INBACKUPMODE

  • STS_TEMPORARILY_UNAVAILABLE

  • STS_UNAVAILABLE

RetentionPlanName

文字列

アーカイブに適用した保持計画の名前。

関連 cmdlet