xsadmin ユーティリティー・リファレンス

xsadmin ユーティリティーには、コマンド行引数を使用する方式、 またはプロパティー・ファイルを使用する方式で、引数を渡すことができます。

xsadmin 引数

xsadmin ユーティリティー用の プロパティー・ファイルは、WebSphere® eXtreme Scale クライアント、バージョン 7.1 フィックス 1 以上で定義できます。プロパティー・ファイルを作成すると、ユーザー名などの使用頻度の高い引数の一部を 保存できます。プロパティー・ファイルに追加できるプロパティーは、次の 表のとおりです。 プロパティー・ファイル内のプロパティーとそれに相当するコマンド行引数を 両方指定した場合、コマンド行引数値がプロパティー・ファイルの値に優先します。

表 1. xsadmin ユーティリティーの引数
コマンド行引数 プロパティー・ファイル内で相当するプロパティー名 説明と有効な値
-bp n/a

リスナー・ポートを指示します。

デフォルト:2809

-ch n/a

カタログ・サーバーの JMX ホスト名を指示します。

デフォルト:localhost

-clear n/a

指定されたマップをクリアします。

使用できるフィルター: -fm

-containers n/a データ・グリッドおよびマップ・セットのそれぞれについて、コンテナー・サーバーの リストを表示します。

使用できるフィルター: -fnp

-continuous n/a データ・グリッドをモニターするためにマップ・サイズの結果を継続的に表示させたい場合は、このフラグを指定してください。 -mapsizes 引数を指定してこのコマンドを実行すると、20 秒ごとに マップ・サイズが表示されます。
-coregroups n/a カタログ・サーバーのすべてのコア・グループを 表示します。この引数は、拡張診断に使用されます。
-dismissLink <catalog_service_domain> n/a

このコマンド行引数は、WebSphere DataPower® XC10 アプライアンス構成には適用されません。

-dmgr n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

-empties n/a 出力に空のコンテナーを表示する場合、このフラグを指定します。
-establishLink <foreign_domain_name> <host1:port1,host2:port2...> n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

-fc n/a このコンテナーのみにフィルタリングします。
WebSphere Application Server Network Deployment 環境でコンテナー・サーバーをフィルタリングする場合は、次の形式を使用します。
<cell_name>/<node_name>/<serverName_containerSuffix>

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec

-fh n/a このホストのみにフィルタリングします。

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec-routetable

-fm n/a このマップのみにフィルタリングします。

この形式を指定できる引数: -clear-mapsizes

-fnp n/a プライマリー断片を持たないサーバーをフィルタリングします。

この形式を指定できる引数: -containers

-fp n/a この区画のみにフィルタリングします。

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec-routetable

-fs n/a このサーバーのみにフィルタリングします。
WebSphere Application Server Network Deployment 環境でアプリケーション・サーバーをフィルタリングする場合は、次の形式を使用します。
<cell_name>/<node_name>/<server_name>

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec

-fst n/a この断片タイプのみにフィルタリングします。プライマリー断片のみの場合は P を、 非同期レプリカ断片のみの場合は A を、同期レプリカ断片のみの場合は S を指定します。

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec

-fz n/a このゾーンのみにフィルタリングします。

この形式を指定できる引数: -mapsizes-teardown-revisions-getTraceSpec-setTraceSpec-getStatsSpec-setStatsSpec-routetable

-force n/a いずれのプリエンプティブなプロンプトも無効にして、コマンド内の アクションを強制します。この引数はバッチ・コマンドを実行するときに便利です。
-g n/a ObjectGrid 名を指定します。
-getstatsspec n/a 現在の統計仕様を表示します。統計仕様は、-setstatsspec 引数で設定できます。

使用できるフィルター: -fst -fc -fz -fs -fh -fp

-getTraceSpec n/a 現在のトレース仕様を表示します。トレース仕様は、-settracespec 引数で設定できます。

使用できるフィルター: -fst -fc -fz -fs -fh -fp

-h n/a xsadmin ユーティリティーのヘルプを表示します。 ヘルプには引数のリストも含まれます。
-hosts n/a 構成内のすべてのホストを表示します。
-jmxUrl XSADMIN_JMX_URL JMX API コネクター・サーバーのアドレスを次の形式で 指定します: service:jmx:protocol:sapprotocol および sap 変数の定義は、 次のとおりです。
protocol
コネクター・サーバーに接続するために使用するトランスポート・プロトコルを指定します。
sap
コネクター・サーバーが検出されるアドレスを指定します。
JMX サービス URL の 形式の詳細については、Class JMXServiceURL (Java 2 Platform SE 5.0) を参照してください。
-l n/a すべての既知のデータ・グリッドとマップ・セットを表示します。
-m n/a マップ・セットの名前を指定します。
-mapsizes n/a 断片間でキーの分布が一様か確認するため、カタログ・サーバー上の 各マップのサイズを表示します。

使用できるフィルター: -fm -fst -fc -fz -fs -fh -fp

-mbeanservers n/a すべての MBean サーバー・エンドポイントのリストを表示します。
-overridequorum n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

-password XSADMIN_PASSWORD xsadmin ユーティリティーにログインするためのパスワードを指定します。 パスワードを保護する必要がある場合、プロパティー・ファイル内にパスワードは 指定しないでください。
-p n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

  n/a 構成内の構成されている配置とランタイムの配置を 表示します。出力の有効範囲はデータ・グリッドとマップ・セットの組み合わせにしたり、 構成全体にしたりできます。
  • 構成全体:
    -placementStatus
  • 特定のデータ・グリッドの場合:
    -placementStatus -g my_grid
  • 特定のマップ・セットの場合:
    -placementStatus -m my_mapset
  • 特定のデータ・グリッドとマップ・セットの場合:
    -placementStatus  -g my_grid 
    -m my_mapset
