Windows PowerShell によるキャッシュ管理 (Windows Server AppFabric キャッシュ)

  • [アーティクル]

Windows PowerShell を使用して、キャッシュ クラスター、キャッシュ ホスト、およびキャッシュ自体を管理できます。キャッシュ管理機能がインストールされたコンピューターを使用している場合、AppFabric のキャッシュ機能を管理するために Windows PowerShell を起動するには、2 とおりの方法があります。[スタート] ボタンをクリックし、[管理ツール] をクリックして、[Windows PowerShell モジュール] を選択します。または、[スタート] ボタンをクリックし、[すべてのプログラム]、[Windows Server AppFabric]、[Windows PowerShell のキャッシュ管理] の順にクリックします。

ヒント

Windows Vista、Windows 7、および Windows Server 2008 オペレーティング システムでは、一部の管理コマンドを正しく動作させるために、管理者特権で Windows PowerShell を実行する必要があります。[Windows PowerShell のキャッシュ管理] のショートカットを使用する場合は、ショートカットを右クリックし、[管理者として実行] を選択する必要があります。

AppFabric キャッシング用の PowerShell コマンドには 2 つの主なカテゴリがあります。管理コマンドと構成コマンドです。このトピックでは、管理コマンドに焦点を当てます。構成コマンドの詳細については、「Windows PowerShell によるキャッシュ構成 (Windows Server AppFabric キャッシング)」を参照してください。このトピックでは、管理コマンドをさらにいくつかのカテゴリに分けて表に示しています。コマンド カテゴリには次の 4 つがあります。一部のコマンドは複数の表に記載されていますが、カテゴリによってパラメーターが異なるため、それぞれのカテゴリに適用されるパラメーターと共に示されています。

  • キャッシュ クラスター関連コマンド

  • キャッシュ ホスト関連コマンド

  • キャッシュ関連コマンド

  • コンソール管理コマンド

Windows PowerShell セッションでのヘルプの表示

AppFabric のキャッシュ機能に関係する管理コマンドの概要を以下に示します。Windows PowerShell セッション内からでもヘルプを表示できることを知っておくことが重要です。たとえば、次のコマンドを入力すると、すべての管理コマンドが表示されます。

get-command -module DistributedCacheAdministration

特定のコマンドについてヘルプを参照する必要がある場合は、get-help コマンドを使用して表示できます。たとえば、次のコマンドを入力すると、New-Cache コマンドの詳細なヘルプが表示されます。

get-help New-Cache -full

重要な考慮事項

このトピックで説明している Windows PowerShell コマンドを使用する場合、以下の点を考慮することが重要です。

  • Windows PowerShell コマンドを使用するユーザーのセキュリティ ID に、キャッシュ クラスター内のすべてのキャッシュ サーバーに対する管理者特権が付与されている必要があります。

  • コマンドのパラメーター値は大文字と小文字が区別されます。たとえば、NamedCache1 という名前のキャッシュを作成した場合、Get-CacheConfig -CacheName namedcache1 というコマンドは機能しません。大文字と小文字を区別して、Get-CacheConfig -CacheName NamedCache1 とする必要があります。

  • Export-CacheClusterConfig および Import-CacheClusterConfig コマンドを使用して XML ベースのクラスター構成変更を行う場合、XML ファイル内のクラスター構成設定 (XML 属性) を変更することはできますが、XML 要素を挿入または削除して名前付きキャッシュおよびキャッシュ ホストを追加または削除することは、サポートされていません。

  • Start-CacheCluster、Stop-CacheCluster、および Restart-CacheCluster の各キャッシュ クラスター コマンドでは、クラスター内のすべてのキャッシュ サーバーでキャッシュ ホスト Windows サービスの状態が調整されます。リード ホストがクラスター管理の役割を実行する場合、これらのコマンドは実行に時間がかかることがあります。リード ホスト以外のホストの停止と起動が行われる間、大部分のリード ホストが実行中でなければならないためです。

  • キャッシュ サービスの開始と停止には常に、キャッシュ クラスター コマンドの Start-CacheCluster、Stop-CacheCluster、および Restart-CacheCluster を使用します。サービス管理ツールからサービスを開始および停止すると、サービスは応答しなくなる可能性があります。また、これらのコマンドは管理者特権の Windows PowerShell セッションから実行する必要があります。

  • Stop-CacheCluster または Restart-CacheCluster キャッシュ クラスター コマンドにより、クラスター内のすべてのキャッシュのメモリからすべてのデータがフラッシュされます。

  • Set-CacheConfig および Import-CacheClusterConfig コマンドの場合、変更を有効にするために Restart-CacheCluster を使用してキャッシュ クラスターを再起動する必要があります。

  • Remove-Cache および New-Cache コマンドを使用すると、クラスターに含まれる他の名前付きキャッシュに影響を与えることなく、名前付きキャッシュ構成を変更できます。

