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

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 にアーカイブ済みアイテムの自動削除を許可するかどうかを指定します。削除を許可しない場合は $false に設定します。Enterprise Vault による期限切れアイテムの削除を許可する場合は $true に設定します。

-Description

管理コンソールのアーカイブプロパティに表示する簡潔な説明を入力します。

-AdminNote

管理コンソールのアーカイブプロパティに表示する管理用のメモを入力します。

-RetentionPlanName

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

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

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

アーカイブタスクが次にメールボックスの同期を実行するときに、指定した保持計画を適切なプロビジョニンググループの保持設定で上書きする場合があることに注意してください。Exchange メールボックスのアーカイブでは、これは Exchange メールボックスポリシーの設定の[全体ロック]オプションのチェックマークをはずした場合のみに該当します。

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

    警告: このアーカイブは他のアーカイブに関連付けられている 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

    処理対象アーカイブに保持計画「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

Boolean

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

関連 cmdlet