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

Set-EVArchive

Set-EVArchive は、ユーザーがアーカイブのアイテムを手動で削除できるかどうか、Enterprise Vault が保持期間が切れたアーカイブ済みアイテムを自動的に削除できるかどうかなど、処理対象アーカイブのさまざまなプロパティを設定できます。管理コンソールで表示するアーカイブの説明と管理用のメモを指定することもできます。アーカイブに適用する保持計画を指定することもできます。-RetentionPlanName の値を空の文字列で指定すると、Set-EVArchive はアーカイブから既存の保持計画を削除します。

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

構文

Set-EVArchive [[-ArchiveID] <String>] [-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]] [-Description [<String>]] [-AdminNote [<String>]] [-RetentionPlanName [<String>]] [-Force [<Boolean>]] [<CommonParameters>]

パラメータ

表: Set-EVArchive パラメータ

パラメータ

説明

-ArchiveID (必須)

プロパティを設定するアーカイブの ID を指定します。必要な ID は Get-EVArchive cmdlet を使って取得できます。

-DeleteProtected

ユーザーがアーカイブのアイテムを手動で削除できるようにするかどうかを指定します。ユーザーによるアイテムの削除を許可するには $false に設定します。削除を許可しない場合は $true に設定します。

-DeleteExpiredItem

保持期間の期限切れ後に、Enterprise Vault にアーカイブ済みアイテムの自動削除を許可するかどうかを指定します。Enterprise Vault による期限切れアイテムの削除を許可しない場合は $false に設定します。削除を許可する場合は $true に設定します。

-Description

管理コンソールのアーカイブプロパティで表示される短い説明を提供します。

-AdminNote

管理コンソールのアーカイブプロパティで表示される管理用のメモを提供します。

-RetentionPlanName

アーカイブに適用する保持計画の名前を指定します。

アーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドは影響を受けるすべてのアーカイブの保持計画を更新します。-RetentionPlanName の値を空の文字列で指定すると、Set-EVArchive はアーカイブから既存の保持計画を削除します。

Exchange やインターネットメールアーカイブで、Set-EVArchive は、保持計画で定義した保持フォルダを作成または更新します。Cmdlet はまずアーカイブの使用する言語を判断し、この言語で保持フォルダ名を指定した場合は、それに応じてフォルダに名前を付けます。使用する言語が Enterprise Vault でサポートされていない場合、または Enterprise Vault で言語がサポートされているがそこにフォルダ名を指定していない場合、Enterprise Vault のデフォルト言語のフォルダ名が使用されます。

アーカイブタスクが次にメールボックスの同期を実行するときに、指定した保持計画を適切なプロビジョニンググループの保持設定で上書きする場合があることに注意してください。

-Force

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

  • Set-EVArchive 14B...EVSERVER.LOCAL -DeleteProtected:$true -DeleteExpiredItems:$false

    ユーザーと Enterprise Vault による処理対象アーカイブのアイテムの削除を停止して、そのアーカイブをリーガルホールドの状態に設定します。

  • Set-EVArchive 14B...EVSERVER.LOCAL -DeleteProtected:$false -AdminNote "Item deletion allowed $(get-date) by $(gc env:username)"

    ユーザーが処理対象アーカイブのアイテムを手動で削除できるようにし、管理用のメモの修正を行います。

  • Get-EVArchive localhost Domain\User -OnHold:$false | Set-EVArchive -DeleteProtected:$true -DeleteExpiredItems:$false -Description "Archive placed on legal hold $(get-date) by $(gc env:username) from $(gc env:computername)"

    Get-EVArchive によって、リーガルホールド状態ではなく、ユーザー Domain\User が削除権限を持っている、ローカル Enterprise Vault サーバー上のアーカイブの一覧が生成されます。Get-EVArchive は一覧を Set-EVArchive に渡します。そこでアーカイブはホールド状態になり、それに応じたアーカイブの説明が付けられます。

  • Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName RPForManagers

    WARNING: This archive is associated with one or more targets that are associated with other archives. Changing the retention settings of this archive will change the retention settings of the listed archives.

    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

    処理対象アーカイブに保持計画「RPForManagers」を適用します。アーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドはまずアーカイブの一覧を表示し、続行の確認メッセージを表示します。「はい」を選択すると、コマンドは「RPForManagers」と呼ばれる保持計画を一覧表示したアーカイブに適用します。「N」または「S」を選択すると、コマンドは変更を適用せずに終了します。

  • Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName RPForManagers -Force

    「RPForManagers」と呼ばれる保持計画を処理対象アーカイブに適用します。このアーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドは確認メッセージを表示することなく、影響を受けるすべてのアーカイブの保持計画の更新に続行します。

  • Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName ""

    処理対象アーカイブに以前適用された保持計画を削除します。保持計画を削除すると、アーカイブターゲットの有効な保持カテゴリが使用されます。

出力

表: Set-EVArchive プロパティは、利用可能なプロパティを一覧表示します。

表: Set-EVArchive プロパティ

名前

形式

説明

ArchiveId

文字列

変更するアーカイブの ArchiveId。

ArchiveName

文字列

変更するアーカイブの名前。

Updated

ブール値

アーカイブが cmdlet によって更新されたかどうかを示します。有効値は、$true (アーカイブは更新されました)、$false (アーカイブは更新されませんでした) です。

関連 cmdlet