キャッシュ クラスター関連コマンド

次の表は、クラスター関連の操作を実行するために使用できる Windows Powershell のキャッシュ管理コマンドの一覧です。

コマンド 説明

Use-CacheCluster

Windows PowerShell セッションのコンテキストを目的のキャッシュ クラスターに設定します。

Windows PowerShell セッションを開始するときは、最初にこのコマンドを実行する必要があります。キャッシュ ホスト上で実行する場合は、パラメーターなしでコマンドを実行します (パラメーターはコンピューターのキャッシュ構成から取得されるため)。ホスト以外のコンピューター上で実行する場合は、以下のパラメーターを使用して目的のキャッシュ クラスターを指定できます。

パラメーター (エイリアス) の説明は次のとおりです。

  • Provider (P): クラスター構成設定の保存に使用されるプロバイダー。構成情報を保存する方法に応じて、System.Data.SqlClient または XML のいずれかとすることができます。

  • ConnectionString (C): データベースまたは XML 構成ファイルがある場所に接続するための接続文字列。

Start-CacheCluster

クラスター内のすべてのキャッシュ サービスを開始します。リード ホストが最初に起動されます。再起動後にキャッシュ サービスは自動的には開始されないため、サービスを開始するには Start-CacheCluster または Start-CacheHost を呼び出す必要があります。このコマンドを実行するには管理者特権が必要です。

Stop-CacheCluster

クラスター内のすべてのキャッシュ サービスを停止します。このコマンドを実行するには管理者特権が必要です。

Restart-CacheCluster

クラスター内のすべてのキャッシュ サービスを正しい順序で再開します。このコマンドを実行するには管理者特権が必要です。

Get-CacheClusterHealth

キャッシュ クラスターの動作状態に関する統計を返します。

Export-CacheClusterConfig

Import-CacheClusterConfig と組み合わせて使用することを想定したこのコマンドでは、XML を使用してクラスター構成設定を編集できます。詳細については、「クラスターの構成設定の編集 (Windows Server AppFabric キャッシング)」を参照してください。

このコマンドは、クラスター内に現在存在するクラスター構成設定を、指定した XML ベースの構成ファイルにエクスポートします。クラスター構成設定を保存する場所としてどこを選択したか (SQL Server または共有ネットワーク フォルダー) にかかわらず、このコマンドを使用できます。

パラメーター (エイリアス) の説明は次のとおりです。

  • File (F): 作成する XML ベースの構成ファイルの完全修飾されたパスと名前。このファイルで現在のキャッシュ クラスター構成設定を記述します。

例:Export-CacheClusterConfig -File c:\Temp\CurrentClusterConfig.xml

Import-CacheClusterConfig

Export-CacheClusterConfig と組み合わせて使用することを想定したこのコマンドでは、XML を使用してクラスター構成設定を編集できます。詳細については、「クラスターの構成設定の編集 (Windows Server AppFabric キャッシング)」を参照してください。

このコマンドは、指定された XML ベースの構成ファイルに定義されたクラスター構成設定をインポートします。クラスター構成設定を保存する場所としてどこを選択したか (SQL Server または共有ネットワーク フォルダー) にかかわらず、このコマンドを使用できます。

変更を有効にするには、Restart-CacheCluster を使用してコンピューターを再起動する必要があります。

パラメーター (エイリアス) の説明は次のとおりです。

  • File (Fi): クラスターに適用するキャッシュ クラスター構成設定を記述した、XML ベースの構成ファイルの完全修飾されたパスと名前。

  • Force (Fo): 確認メッセージを表示せずに構成ファイルをインポートします。

例:Import-CacheClusterConfig -File c:\CurrentClusterConfig.xml

Grant-CacheAllowedClientAccount

