Data Grid コマンドラインインターフェイス

Data Grid Console の admin ユーザーと、Data Grid 環境を完全に制御する必要があります。このため、初めて認証情報を追加する時に admin パーミッションを持つユーザーを作成する必要があります。

ユーザーにロールを割り当て、ユーザーがデータにアクセスし、Data Grid リソースを変更するための適切なパーミッションを持つようにします。

グループを使用すると、複数のユーザーのパーミッションを変更できます。グループにロールを割り当ててから、そのグループにユーザーを追加します。ユーザーは、グループロールからパーミッションを継承します。

Data Grid には、データにアクセスして Data Grid リソースと対話するためのパーミッションをユーザーに付与するデフォルトのロールのセットが含まれています。

ClusterRoleMapper は、Data Grid がセキュリティープリンシパルを承認ロールに関連付けるために使用するデフォルトのメカニズムです。

Data Grid CLI は、以下の目的でさまざまなリソースを公開します。

[//containers/default]> ls
caches
counters
configurations
schemas

[hostname@cluster/]> ls
containers
cluster
server

シャットダウン後に Data Grid クラスターをオンラインに戻す場合、クラスターが利用できるのを待ってから、ノードの追加または削除、またはクラスター状態の変更を行う必要があります。

shutdown server コマンドでクラスター化ノードをシャットダウンする場合は、各サーバーを逆の順序で再起動する必要があります。
たとえば、server1 をシャットダウンしてから、server2 をシャットダウンする場合は、最初に server2 を起動してから server1 を起動する必要があります。

shutdown cluster コマンドでクラスターをシャットダウンすると、すべてのノードが再度参加した後にのみ、クラスターは完全に機能するようになります。
ノードは任意の順序で再起動できますが、シャットダウン前に参加していたすべてのノードが実行されるまで、クラスターは DEGRADED 状態のままになります。

キャッシュ設定は、XML または JSON 形式で提供できます。

<distributed-cache name="myCache" mode="SYNC">
  <encoding media-type="application/x-protostream"/>
  <memory max-count="1000000" when-full="REMOVE"/>
</distributed-cache>

{
  "distributed-cache": {
    "name": "myCache",
    "mode": "SYNC",
    "encoding": {
      "media-type": "application/x-protostream"
      },
    "memory": {
      "max-count": 1000000,
      "when-full": "REMOVE"
    }
  }
}

JSON 形式

JSON 形式のキャッシュ設定は、XML 設定の構造に従う必要があります。* XML 要素が JSON オブジェクトになります。* XML 属性は JSON フィールドになります。

add - 任意の値でカウンターに増分または減分を適用します。

add ['OPTIONS'] ['COUNTER_NAME']

add --delta=10 cnt_a
cnt_a の値を 10 増やします。

add --delta=-5 cnt_a
cnt_a の値を 5 減らします。

cas(1)、reset(1)

alias - エイリアスを作成または表示します。

alias ['ALIAS-NAME'='COMMAND']

alias q=quit
quit コマンドのエイリアスとして q を作成します。

alias
定義されているすべてのエイリアスを一覧表示します。

config(1)、unalias(1)

backup - コンテナーのバックアップ作成と復元を管理します。

backup create ['OPTIONS']

backup delete ['OPTIONS'] BACKUP_NAME

backup get ['OPTIONS'] BACKUP_NAME

backup ls

backup restore ['OPTIONS'] BACKUP_PATH

backup create -n example-backup
example-backup という名前ですべてのコンテナーコンテンツのバックアップを開始します。

backup create -d /some/server/dir
すべてのコンテナーコンテンツのバックアップを開始し、サーバーのパス /some/server/dir に保存します。

backup create --caches=* --templates=*
キャッシュとキャッシュ設定リソースのみを含むバックアップを開始します。

backup create --proto-schemas=schema1,schema2
指定されたスキーマリソースのみを含むバックアップを開始します。

backup ls
サーバーで使用可能なすべてのバックアップを一覧表示します。

backup get example-backup
example-backup アーカイブをサーバーからダウンロードします。バックアップ操作が進行中の場合、コマンドはバックアップ操作が完了するのを待ちます。

backup restore /some/path/on/the/server
サーバー上のバックアップアーカイブからすべてのコンテンツを復元します。

backup restore -u /some/local/path
サーバーにアップロードされたローカルバックアップアーカイブからすべてのコンテンツを復元します。

backup restore /some/path/on/the/server --caches=*
サーバー上のバックアップアーカイブからキャッシュコンテンツのみを復元します。

backup restore /some/path/on/the/server --proto-schemas=schema1,schema2
サーバー上のバックアップアーカイブから、指定されたスキーマリソースのみを復元します。

backup delete example-backup
example-backup アーカイブをサーバーから削除します。

drop(1)

benchmark - キャッシュに対してパフォーマンスベンチマークを実行します。

HTTP および HotRod プロトコル http、https、hotrod、および hotrods のパフォーマンスベンチマークを実行できます。URI を使用してベンチマークのプロトコルを指定します。プロトコルを指定しない場合、ベンチマークは現在の CLI 接続の URI を使用します。

Hot Rod URI のベンチマークは、クラスター全体に接続します。HTTP URI の場合、ベンチマークは単一のノードにのみ接続します。

ベンチマークは、既存のキャッシュに対してパフォーマンスをテストします。ベンチマークを実行する前に、測定する機能を備えたキャッシュを作成する必要があります。たとえば、クロスサイトレプリケーションのパフォーマンスを評価する場合は、バックアップの場所を持つキャッシュを作成する必要があります。永続性のパフォーマンスをテストする場合は、適切なキャッシュストアを使用するキャッシュを作成します。

benchmark ['OPTIONS'] [uri]

benchmark hotrod://localhost:11222
HotRod プロトコルを使用してベンチマークテストを実行します。

benchmark --value-size=10000 --cache=largecache hotrod://localhost:11222
サイズが 10000 バイトのテスト値を使用して、largecache キャッシュに対して HotRod プロトコルでベンチマークテストを実行します。

benchmark --mode=All --threads=20 https://user:password@server:11222
20 スレッドを使用して HTTPS プロトコルでベンチマークテストを実行し、レポートにすべてのモードを含めます。

cache - 後続のコマンドのデフォルトキャッシュを選択します。

cache ['CACHE_NAME']

cache mycache
mycache を選択ます。cd caches/mycache を使用してリソースツリーをナビゲートするのと同じです。

cd(1)、clear(1)、container(1)、get(1)、put(1)、remove(1)

cas - 強力なカウンターで'compare-and-swap'操作を実行します。

cas ['OPTIONS'] ['COUNTER_NAME']

cas --expect=10 --value=20 cnt_a
現在の値が 10 の場合にのみ、cnt_a の値を 20 に設定します。

add(1)、cas(1)、reset(1)

cd - サーバーリソースツリーをナビゲートします。

PATH は、絶対パスまたは現在のリソースに対する相対パスです。../ は親リソースを指定します。

cd ['PATH']

cd caches
リソースツリーの caches パスに変更します。

cache(1)、ls(1)、container(1)

clearcache - キャッシュからすべてのエントリーを削除します。

clearcache ['CACHE_NAME']

clearcache mycache
mycache からすべてのエントリーを削除します。

cache(1)、drop(1)、remove(1)

config - CLI 設定プロパティーを管理します。

config

config set 'name' 'value'

config get 'name'

CLI 設定プロパティーを管理 (リスト、設定、取得) します。

これらのオプションは、すべてのコマンドに適用されます。

config set autoconnect-url http://192.0.2.0:11222
CLI の起動時に、カスタム IP アドレスでサーバーに接続します。

config get autoconnect-url
autoconnect-url 設定プロパティーの値を返します。

config set autoexec /path/to/mybatchfile
CLI の起動時に、"mybatchfile"という名前のバッチファイルを実行します。

config set trustall true
すべてのサーバー証明書を信頼します。

config set truststore /home/user/my-trust-store.jks
"my-trust-store.jks"という名前のキーストアのパスを指定します。

config set truststore-password secret
必要に応じて、キーストアのパスワードを設定します。

alias(1)、unalias(1)

connect - 実行中の Data Grid サーバーに接続します。

デフォルトは http://localhost:11222 で、認証が必要な場合は資格情報の入力を求められます。

connect ['OPTIONS'] ['SERVER_LOCATION']

connect 127.0.0.1:11322 -u test -p changeme
100 のポートオフセットとサンプルの資格情報を使用して、ローカルで実行されているサーバーに接続します。

disconnect(1)

container - 後続のコマンドを実行するためのコンテナーを選択します。

container ['CONTAINER_NAME']

container default
デフォルトのコンテナーを選択します。これは、cd containers/default を使用してリソースツリーをナビゲートするのと同じです。

cd(1)、clear(1)、container(1)、get(1)、put(1)、remove(1)

counter - 後続のコマンドのデフォルトカウンターを選択します。

counter ['COUNTER_NAME']

counter cnt_a
cnt_a を選択します。cd counters/cnt_a を使用してリソースツリーをナビゲートするのと同じです。

add(1)、cas(1)

create - Data Grid サーバーにキャッシュとカウンターを作成します。

create cache ['OPTIONS'] CACHE_NAME

create counter ['OPTIONS'] COUNTER_NAME

create cache --template=org.infinispan.DIST_SYNC mycache
DIST_SYNC テンプレートから MyCache という名前のキャッシュを作成します。

create counter --initial-value=3 --storage=PERSISTENT --type=strong cnt_a
cnt_a という名前の強力なカウンターを作成します。

drop(1)

credentials - Data Grid Server のクレデンシャルを含むキーストアを管理します

credentials ls

credentials add 'alias'

credentials remove 'alias'

キーストア内の資格情報を一覧表示、作成、および削除します。デフォルトでは、コマンドはサーバー設定ディレクトリーの credentials.pfx キーストアを管理します。

クレデンシャルの追加

クレデンシャルの削除

credentials add dbpassword -c changeme -p "secret1234!"
資格情報キーストアがまだ存在しない場合は、新しいデフォルトの資格情報キーストアを作成し、"changeme"のパスワードに"dbpassword"のエイリアスを追加します。このコマンドはクレデンシャルキーストアのパスワードとして"secret1234!"も設定します。このパスワードは、サーバー設定のパスワード <clear-text-credential clear-text="secret1234!"/> と一致する必要があります。

credentials ls -p "secret1234!"
デフォルトのクレデンシャルキーストア内のすべてのエイリアスを一覧表示します。

credentials add ldappassword -t JCEKS -p "secret1234!"
JCEKS 形式で資格情報キーストアを作成し、エイリアス"ldappassword"を追加します。このコマンドは、エイリアスに対応するパスワードを指定するように要求します。

describe - リソースに関する情報を表示します。

describe ['PATH']

describe //containers/default
デフォルトのコンテナーに関する情報を表示します。

describe //containers/default/caches/mycache
mycache キャッシュに関する情報を表示します。

describe //containers/default/caches/mycache/k1
k1 キーに関する情報を表示します。

describe //containers/default/counters/cnt1
cnt1 カウンターに関する情報を表示します。

cd(1)、ls(1)

disconnect - Data Grid サーバーとの CLI セッションを終了します。

disconnect

disconnect
現在の CLI セッションを終了します。

connect(1)

drop - キャッシュとカウンターを削除します。

drop cache CACHE_NAME

drop counter COUNTER_NAME

drop cache mycache
mycache キャッシュを削除します。

drop counter cnt_a
cnt_a カウンターを削除します。

create(1)、clearcache(1)

encoding - キャッシュエントリーのエンコーディングを表示および設定します。

キャッシュに対するputおよびget操作のデフォルトのエンコーディングを設定します。引数が指定されていない場合、encodingコマンドは現在のエンコーディングを表示します。

有効なエンコーディングでは、次のような標準の MIME タイプ (IANA メディアタイプ) の命名規則が使用されます。

encoding ['ENCODING']

encoding application/json
エントリーを application/json としてエンコードするように、現在選択されているキャッシュを設定します。

get(1)、put(1)

get - キャッシュからエントリーを取得します。

get ['OPTIONS'] KEY

get hello -c mycache
mycache から hello という名前のキーの値を取得します。

query(1)、put(1)

help - コマンドのマニュアルページを出力します。

help ['COMMAND']

help get
getコマンドのマニュアルページを出力します。

version(1)

logging - Data Grid サーバーのランタイムロギング設定を検査および操作します。

logging list-loggers

logging list-appenders

logging set ['OPTIONS'] [LOGGER_NAME]

logging remove LOGGER_NAME

logging list-loggers
利用可能なすべてのロガーを一覧表示します。

logging set --level=DEBUG --appenders=FILE org.infinispan
org.infinispan ロガーのログレベルを DEBUG に設定し、FILE アペンダーを使用するように設定します。

ls - 現在のパスまたは特定のパスのリソースを一覧表示します。

ls ['PATH']

ls caches
使用可能なキャッシュを一覧表示します。

ls ../
親リソースを一覧表示します。

cd(1)

migrate - Data Grid のあるバージョンから別のバージョンにデータを移行します。

migrate cluster synchronize

migrate cluster disconnect

あるバージョンの Data Grid から別のバージョンにデータを移行するには、 migrate コマンドを使用します。

クラスターの移行

これらのオプションは、すべてのコマンドに適用されます。

patch - サーバーパッチを管理します。

サーバーパッチを一覧表示、説明、インストール、ロールバック、および作成します。

パッチは、サーバーをアップグレードして問題を解決したり、新しい機能を追加したりするためのアーティファクトを含む zip アーカイブファイルです。パッチは、異なるバージョンの複数のサーバーインストールにターゲットバージョンを適用できます。

patch ls

patch install 'patch-file'

patch describe 'patch-file'

patch rollback

patch create 'patch-file' 'target-server' 'source-server-1' ['source-server-2'…​]

patch ls
サーバーに現在インストールされているパッチをインストール順に一覧表示します。

patch install mypatch.zip
サーバーの現在のディレクトリーに"mypatch.zip"をインストールします。

patch install mypatch.zip --server=/path/to/server/home
サーバーの別のディレクトリーに"mypatch.zip"をインストールします。

patch describe mypatch.zip
"mypatch.zip"のターゲットバージョンとソースバージョンのリストを表示します。

patch create mypatch.zip 'target-server' 'source-server-1' ['source-server-2'…​]
ターゲットサーバーのバージョンを使用し、ソースサーバーのバージョンに適用する"mypatch.zip"という名前のパッチファイルを作成します。

patch rollback
サーバーに適用された最後のパッチをロールバックし、以前のバージョンを復元します。

put - キャッシュエントリーを追加または更新します。

新しいキーのエントリーを作成します。既存のキーの値を置き換えます。

put ['OPTIONS'] KEY [VALUE]

put -c mycache hello world
値が world の hello キーを mycache キャッシュに追加します。

put -c mycache -f myfile -i 500 hola
値が myfile の内容の hola キーを追加します。また、最大アイドル時間を 500 秒に設定します。

get(1)、remove(1)

query - Ickle クエリー文字列に一致するエントリーを取得します。

query ['OPTIONS'] QUERY_STRING

query "from org.infinispan.rest.search.entity.Person p where p.gender = 'MALE'"
現在選択されているキャッシュをクエリーして、性別データ型が MALE である Protobuf Person エンティティーからエントリーを返します。

schema(1)

quit - コマンドラインインターフェイスを終了します。

quit

exitとbyeはコマンドエイリアスです。

quit
CLI セッションを終了します。

exit
CLI セッションを終了します。

bye
CLI セッションを終了します。

disconnect(1)、shutdown(1)

remove - キャッシュからエントリーを削除します。

remove KEY ['OPTIONS']

remove --cache=mycache hola
mycache キャッシュから hola エントリーを削除します。

cache(1)、drop(1)、clearcache(1)

reset - カウンターの初期値を復元します。

reset ['COUNTER_NAME']

reset cnt_a
cnt_a カウンターをリセットします。

add(1)、cas(1)、drop(1)

schema - protobuf スキーマをアップロードして登録します。

schema ['OPTIONS'] SCHEMA_NAME

schema --upload=person.proto person.proto
Protobuf スキーマ person.proto を登録します。

query(1)

server - サーバー設定と状態管理。

serverコマンドは、サーバーエンドポイントコネクターとデータソースを記述および管理し、サーバーとホストの両方に関する集約された診断レポートを取得します。

レポートは、設定ファイルとログファイルに加えて、CPU、メモリー、開いているファイル、ネットワークソケットとルーティング、スレッドに関する詳細を提供します。

server report

server connector ls

server connector describe 'connector-name'

server connector start 'connector-name'

server connector stop 'connector-name'

server connector ipfilter ls 'connector-name'

server connector ipfilter set 'connector-name' --rules='[ACCEPT|REJECT]/cidr',…​

server connector ipfilter clear 'connector-name'

server datasource ls

server datasource test 'datasource-name'

server report
ネットワーク、スレッド、メモリーなどに関する情報を含むサーバーレポートを取得します。

server connector ls
サーバーで使用可能なすべてのコネクターを一覧表示します。

server connector describe endpoint-default
ホスト、ポート、ローカルおよびグローバル接続、IP フィルタリングルールなど、指定されたコネクターに関する情報を表示します。

server connector stop my-hotrod-connector
クラスター全体で確立されたすべての接続をドロップするコネクターを停止します。要求を処理しているコネクターを停止しようとすると、このコマンドは拒否されます。

server connector start my-hotrod-connector
クラスター全体の接続を受け入れることができるように、コネクターを開始します。

server connector ipfilter ls my-hotrod-connector
クラスター全体のコネクターでアクティブなすべての IP フィルタリングルールを一覧表示します。

server connector ipfilter set my-hotrod-connector --rules=ACCEPT/192.168.0.0/16,REJECT/10.0.0.0/8 クラスター全体のコネクターに IP フィルタリングルールを設定します。既存のすべてのルールを置き換えます。拒否ルールの 1 つが、呼び出された接続のアドレスと一致する場合、このコマンドは拒否されます。

server connector ipfilter clear my-hotrod-connector
クラスター全体のコネクターのすべての IP フィルタリングルールを削除します。

server datasource ls
サーバー上で使用可能なすべてのデータソースを一覧表示します。

server datasource test my-datasource
データソースでテスト接続を実行します。

shutdown - 実行中のサーバーを停止するか、クラスターを正常に停止します。

shutdown server ['SERVERS']

shutdown cluster

shutdown server
CLI が接続されているサーバーを停止します。

shutdown server my_server01
ホスト名が my_server01 のサーバーを停止します。

shutdown cluster
クラスターの状態を保存し、キャッシュストアを使用する場合はエントリーを永続化し、すべてのノードを停止します。

connect(1)、disconnect(1)、quit(1)

site - バックアップの場所を管理し、サイト間のレプリケーション操作を実行します。

site status ['OPTIONS']

site bring-online ['OPTIONS']

site take-offline ['OPTIONS']

site push-site-state ['OPTIONS']

site cancel-push-state ['OPTIONS']

site cancel-receive-state ['OPTIONS']

site push-site-status ['OPTIONS']

site state-transfer-mode get|set ['OPTIONS']

site name

site view

site status --cache=mycache
mycache のすべてのバックアップ場所のステータスを返します。

site status --cache=mycache --site=NYC
mycache の NYC のステータスを返します。

site bring-online --cache=mycache --site=NYC
mycache のサイト NYC をオンラインにします。

site take-offline --cache=mycache --site=NYC
mycache のサイト NYC をオフラインにします。

site push-site-state --cache=mycache --site=NYC
キャッシュをリモートバックアップの場所にバックアップします。

site push-site-status --cache=mycache
mycache をバックアップする操作のステータスを表示します。

site cancel-push-state --cache=mycache --site=NYC
mycache を NYC にバックアップする操作をキャンセルします。

site cancel-receive-state --cache=mycache --site=NYC
NYC から状態を受信する操作をキャンセルします。

site clear-push-state-status --cache=myCache
mycache の状態をプッシュする操作のステータスをクリアします。

site state-transfer-mode get --cache=myCache --site=NYC
mycache の状態転送モードを NYC に取得します。

site state-transfer-mode set --cache=myCache --site=NYC --mode=AUTO
mycache の NYC への自動状態転送を設定します。

site name
ローカルサイトの名前を返します。クロスサイトレプリケーションが設定されていない場合、ローカルサイトの名前は常に"local"です。

site view
すべてのサイトの名前のリストを返します。クロスサイトレプリケーションが設定されていない場合は、空のリスト ("[]") を返します。

stats - リソースに関する統計を表示します。

stats ['PATH']

stats //containers/default
デフォルトのコンテナーに関する統計を表示します。

stats //containers/default/caches/mycache
mycache キャッシュに関する統計を表示します。

cd(1)、ls(1)、describe(1)

task - サーバー側のタスクとスクリプトを実行してアップロードします

task upload --file='script' 'TASK_NAME'

task exec ['TASK_NAME']

task upload --file=hello.js hello
hello.js ファイルからスクリプトをアップロードし、hello という名前を付けます。

task exec @@cache@names
使用可能なキャッシュ名を返すタスクを実行します。

task exec hello -Pgreetee=world
hello という名前のスクリプトを実行し、world の値で greetee パラメーターを指定します。

ls(1)

unalias - エイリアスを削除します。

unalias 'ALIAS-NAME'

unalias q
q エイリアスを削除します。

config(1)、alias(1)

user - プロパティーセキュリティーレルムで Data Grid ユーザーを管理します。

user ls

user create 'username'

user describe 'username'

user remove 'username'

user password 'username'

user groups 'username'

user encrypt-all

user roles ls 'principal'

user roles grant --roles='role1'[,'role2'…​] 'principal'

user roles deny --roles='role1'[,'role2'…​] 'principal'

ls、create、describe、remove、password、groups、および encrypt-all サブコマンドを使用して、プロパティーレルムのユーザーを管理します。承認にクラスターロールマッパーを使用する場合は、roles サブコマンドを使用してプリンシパルからロールへのマッピングを一覧表示および変更します。

これらのオプションは、すべてのコマンドに適用されます。

version - サーバーのバージョンと CLI のバージョンを表示します。

version

version
サーバーと CLI のバージョンを返します。

help(1)