ライブラリ・バージョン12.1.3.0

ユーティリティのコマンド
前 | 付録A KVStoreコマンド・リファレンス | 次

## ユーティリティのコマンド

`"java -jar"`を介してユーティリティのコマンドにアクセスできます。

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar <command>

この付録ではコマンドに関する次の情報が示されます。

### makebootconfig

    java -Xmx256m -Xms256m
    -jar KVHOME/lib/kvstore.jar makebootconfig [-verbose]
    -root <rootDirectory> -host <hostname> -harange <startPort,endPort>
    -store-security [none | configure | enable]
    -port <port> [-admin <adminPort>] [-runadmin] [-config <configFile>]
    [-storagedir <directory path>] [-capacity <n_rep_nodes>]
    [-num_cpus <ncpus>][-memory_mb <memory_mb>]
    [-servicerange <startPort,endPort>]
    [-hahost <haHostname>]
    [-secdir <security dir>] [-pwdmgr {pwdfile | wallet | <class-name>}]
    [-kspwd <password>] [-param <param=value>]*
    [-mgmt {snmp|jmx|none}] [-pollport <snmp poll port>]
    [-traphost <snmp trap/notification hostname>]
    [-trapport <snmp trap/notification port>]

説明:

- `-admin <adminPort>`: Webベースの管理コンソールがアクセスされるポートです。これは、管理プロセスが実行されるノードでのみ空いている必要があります。値のデフォルトは"0"です。つまり、このノードには管理は存在しなくなります。

- `-capacity <n_rep_nodes>`: ストレージ・ノードがサポートできるレプリケーション・ノードの総数です。値のデフォルトは"1"です。

- `-config <configFile>`: 複数のストレージ・ノード・エージェント・プロセスが同じルート・ディレクトリを共有する場合のみ指定します。この値のデフォルトは"config.xml"です。

- `-hahostname <hostname>`: ストア・レプリケーション・トラフィックの個別のネットワーク・インタフェースを指定するために使用できます。この値のデフォルトは、-hostフラグを使用して指定されるホスト名です。

- `-harange <startPort,endPort>`: レプリケーション・ノードがノード間の通信に使用する空きポートの範囲です。これらのポートは連続している必要があり、少なくともこのノードに指定されたものと同じ容量が必要です。

- `-host <hostname>`: コマンドが実行されるノードに関連付けられたホスト名を識別します。このホスト名は、このノードとの通信に使用されるネットワーク・インタフェースを識別します。

- `-kspwd<password>`: スクリプトベースの構成では、このオプションを使用することで、ツールによるコマンドラインでのキーストア・パスワードの指定が可能になります。指定されていない場合、ユーザーはパスワードの入力を求められます。

- `-memory_mb <memory_mb>`: マシンで使用できるメモリー容量の合計数(MB単位)です。値が0の場合、ストアはマシン上のメモリー量のを特定を試みますが、その値が特定できるのは、使用されるJVMがOracle Hotspot JVMの場合のみです。デフォルト値は"0"です。

- `-num_cpus <ncpus>`: レプリケーション・ノードで使用できるマシン上のプロセッサの総数です。値が0の場合、システムはストレージ・ノードに問い合せて、マシン上のプロセッサ数の特定を試みます。この値のデフォルトは"0"です。

- `-port <port>`: Oracle NoSQL DatabaseがアクセスされるTCP/IPポートです。レジストリ・ポートと呼ばれることもあります。このポートは、このコマンドが実行されるノードで空いている必要があります。

- `-pwdmgr [ pwdfile | wallet ]`

  キーストアへのアクセスなどに必要なパスワードの保持に使用されるパスワード・マネージャ・メカニズムを示します。

  ここでは、-pwdmgrに次のオプションを指定できます。

  - `-pwdmgr pwdfile`

    パスワード・ストアが読取り保護されたクリアテキストのパスワード・ファイルであることを示します。これはOracle NoSQL Database CEデプロイメントにのみ使用できるオプションです。代替実装を指定できます。

  - `-pwdmgr wallet`

    パスワード・ストレージ・メカニズムとしてOracle Walletを指定します。このオプションは、Oracle NoSQL Database EEバージョンでのみ使用できます。

- `-root <rootDirectory>`: ルート・ディレクトリが存在する場所を識別します。

- `-secdir <security dir>`

  セキュリティ構成を保持するKVROOT内のディレクトリの名前を指定します。これは、指定されたsecrootに対して相対的な名前で指定する必要があります。指定しない場合、デフォルト値は"security"です。

- `-servicerange <startPort,endPort>` ストレージ・ノードおよびその管理対象サービスで実行されている管理サービス間の通信に使用されるポートの範囲。このパラメータはオプションであり、ストレージ・ノード上のサービスがファイアウォールまたはその他のセキュリティ上の理由で特定のポートを使用する必要がある場合に役立ちます。デフォルトでは、サービスは匿名ポートを使用します。値の文字列の形式は、"startPort,endPort"です。値はストレージ・ノードの容量によって異なります。

- `-storagedir <path>`: レプリケーション・ノードに使用されるディレクトリへのパスを指定します。このフラグは、複数のストレージ・ディレクトリを指定するためにコマンド内で複数回使用できますが、その数はノードの容量を超えないようにしてください。ストレージ・ディレクトリが指定されていない場合、レプリケーション・ノードはルート・ディレクトリの下のディレクトリを使用します。

  -storagedir引数は、capacity引数と組み合せて使用する必要があります。たとえば、ストレージ・ノードが4つのディスクをホストする場合、capacityに4を指定し、4つの-storagedir引数を使用します。