Windows アカウントにキャッシュ クラスターへのアクセス権を付与します。既定では、キャッシュ ホスト上の管理者アカウントにはキャッシュ クラスターへのアクセス権があります。他のアカウントは、許可されているクライアント アカウントの一覧に明示的に追加する必要があります。

パラメーター (エイリアス) の説明は次のとおりです。

  • Account (A): キャッシュ クラスターへのアクセス権を付与する対象の Windows アカウント。

  • Force (F): 存在するかどうかを確認せずに、指定されたクライアント アカウントを追加します。

Revoke-CacheAllowedClientAccount

Windows アカウントのキャッシュ クラスターへのアクセス権を取り消します。この取り消しによって、キャッシュ ホスト上の管理者がキャッシュ クラスターにアクセスできなくなることはありません。

パラメーター (エイリアス) の説明は次のとおりです。

  • Account (A): キャッシュ クラスターへのアクセス権を付与する対象の Windows アカウント。

Get-Cache

パラメーターなしで使用すると、キャッシュ クラスター全体のすべてのキャッシュに関する情報が一覧表示されます。

ヒント

このコマンドを HostName パラメーターと共に使用する方法については、次の表を参照してください。

キャッシュ ホスト関連コマンド

次の表は、キャッシュ ホスト関連の操作を実行するために使用できる Windows PowerShell のコマンドの一覧です。

コマンド 説明

Get-CacheHost

指定されたキャッシュ ホストに関する情報を一覧表示します。パラメーターが渡されなかった場合は、キャッシュ クラスターのメンバーであるすべてのキャッシュ サービスを一覧表示します。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (H): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストのキャッシュ ポート番号。

例:Get-CacheHost

Get-CacheHostConfig

指定されたキャッシュ ホストに関する構成情報を返します。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (H): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストのキャッシュ ポート番号。

例:Get-CacheConfig -HostName CacheServer1 -CachePort 22233

Set-CacheHostConfig

キャッシュ ホスト構成をコマンド パラメーターで指定された値に更新します。HostName および CachePort を除くすべてのパラメーターが省略可能です。詳細については、「クラスターの構成設定の編集 (Windows Server AppFabric キャッシング)」を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (H): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストの現在のキャッシュ ポート番号。

  • ClusterPortNumber (CPort): キャッシュ ホストによって使用されるクラスター ポート番号。

  • ArbitratorPortNumber (APort): 新しい判別子ポート番号。

  • ReplicationPortNumber (RPort): 新しいレプリケーション ポート番号。

  • CacheSize (Size): キャッシュ ホストでデータを保存するために割り当てられたメモリの合計量 (MB 単位)。

  • HWM (HWM): 警告を発生させるメモリのサイズ値の割合。この割合に達すると、有効期限前のオブジェクトの削除が開始されます。

  • LWM (LWM): 警告をリセットさせるサイズ値の割合。この割合に達すると、有効期限切れのオブジェクトの削除が開始されます。HWM に到達した後は、まだ有効期限切れになっていないオブジェクトの削除が停止されます。

例:Set-CacheConfig -HostName CacheServer1 -CachePort 22233 -LowWM 80

Start-CacheHost

指定されたキャッシュ サービスを開始します。キャッシュ サーバーの再起動後、実行中のキャッシュ クラスターにキャッシュ サービスを再度参加させるときに、このコマンドが必要です。キャッシュ クラスターが停止している場合は、代わりに Start-CacheCluster コマンドを使用する必要があります。また、再起動後にキャッシュ サービスは自動的には開始されないため、サービスを開始するには Start-CacheHost または Start-CacheCluster を呼び出す必要があります。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (HostN): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストのキャッシュ ポート番号。

  • HostTimeout(T): 指定されたキャッシュ ホストを起動するときのタイムアウト値 (秒)。既定値は 60 秒です。

例:Start-CacheHost -HostName CacheServer1 -CachePort 22233

Stop-CacheHost

指定されたキャッシュ サービスを停止します。

ヒント

キャッシュ ホストがクラスター管理の役割を果たしている場合は、Stop-CacheHost コマンドを実行してもキャッシュ ホストの Windows サービスは停止しません。また、その場合、キャッシュ ホストを停止すると、クラスター全体がシャットダウンします。詳細については、「リード ホストとクラスター管理 (Windows Server AppFabric キャッシュ)」を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (HostN): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストのキャッシュ ポート番号。

  • HostTimeout(T): 指定されたキャッシュ ホストを起動するときのタイムアウト値 (秒)。

