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

Set-EVFSAFolder は既存フォルダの指定された設定を更新します。

Set-EVFSAFolder は、Veritas.EnterpriseVault.PowerShell.AdminAPI.dll スナップインから利用できます。

構文

Set-EVFSAFolder [-SiteId <String>] [-FileServer] <String> [-Volume] <String> [-FolderRelativePath] <String> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-IncludeRetentionFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFolder [-SiteId <String>] -Identifier <String> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-IncludeRetentionFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFolder [-SiteId <String>] [-FsaFolder] <FSAFolder> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-IncludeRetentionFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

パラメータ

表: Set-EVFSAFolder パラメータ

パラメータ

説明

-SiteId (必須)

ファイルサーバーボリュームを設定している Enterprise Vault サイトの ID。このパラメータを省略すると、Set-EVFSAFolder で、cmdlet を実行している Enterprise Vault サーバーのサイトの ID が使用されます。Get-EVSite を使用して、サイト ID を取得することができます。

-FileServer (必須)

フォルダをホストするファイルサーバーの完全修飾 DNS 名、UNC 名、エイリアス名、またはエントリ ID。名前は、ファイルサーバーを追加したときに使った名前または管理コンソールに表示される名前と同じにする必要があります。ファイルサーバー名は、Get-EVFSAFileServer を使って取得できます。UNC 名は「\\」接頭辞を付けても付けなくても指定できます。また、ホスト名とエイリアスのいずれかを UNC 名として指定できます。

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

-Identifier (必須)

次の形式の、更新するフォルダのパス:

\\file server name\volume name\folder relative path

-FsaFolder (必須)

FSAFolder オブジェクトを指定します。cmdlet は指定したオブジェクトから FileServerName、VolumeName、FolderName プロパティを指定してフォルダターゲットを識別します。更新する必要があるパラメータは指定する必要もあります。

-Volume (必須)

フォルダをホストするファイルサーバーのボリュームの名前またはエントリ ID。

パラメータエイリアス: VolumeId、VolumeName

-FolderRelativePath (必須)

更新するフォルダの相対パス。

パラメータエイリアス: FolderName

-Policy

Enterprise Vault がフォルダからアイテムをアーカイブする際に使う必要があるフォルダポリシーの名前またはエントリ ID。指定したフォルダが Celerra/VNX ファイルサーバーにある場合で、ポリシーの[プレースホルダが削除されたときにアーカイブアイテムを削除]設定が有効になっている場合は、確認を求めるメッセージが表示されます。

パラメータエイリアス: PolicyId、PolicyName

-IgnoreVolumeRules

Enterprise Vault がフォルダをアーカイブする際にボリュームポリシールールを無視するように指定します。フォルダポリシーを指定していない場合は、このオプションは利用できません。

-UseVolumePolicy

Enterprise Vault がフォルダからアイテムをアーカイブするときにボリュームポリシーを使用するように指定します。-UseVolumePolicy-Policy の両方のパラメータを使用することはできません。

-DisableArchivingOnFolder

指定したフォルダでファイルシステムアーカイブを無効にします。

-DisableArchivingOnSubFolders

指定したフォルダのサブフォルダでファイルシステムアーカイブを無効にします。

-IncludeRetentionFolders

Enterprise Vault が保持フォルダを更新するかどうかを指定します。指定したフォルダまたはサブフォルダでファイルシステムアーカイブを無効にするには、-DisableArchivingOnFolder および -DisableArchivingOnSubFolders とともに使用します。

-Confirm

cmdlet を実行する前に確認するように求められます。これを使用すると、この cmdlet を Celerra/VNX ファイルサーバーのフォルダに対して実行するときに表示される確認プロンプトの表示を抑止できます。プロンプトを表示しないようにするには、-Confirm:$false と入力します。