- `-store-security [none | configure | enable]` セキュリティが使用されるかどうかを指定します。`-store-security none`が指定されている場合、セキュリティは使用されません。`-store-security configure`が指定されている場合、セキュリティが使用され、セキュリティ構成ユーティリティがmakebootconfigプロセスの一部として起動されます。`-store-security enable`が指定されている場合、セキュリティは使用されません。セキュリティ構成ユーティリティを使用し、または別のシステムで以前に作成した構成をコピーすることで、セキュリティを構成する必要があります。

Oracle NoSQL Databaseのインスタンスで使用される未デプロイ・ストレージ・ノードの起動に使用される構成ファイルを作成します。ファイルはまだ存在しない状態である必要があります。初期Oracle NoSQL Database管理プロセスをホストするノードでのみadminオプション(管理コンソール・ポート)を指定する必要があります。インストールの構成に使用される"boot config"初期ファイルを作成するには、「インストールの構成」を参照してください。

Oracle NoSQL Databaseでは、管理CLIおよび管理コンソールに備わるネイティブ監視に加えて、Java Management Extensions (JMX)またはSimple Network Management Protocol (SNMP)の各エージェントをオプションで監視に使用できます。ストレージ・ノードのブート構成ファイルでJMXまたはSNMPを有効にするために、-mgmt、-pollport、-traphostおよび-trapportオプションを使用できます。詳細は、「標準化されたインタフェース監視」を参照してください。

### start

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar start [-verbose]
    -root <rootDirectory> [-config <bootstrapFileName>]

Oracle NoSQL Databaseストレージ・ノード・エージェント(および構成されている場合はストア)をルート・ディレクトリで起動します。

### stop

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar stop [-verbose]
    -root <rootDirectory> [-config <bootstrapFileName>]

Oracle NoSQL Databaseストレージ・ノード・エージェントおよびルート・ディレクトリに関連付けられているサービスを停止します。

### restart

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar restart [-verbose]
    -root <rootDirectory> [-config <bootstrapFileName>]

Oracle NoSQL Databaseストレージ・ノード・エージェントおよびルート・ディレクトリに関連するサービスを停止した後、起動します。

### runadmin

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar runadmin [-verbose]
    -host <hostname> -port <port> [single command and arguments]

コマンドライン・インタフェース(CLI)を提供するユーティリティを実行します。ストア構成の実行に使用されます。

### load

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar load [-verbose]
    -source <backupDir> -host <hostname> -port <port>
    -store <storeName> -username <user> -security <security-file-path>
    [-load-admin] [-force] [-status <pathToFile>]

説明:

- `-load-admin`は、ストア・メタデータをスナップショットから新規ストアにロードします。この場合、`-source`ディレクトリは、スナップショットから管理ノードの環境ディレクトリを指す必要があります。この操作のとき、ユーザーがストアを使用できないようにする必要があります。

  ### 注意

  ストアを最初からリストアしている場合を除き、このオプションはストアで使用しないでください。`-force`を`-load-admin`と組み合せて指定した場合、ストア内の既存のメタデータは、表およびセキュリティ・メタデータを含めて上書きされます。

- `-host <hostname>`は、ストア内のノードのホスト名を識別します。

- `-port <port>`は、ストアのノードで使用されているレジストリ・ポートを識別します。

- `-security <security-file-path>`は、ログインのプロパティの指定に使用されるセキュリティ・ファイルを識別します。

- `-source <backupDir>`は、スナップショット・データが格納されているディスク上の場所を識別します。

- `-status <pathToFile>`は、ロード操作のステータスをローカル・マシンの名前付きの場所に保存するオプション・パラメータです。

- `-store <storeName>`は、ストアの名前を識別します。

- `-username <user>`は、保護されているストアにログインするためのユーザー名を識別します。

以前に作成したスナップショットからストアをリストアするために使用されるプログラムです。このツールを使用すると、スナップショットの作成時に使用されていたトポロジのみでなく、任意のトポロジにストアをリストアできます。`Load`は、新規の空のストアにリストアする場合にのみ使用します。存在しない場合にのみレコードが書き込まれるため、既存のストアにこれを使用しないでください。詳細は、「Loadプログラムの使用」を参照してください。

### ping

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar ping [-verbose]
    -host <hostname> -port <port>

ストアに接続して、実行中のサービスのステータスを取得します。`ping`コマンドを使用して、Oracle NoSQL Databaseクライアント・ライブラリがOracle NoSQL Databaseストレージ・エージェントAgent(SNA)にアクセスできることを確認できます。-hostオプションを使用して、リモート・ホストのSNAを確認できます。

### version

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar version

バージョンを出力します。

### generateconfig

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar generateconfig [-verbose]
    -host <hostname> -port <port> -sn <StorageNodeId> -target <zipfile>

指定されたストレージ・ノードの構成ファイルを生成します。generateconfigコマンドは、ストレージ・ノードの再作成に必要な構成を含むターゲットzipファイルを作成します。zipファイル内の最上位ディレクトリは、ストアのルート・ディレクトリです。

### help

    java -Xmx256m -Xms256m \
    -jar KVHOME/lib/kvstore.jar help <commandName>

使用情報を出力します。引数がない場合は最上位のシェル・コマンドが一覧表示されます。コマンド名がある場合は、追加の詳細が示されます。

前 | 先頭へ | 次
付録A KVStoreコマンド・リファレンス | ホーム | 付録B 初期容量計画