例:Stop-CacheHost -HostName CacheServer1 -CachePort 22233

Get-CacheStatistics

指定されたキャッシュ ホストについて、合計サイズ (バイト) や、キャッシュに入れられているオブジェクト、領域、名前付きキャッシュ、要求、キャッシュ ミスの数などの統計を表示します。

ヒント

このコマンドを CacheName パラメーターと共に使用する方法については、次の表を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (H): キャッシュ ホストの名前。

  • CachePort (P): キャッシュ ホストのキャッシュ ポート番号。

例:Get-CacheStatistics -HostName CacheServer1 -CachePort 22233

Get-Cache

指定されたキャッシュ ホスト上に存在するすべてのキャッシュと領域を一覧表示します。

パラメーター (エイリアス) の説明は次のとおりです。

  • HostName (H): キャッシュ ホストの名前。

  • CachePort (C): キャッシュ ホストのキャッシュ ポート番号。

例:Get-Cache -HostName CacheServer1 -CachePort 22233

Get-CacheRegion

キャッシュ クラスター内のすべての領域の一覧を返します。領域は、キャッシュ クライアントのみが作成または削除できます。ただし、どのキャッシュ ホストに領域を作成するかはキャッシュ クラスターが決定します。すべてのパラメーターは省略可能です。

ヒント

このコマンドを CacheName パラメーターと共に使用する方法については、次の表を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • MaxRegions: 表示する領域の最大数。これを MaxRegionsPerHost パラメーターと共に使用することはできません。

  • MaxRegionsPerHost: キャッシュ クラスター内の各ホストから表示する領域の最大数。

例:Get-CacheRegion -MaxRegionsPerHost 4

キャッシュ関連コマンド

次の表は、Windows PowerShell を使用してキャッシュ関連の操作を実行できるコマンドの一覧です。

コマンド 説明

New-Cache

クラスターの実行中に新しい名前付きキャッシュを作成します。CacheName を除くすべての値が省略可能です。

ヒント

名前付きキャッシュは 128 個まで作成できます。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

  • Secondaries (S): 値を 1 にすると高可用性機能が有効になります。値を 0 にすると高可用性機能が無効になります。既定値は 0 です。

  • NotificationsEnabled (Notif): 値を True にするとキャッシュ通知機能が有効になり、False にすると無効になります。

  • Eviction (Evict): LRU の値にすると、"最近、最も使われていないもの" の削除が有効になります。値を None にすると、その削除が無効になります。既定値は LRU です。

    警告

    値を None にすると、キャッシュ ホストがメモリ不足になる可能性があります。

  • TimeToLive (T): キャッシュに格納されているオブジェクトが有効期限切れになるまでの既定のタイムアウト (分)。既定値は 10 です。

  • Expirable: 値を True にすると有効期限が有効になり、False にすると有効期限は無効になります。既定値は True です。

例:New-Cache -CacheName NamedCache1 -Secondaries 1 -TimeToLive 15

Remove-Cache

CacheName パラメーターで指定された名前付きキャッシュを削除します。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

例:Remove-Cache -CacheName NamedCache1

Get-CacheConfig

CacheName パラメーターで指定された名前付きキャッシュについて、構成の詳細を返します。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

例:Get-CacheConfig -CacheName NamedCache1

Set-CacheConfig

CacheName パラメーターで指定された名前付きキャッシュの構成設定を更新します。

キャッシュ クラスターの実行中は、CacheName パラメーターを使用してキャッシュに変更を加えることはできません。別の方法として、Remove-Cache および New-Cache コマンドを使用することができます。これらのコマンドを使用すると、クラスターを停止する必要がないため、クラスター内の他の名前付きキャッシュに影響を与えることなく、名前付きキャッシュの構成を変更できます。

詳細については、「Windows PowerShell でキャッシュ構成設定を編集する (Windows Server AppFabric キャッシュ)」を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

  • Secondaries (S): 値を 1 にすると高可用性機能が有効になります。値を 0 にすると高可用性機能が無効になります。既定値は 0 です。この機能は、Enterprise Edition または DataCenter Edition の Windows Server を実行しているキャッシュ ホストでのみサポートされることに注意してください。

  • NotificationsEnabled (Notif): 値を True にするとキャッシュ通知機能が有効になり、False にすると無効になります。

  • Eviction (Evict): LRU の値にすると、"最近、最も使われていないもの" の削除が有効になります。値を None にすると、その削除が無効になります。既定値は LRU です。

    警告

    値を None にすると、キャッシュ ホストがメモリ不足になる可能性があります。

  • TimeToLive (T): キャッシュに格納されているオブジェクトが有効期限切れになるまでの既定のタイムアウト (分)。既定値は 10 です。

  • Expirable: 値を True にすると有効期限が有効になり、False にすると有効期限は無効になります。既定値は True です。