-WhatIf

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

  • Set-EVFSAFolder \\abc volume1 folder1 -Policy 'office files'

    または

    Set-EVFSAFolder -FileServer \\abc -Volume volume1 -FolderRelativePath folder1 -Policy 'office files'

    または

    Set-EVFSAFolder -FileServerName \\abc -VolumeName volume1 -FolderRelativePath folder1 -Policy 'office files'

    または

    Set-EVFSAFolder -Identifier \\abc\volume1\folder1 -Policy 'office files'

    または

    Set-EVFSAFolder -FolderPath \\abc\volume1\folder1 -Policy 'office files'

    UNC 名が「\\abc」のファイルサーバーに設定されたファイルサーバーボリューム「volume1」のフォルダ「folder1」に「office files」というフォルダポリシーを適用します。

  • Set-EVFSAFolder '123...example.com' '456...example.com' folder1 -Policy '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders -IgnoreVolumeRules

    または

    Set-EVFSAFolder -FileServer '123...example.com' -Volume '456...example.com' -FolderRelativePath folder1 -Policy '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders - IgnoreVolumeRules

    または

    Set-EVFSAFolder -FileServerId '123...example.com' -VolumeId '456...example.com' -FolderRelativePath folder1 -PolicyId '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders -IgnoreVolumeRules

    エントリ ID が「789...example.com」のフォルダポリシーを、エントリ ID が「123...example.com」のファイルサーバーに設定された、エントリ ID が「456...example.com」のファイルサーバーボリュームにあるフォルダ「folder1」に適用します。このコマンドは、指定したフォルダとそのサブフォルダでのアーカイブも無効にします。また、フォルダをアーカイブする際はボリュームポリシールールを無視します。

  • Set-EVFSAFolder abc.example.com volume1 folder1 - UseVolumepolicy

    または

    Set-EVFSAFolder -FileServer abc.example.com -Volume volume1 -FolderRelativePath folder1 - UseVolumepolicy

    または

    Set-EVFSAFolder -FileServerDNSName abc.example.com -VolumeName volume1 -FolderRelativePath folder1 - UseVolumepolicy

    または

    Set-EVFSAFolder -FolderPath \\abc.example.com\volume1\folder1 -UseVolumepolicy

    完全修飾ドメイン名が「abc.example.com」のファイルサーバーに設定されたファイルサーバーボリューム「volume1」のフォルダ「folder1」にボリュームポリシーを適用します。

  • Set-EVFSAFolder -FsaFolder $obj -UseVolumepolicy

    入力した FsaFolder オブジェクトを使って識別されるフォルダにボリュームポリシーを適用します。

    メモ:

    FsaFolder オブジェクトを作成するには、コマンド を実行します。$obj = Get-EVFSAFolder -Identifier \\abc.example.com\volume1\folder1

  • Get-EVFSAFolder - Identifier \\abc.example.com\volume1\folder1 | Set-EVFSAFolder -UseVolumepolicy

    Get-EVFSAFolder cmdlet から取得した FsaFolder オブジェクトを Set-EVFSAFolder cmdlet にパイプ処理して、フォルダのボリュームポリシーを適用します。

  • Set-EVFSAFolder abc.example.com volume1 folder1 -IncludeRetentionFolders -DisableArchivingOnSubFolders

    または

    Set-EVFSAFolder -FileServer abc.example.com -Volume volume1 -FolderRelativePath folder1 -IncludeRetentionFolders -DisableArchivingOnSubFolders

    または

    Set-EVFSAFolder -FileServerDNSName abc.example.com -VolumeName volume1 -FolderRelativePath folder1 -IncludeRetentionFolders -DisableArchivingOnSubFolders

    または

    Set-EVFSAFolder -FolderPath \\abc.example.com\volume1\folder1 -IncludeRetentionFolders -DisableArchivingOnSubFolders

    完全修飾ドメイン名が「abc.example.com」のファイルサーバーに設定されたファイルサーバーボリューム「volume1」にある保持フォルダ「folder1」のサブフォルダのアーカイブを無効にします。

出力

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

表: Set-EVFSAFolder properties

名前

種類

説明

FolderPath

文字列

ファイルシステムアーカイブ用に有効になるフォルダのフルパス。パスは \\file server name\volume name\folder relative path の形式にする必要があります。

FolderName

文字列

フォルダの相対パス。

IsRetentionFolder

ブール値

フォルダが保持フォルダであるかどうかを指定します。

FolderPolicyName

文字列

Enterprise Vault がフォルダからアイテムをアーカイブするのに使うフォルダポリシーの名前。

VolumePolicyName

文字列

Enterprise Vault がボリュームからアイテムをアーカイブするのに使うボリュームポリシーの名前。

IgnoreVolumeRules

文字列

Enterprise Vault がフォルダからアイテムをアーカイブする際にボリュームポリシールールを無視するように指定します。

ArchivingEnabled​OnFolder

Boolean

ファイルシステムアーカイブをフォルダで有効にするかどうかを指定します。

ArchivingEnabled​OnSubfolders

Boolean

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

FileServerName

文字列

フォルダをホストするファイルサーバーの完全修飾 DNS 名。

FileServerId

文字列

フォルダをホストするファイルサーバーの ID。

VolumeName

文字列

フォルダをホストするボリュームの名前。

VolumeId

文字列

フォルダをホストするボリュームの ID。

FolderId

文字列

フォルダの ID。

FolderPolicyId

文字列

Enterprise Vault がフォルダからアイテムをアーカイブするのに使うフォルダポリシーの ID。

VolumePolicyId

文字列

Enterprise Vault がボリュームからアイテムをアーカイブするのに使うボリュームポリシーの ID。