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

Set-EVFSAFileServer は、ファイルシステムアーカイブのターゲットとして追加される既存のファイルサーバーの指定した設定を更新します。ファイルサーバーは、-Identifier または -FileServer を使って指定できます。

この cmdlet には、異なるファイルサーバーを更新する際に使うことができる各種のオプションパラメータがあります。

  • Windows ファイルサーバーの場合は、-EnableArchiving-ActionOnPlaceholderDelete-EnablePassthroughRecall-PassthroughRecallCacheLocation、および -PassthroughRecallCacheSizeInGB を使うことができます。

  • NetApp 7-mode ファイルサーバーの場合は、-EnableArchiving-EnablePassthroughRecall-ActionOnPlaceholderDelete-EnablePlaceholderRecalls-MaxRecallThreads-RecallLimitMaxRecalls-RecallLimitTimeInterval、および -IgnoreRecallLimitForLocalAdministrators を使うことができます。

  • C-Mode ファイルサーバーの場合は、-EnableArchiving-ActionOnPlaceholderDelete-EnablePlaceholderRecalls-MaxRecallThreads-RecallLimitMaxRecalls-RecallLimitTimeInterval、および -IgnoreRecallLimitForLocalAdministrators を使うことができます。

  • Celerra/VNX ファイルサーバーの場合、-EnableArchiving-UsePlaceholderShortcuts-DataMoverAccountDetails-PortNumber-SSLRequired を使用できます。

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

構文