-primaries n/a プライマリー断片のリストを表示します。
-profile n/a xsadmin ユーティリティー用のプロパティー・ファイルへの 完全修飾パスを指定します。
-quorumstatus n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

-releaseShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a -reserveShard 引数と一緒に使用されます。-releaseShard 引数は、断片が予約されて配置された後に呼び出されます。-releaseShard 引数は、ContainerMBean.release() メソッドを呼び出します。
-reserved n/a -reserveShard 引数によって予約された断片のみを表示するために -containers 引数と一緒に使用されます。
-reserveShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a プライマリー断片を指定されたコンテナー・サーバーに移動します。この引数によって、ContainerMBean.reserve() メソッドが呼び出されます。

-resumeBalancing <objectgrid_name> <map_set_name>

n/a 要求のバランスを取ることを試みます。指定された ObjectGrid とマップ・セットの将来の再バランシング試行を可能にします。
-revisions n/a カタログ・サービス・ドメインの改訂 ID を表示します。これには、特定の断片ごとの各データ・グリッド、区画番号、区画タイプ (基本またはレプリカ)、カタログ・サービス・ドメイン、存続期間 ID、およびデータ改訂の回数が含まれます。 この引数を使用して、非同期レプリカまたはリンクされたドメインがキャッチアップされたかどうかを判別できます。 この引数は、ObjectGridMBean.getKnownRevisions() メソッドを呼び出します。

使用できるフィルター: -fst -fc -fz -fs -fh -fp

-routetable n/a クライアント・サーバーの観点から、データ・グリッドの現在の状態を表示します。 経路テーブルは、ObjectGrid クライアント・サーバーがデータ・グリッドとの通信に使用する情報です。接続問題または TargetNotAvailable 例外を特定する場合に、診断援助として経路テーブルを使用します。

必須引数: スタンドアロン環境では、カタログ・サーバー・ホストのブートストラップ・リスナー・ポートおよび JMX ポートにデフォルト値を使用していない場合、この引数と一緒に -bp パラメーターおよび -p パラメーターを指定しなければなりません。

使用できるフィルター: -fz -fh -fp

-settracespec <trace_string> n/a

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。アプライアンスのトレースの構成について詳しくは、WebSphere DataPower XC10 アプライアンス ログ・ファイルの操作を参照してください。

使用できるフィルター: -fst -fc -fz -fs -fh -fp

-swapShardWithPrimary <container_server_name> <objectgrid_name> <map_set_name> <partition_name>

n/a 指定されたコンテナー・サーバーからの指定されたレプリカ断片を、プライマリー断片と交換します。このコマンドを実行することで、必要なときに手動でプライマリー断片をバランシングできます。
-setstatsspec <stats_spec> n/a 統計の収集を有効にします。この引数は、DynamicServerMBean.setStatsSpec メソッドと DynamicServerMBean.getStatsSpec メソッドを呼び出します。

使用できるフィルター: -fm -fst -fc -fz -fs -fh -fp

-suspendBalancing <objectgrid_name> <map_set_name>

n/a 指定された ObjectGrid およびマップ・セットの将来のバランシング試行をさせません。
-ssl n/a Secure Sockets Layer (SSL) が有効なことを示します。
-teardown n/a

使用できるフィルター: -fst -fc -fz -fs -fh -fp

サーバーのリストを指定する場合の形式:
server_name_1,server_name_2 ...
特定ゾーン内のすべてのサーバーを停止する場合、-fz 引数を組み込みます。
–fz <zone_name>
特定ホスト上のすべてのサーバーを停止する場合、-fh 引数を組み込みます。
–fh <host_name>

このコマンド行引数は、WebSphere DataPower XC10 アプライアンス構成には適用されません。

  n/a デプロイメント XML ファイルに構成されている numInitialContainers の値を 無視して、断片配置の実行を強制します。 サーバーのメンテナンスを実行中、この引数を使用すると、numInitialContainers の値が構成値より小さい場合でも 断片配置の実行を続行できるようになります。
-trustPass XSADMIN_TRUST_PASS 指定したトラストストアのパスワードを指定します。
-trustPath XSADMIN_TRUST_PATH トラストストア・ファイルへのパスを指定します。

例: etc/test/security/server.public

-trustType XSADMIN_TRUST_TYPE トラストストアのタイプを指定します。

有効値: JKS、JCEK、PKCS12 など。

-unassigned n/a データ・グリッド上に配置できない断片のリストを 表示します。配置サービスに配置を妨げる制約があると、断片は 配置できません。
-username XSADMIN_USERNAME xsadmin ユーティリティーにログインするためのユーザー名を指定します。
-v n/a 詳細コマンド行アクションを使用可能にします。 環境変数、プロパティー・ファイル、またはその両方を使用して特定のコマンド行引数を指定し、それらの 値を表示する必要がある場合、このフラグを使用します。
-xml n/a PlacementServiceMBean.listObjectGridPlacement() メソッドからのフィルタリングされていない出力を表示します。他の xsadmin 引数は、このメソッドの出力をフィルタリングし、データをさらに消費可能な形式に編成します。