例:Set-CacheConfig -CacheName NamedCache1 -TimeToLive 30

Get-CacheStatistics

CacheName パラメーターで指定された名前付きキャッシュの統計を返します。

ヒント

このコマンドを HostName および CachePort パラメーターと共に使用する方法については、前の表を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

例:Get-CacheStatistics -CacheName NamedCache1

Get-CacheRegion

CacheName パラメーターで指定された名前付きキャッシュ内のすべての領域の一覧を返します。領域は、キャッシュ クライアントのみが作成または削除できます。各領域をどのキャッシュ ホストに作成するかは、キャッシュ クラスターが制御します。

ヒント

このコマンドを HostName および CachePort パラメーターと共に使用する方法については、前の表を参照してください。

パラメーター (エイリアス) の説明は次のとおりです。

  • CacheName (N): キャッシュの名前。

例:Get-CacheRegion -CacheName NamedCache1

コンソール管理コマンド

次の表は、Windows PowerShell ベースのキャッシュ管理ツールに対して管理関連の操作を実行するために使用できるコマンドの一覧です。

コマンド 説明

Set-CacheLogging

このコマンドを使用すると、Windows PowerShell ベースのキャッシュ管理ツール セッションについて、ファイルを使用したロギングを行うことができます。このコマンドによって開始されたイベント追跡は、それが呼び出された Windows PowerShell セッションの有効期間中のみ継続されます。

既定では、ロギングは VERBOSE レベルで有効化されます。既定のログ ファイルはユーザーの %temp% ディレクトリにあり、プレフィックス DCacheAdministration とそれに続くプロセス識別子および作成時のタイム スタンプで構成される名前が付いています。

同じ名前のファイルが既に存在する場合は、既存ログ ファイルの末尾にログが追加されます。

パラメーター (エイリアス) の説明は次のとおりです。

  • LogLevel (L): 追跡によってキャプチャされるイベントの種類を指定するイベント レベル。有効な値は、NONE、ERROR、WARNING、INFO、および VERBOSE です。

  • File (F): ログの書き込み先となるフォルダーまたはファイルの絶対パス。ファイル名を指定しない場合は、既定で DCacheAdminTrace[<ProcessId>].log になります。<ProcessId> は、Windows PowerShell セッションの Windows プロセス ID を示す数値です。指定したすべてのファイル名に、".log" が付加されます。

この例では、警告メッセージとエラー メッセージをキャプチャする c:\WarningLog.log というファイルが作成されます。

Set-CacheLogging -LogLevel WARNING -File c:\WarningLog

このコマンドは、キャッシュ クライアントまたはキャッシュ ホストではなく Windows PowerShell セッションのイベントのみを追跡します。

Invoke-GC

キャッシュ クラスター上でガベージ コレクションを手動で呼び出し、使用されていないメモリを解放します。これは特別な状況でのみ可能です。通常、ガベージ コレクションは .NET Framework と AppFabric キャッシュ クラスターのメモリ管理機能によって管理されます。

Get-Help

サポートされているすべてのコマンドのヘルプ情報を提供します。このキーワードを "*" 文字と共に使用して、ヘルプ情報の分量をフィルター処理することもできます。

Get-Help new*

Get-Help Start*

Get-Help *cache

Get-Help *cachehost

exit

Windows PowerShell セッションを終了します。

cls

Windows PowerShell 画面をクリアします。

関連項目

概念

Windows PowerShell によるキャッシュ構成 (Windows Server AppFabric キャッシング)
構成の設定 (Windows Server AppFabric キャッシュ)
Windows Server AppFabric キャッシュ構成オプション
Windows Server AppFabric キャッシュのトラブルシューティング
Windows Server AppFabric のキャッシュの概念
キャッシュ クライアントを開発する (Windows Server AppFabric キャッシュ)

  2011-12-05