Set-EVFSAFileServer [-SiteId <String>] [-Identifier] <String> [-EnableArchiving [<SwitchParameter>]] [-ActionOnPlaceholderDelete {RetainArchivedFile | DeleteArchivedFile}] [-EnablePassthroughRecall [<SwitchParameter>]] [-PassthroughRecallCacheLocation [<String>]] [-PassthroughRecallCacheSizeInGB [<Integer >]] [-EnablePlaceholderRecalls [<SwitchParameter>]] [-MaxRecallThreads [<Integer>]] [-RecallLimitMaxRecalls [<Integer>]] [-RecallLimitTimeInterval [<Integer>]] [-IgnoreRecallLimitForLocalAdministrators [<SwitchParameter>]] [-UsePlaceholderShortcuts [<SwitchParameter>]] [-DataMoverAccountDetails [<PSCredential>]] [-PortNumber [<Integer>]] [-SSLRequired [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFileServer [-SiteId <String>] [-FileServer] <-FileServer> [-EnableArchiving [<SwitchParameter>]] [-ActionOnPlaceholderDelete {RetainArchivedFile | DeleteArchivedFile}] [-EnablePassthroughRecall [<SwitchParameter>]] [-PassthroughRecallCacheLocation [<String>]] [-PassthroughRecallCacheSizeInGB [<Integer >]] [-EnablePlaceholderRecalls [<SwitchParameter>]] [-MaxRecallThreads [<Integer>]] [-RecallLimitMaxRecalls [<Integer>]] [-RecallLimitTimeInterval [<Integer>]] [-IgnoreRecallLimitForLocalAdministrators [<SwitchParameter>]] [-UsePlaceholderShortcuts [<SwitchParameter>]] [-DataMoverAccountDetails [<PSCredential>]] [-PortNumber [<Integer>]] [-SSLRequired [<SwitchParameter>]] [<CommonParameters>]

パラメータ

表: Set-EVFSAFileServer パラメータ

パラメータ

説明

-SiteId (必須)

ファイルサーバーを設定した Enterprise Vault サイトの ID。このパラメータを省略すると Set-EVFSAFileServer で、コマンドを実行している Enterprise Vault サーバーのサイトの ID が使用されます。Get-EVSite を使用して、サイト ID を取得することができます。

-Identifier (必須)

Enterprise Vault サイトで設定されている対象ファイルサーバーの完全修飾 DNS 名、UNC 名、またはエントリ ID。名前は、ファイルサーバーを追加したときに使った名前または管理コンソールに表示される名前と同じにする必要があります。ファイルサーバー名は、Get-EVFSAFileServer を使って取得できます。

パラメータエイリアス: FileServerDNSName、FileServerName、FileServerId。

-FileServer

FileServer オブジェクトを指定します。cmdlet は、ファイルサーバーのターゲットを識別するために、指定されたオブジェクトの FileServerId プロパティのみを使うことに注意してください。更新する必要があるパラメータは指定する必要があります。

-EnableArchiving

ファイルサーバーでのファイルシステムアーカイブを有効にします。無効にするには、-EnableArchiving:$false を入力します。

-ActionOnPlaceholderDelete

プレースホルダが削除されたときにアーカイブファイルを保持するか削除するかを指定します。可能な値は RetainArchivedFile と DeleteArchivedFile です。

-EnablePassthroughRecall

Windows と NetApp 7-mode のファイルサーバー上のパススルー呼び戻しを有効にします。NetApp Filer のパススルー呼び戻しは Enterprise Vault サーバーのプロパティで定義されるキャッシュの場所を使います。このキャッシュが存在しない場合は、手動で設定する必要があります。

-PassthroughRecall​CacheLocation

Windows ファイルサーバーのパススルー呼び戻しのキャッシュの場所を指定します。

-PassthroughRecall​CacheSizeInGB

Windows ファイルサーバーのパススルー呼び戻しのキャッシュの場所のサイズをギガバイト単位で指定します。

-EnablePlaceholderRecalls

NetApp ファイルサーバーでのプレースホルダの呼び戻しを有効にします。

-MaxRecallThreads

NetApp ファイルサーバーでアイテムを呼び戻すときに使用する、呼び戻しスレッドの最大数を指定します。この値は同時呼び戻し数と同じです。

-RecallLimitMaxRecalls

NetApp ファイルサーバーで指定した時間内にユーザーが呼び戻しできるアイテムの最大数を指定します。

-RecallLimitTimeInterval

NetApp ファイルサーバーでのアイテムの呼び戻しの速度を制御するために「RecallLimitMaxRecalls」とともに使われる秒単位の時間間隔を指定します。

-IgnoreRecallLimit​ForLocalAdministrators

NetApp ファイルサーバーのローカル Administrators グループのメンバーに、呼び戻し限度を適用するかどうかを制御します。

-UsePlaceholderShortcuts

Celerra/VNX ファイルサーバーでプレースホルダショートカットを有効にします。

-DataMoverAccountDetails

Enterprise Vault が認証に使用できる Celerra/VNX Data Mover のアカウントのユーザー名とパスワードを指定します。

-PortNumber

データ移動サービス (DHSM) を設定する Celerra/VNX のポート番号を指定します。

-SSLRequired

プレースホルダショートカットが有効なときに Celerra/VNX Data Mover HTTP サーバーが SSL (Secure Sockets Layer) を使うかどうかを指定します。

  • Set-EVFSAFileServer -Identifier \\abc - EnableArchiving

    または

    Set -EVFSAFileServer -FileServerName \\abc - EnableArchiving

    UNC 名が「\\abc」のファイルサーバーのファイルシステムアーカイブを有効にします。

  • Set-EVFSAFileServer -SiteId 198...example.com -Identifier abc.example.com - EnableArchiving:$false

    または

    Set-EVFSAFileServer -SiteId 198...example.com - FileServerDNSName abc.example.com - EnableArchiving:$false

    完全修飾ドメイン名が「abc.example.com」のファイルサーバーのファイルシステムアーカイブを無効にします。

  • Set-EVFSAFileServer -Identifier \\NetAppFS -EnablePlaceholderRecalls -MaxRecallThreads 10 -RecallLimitMaxRecalls 20 -RecallLimitTimeInterval 30 - IgnoreRecallLimitForLocalAdministrators

    UNC 名が「\\NetAppFS」の NetApp ファイルサーバーにおけるプレースホルダの呼び戻しを有効にし、呼び戻しスレッドの最大数と管理者がファイルを呼び戻すことができる速度を更新します。このコマンドはローカル管理者グループで呼び戻し限度を無視するかについても指定します。

  • Set-EVFSAFileServer -Identifier \\VNXFS -UsePlaceHolderShortcuts -PortNumber 5080 -SSLRequired:$false -DataMoverAccountDetails (Get-Credential)

    UNC 名が「\\VNXFS」の Celerra/VNX ファイルサーバーのプレースホルダショートカットを有効にし、Data Mover アカウントの詳細を更新します。

  • Set-EVFSAFileServer \\abc -ActionOnPlaceholderDelete RetainArchivedFile

    UNC 名が「\\abc」のファイルサーバーのプレースホルダ削除設定の処理を[アーカイブファイルを保持]に更新します。

  • Set-EVFSAFileServer \\abc -EnablePassthroughRecall -PassthroughRecallCacheLocation "C:\CacheLocation" -PassthroughRecallCacheSizeInGB 5

    UNC 名「\\abc」を持つ Windows ファイルサーバーのパススルー呼び戻しを有効にします。このコマンドは、パススルー呼び戻しのキャッシュの場所とサイズも更新します。

  • Set-EVFSAFileServer -FileServer $obj -EnableArchiving

    入力 FileServer オブジェクトを使って識別されるファイルサーバーのファイルシステムアーカイブを有効にします。

    メモ:

    FileServer オブジェクトを作成するには、次のコマンドを実行します: $obj = Get-EVFSAFileServer -FileServerName \\abc

  • Get-EVFSAFileServer -FileServerName \\abc | Set-EVFSAFileServer -EnableArchiving

    Get-EVFSAFileServer から取得した FileServer オブジェクトを Set-EVFSAFileServer にパイプし、アーカイブ対象のファイルサーバーを有効にします。

  • Set-EVFSAFileServer \\NetAppFS -EnablePassthroughRecall

    UNC 名「\\NetAppFS」を持つ NetApp 7-mode ファイルサーバーのパススルー呼び戻しを有効にします。

出力

次の表に利用可能なプロパティを示します。

表: Set-EVFSAFileServer - WindowsFileServer プロパティ

名前

種類

説明

FileServerName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの UNC 名。

FileServerDNSName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

Enterprise Vault サイトで設定されているファイルサーバーの ID。

FileServerType

FileServerType

ファイルサーバーの種類。この場合の値は WindowsFileServer です。

Archiving

Boolean

このサーバーのファイルシステムアーカイブを有効にするかどうかを指定します。

SiteId

文字列

ファイルサーバーを設定した Enterprise Vault サイトの ID。

PassthroughRecall

Boolean

パススルー呼び戻しを設定するかどうかを指定します。

PassthroughRecall​CacheLocation

文字列

パススルー呼び戻しのキャッシュの場所を指定します。

PassthroughRecall​CacheSizeInGB

整数

パススルー呼び戻しのキャッシュの場所のサイズをギガバイト単位で指定します。

ActionOnPlaceholderDelete

ActionOn​PlaceholderDelete

プレースホルダが削除されたときにアーカイブファイルを保持するか削除するかを指定します。値には RetainArchivedFile または DeleteArchivedFile を指定できます。

表: Set-EVFSAFileServer - NetAppCModeFileServer プロパティ

名前

種類

説明

FileServerName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの UNC 名。

FileServerDNSName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

Enterprise Vault サイトで設定されているファイルサーバーの ID。

FileServerType

FileServerType

ファイルサーバーの種類。この場合の値は NetAppCModeFileServer です。

Archiving

Boolean

このサーバーのファイルシステムアーカイブを有効にするかどうかを指定します。

SiteId

文字列

ファイルサーバーを設定した Enterprise Vault サイトの ID。

ActionOnPlaceholderDelete

ActionOn​PlaceholderDelete

プレースホルダが削除されたときにアーカイブファイルを保持するか削除するかを指定します。値には RetainArchivedFile または DeleteArchivedFile を指定できます。

PlaceholderRecallsEnabled

Boolean

NetApp Filer のプレースホルダの呼び戻しの処理を有効にするかどうかを指定します。

MaxRecallThreads

整数

アイテムを呼び戻しするときに使われる呼び戻しスレッドの最大数。この値は同時呼び戻し数と同じです。

RecallLimitMaxRecalls

整数

ユーザーが呼び戻すことができるアイテムの最大数を指定します。

RecallLimitTimeInterval

整数

指定した時間内にユーザーが呼び戻すことができるアイテムの最大数を指定します。

IgnoreRecallLimit​ForLocalAdministrators

Boolean

NetApp Filer のローカル Administrators グループのメンバーに、呼び戻し限度を適用するかどうかを指定します。

表: Set-EVFSAFileServer - NetApp7ModeFileServer プロパティ

名前

種類

説明

FileServerName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの UNC 名。

FileServerDNSName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

Enterprise Vault サイトで設定されているファイルサーバーの ID。

FileServerType

FileServerType

ファイルサーバーの種類。この場合の値は NetApp7ModeFileServer です。

Archiving

Boolean

このサーバーのファイルシステムアーカイブを有効にするかどうかを指定します。

SiteId

文字列

ファイルサーバーを設定した Enterprise Vault サイトの ID。

ActionOnPlaceholderDelete

ActionOn​PlaceholderDelete

プレースホルダが削除されたときにアーカイブファイルを保持するか削除するかを指定します。値には RetainArchivedFile または DeleteArchivedFile を指定できます。

PassthroughRecall

Boolean

パススルー呼び戻しを設定するかどうかを指定します。

PlaceholderRecallsEnabled

Boolean

NetApp Filer のプレースホルダの呼び戻しの処理を有効にするかどうかを指定します。

MaxRecallThreads

整数

アイテムを呼び戻しするときに使われる呼び戻しスレッドの最大数。この値は同時呼び戻し数と同じです。

RecallLimitMaxRecalls

整数

ユーザーが呼び戻すことができるアイテムの最大数を指定します。

RecallLimitTimeInterval

整数

指定した時間内にユーザーが呼び戻すことができるアイテムの最大数を指定します。

IgnoreRecallLimit​ForLocalAdministrators

Boolean

NetApp Filer のローカル Administrators グループのメンバーに、呼び戻し限度を適用するかどうかを指定します。

表: Set-EVFSAFileServer - EMCCelerraOrVNXFileServer プロパティ

名前

種類

説明

FileServerName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの UNC 名。

FileServerDNSName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

Enterprise Vault サイトで設定されているファイルサーバーの ID。

FileServerType

FileServerType

ファイルサーバーの種類。Celerra または VNX の場合は、値は EMCCelerraOrVNXFileServer です。

Archiving

Boolean

このサーバーのファイルシステムアーカイブを有効にするかどうかを指定します。

SiteId

文字列

ファイルサーバーを設定した Enterprise Vault サイトの ID。

PlaceholdersEnabled

Boolean

ショートカットを作成するポリシーが有効になっている場合、プレースホルダをファイルサーバーの共有で作成するかどうかを指定します。

DHSMServiceConfiguration

DHSMService​Configuration

プレースホルダの作成に必要な DHSM サービスの設定を指定します。

表: Set-EVFSAFileServer - DHSMServiceConfiguration のプロパティ

名前

種類

説明

UserName

文字列

Enterprise Vault が DHSM サービスの認証に使う Data Mover のユーザー名を指定します。

Password

SecureString

Enterprise Vault が DHSM サービスの認証に使う Data Mover アカウントのパスワードを指定します。 このパスワードは暗号化形式で、Enterprise Vault ディレクトリデータベースに格納されます。

PortNumber

整数

DHSM が設定されているポート番号を指定します。

SSLRequired

Boolean

DHSM サービスで SSL 接続を必要とするかどうかを指定します。

表: Set-EVFSAFileServer - FileServer のプロパティ

名前

種類

説明

FileServerName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの UNC 名。

FileServerDNSName

文字列

Enterprise Vault サイトで設定されているファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

Enterprise Vault サイトで設定されているファイルサーバーの ID。

FileServerType

FileServerType

ファイルサーバーの種類。この場合の値は OtherCIFSFileServer です。

Archiving

Boolean

このサーバーのファイルシステムアーカイブを有効にするかどうかを指定します。

SiteId

文字列

ファイルサーバーを設定した Enterprise Vault サイトの ID。

関連コマンドレット