LKCLIは、LifeKeeperのGUIで操作可能な機能をコマンドラインインターフェースで実現しています。
また、GUIには無い機能として、コミュニケーションパスおよびリソース情報のexport/import機能があります。export/import機能は、作成したシステムの量産や、テスト環境から本番環境のデプロイを容易に行える手段となります。
利用可能な環境
次に示す環境で利用できます。
- DataKeeperでは最大2ード構成までのクラスター環境を利用できます。
- DRBD RKでは最大4ノード構成までのクラスター環境を利用できます。
- HANA RKでは4ノード構成のクラスター環境を利用できます。
- OS：LifeKeeper本体でサポートしているOSは、すべてを利用できます。
- コミュニケーションパス：ノード間がTCP/IPで接続されている環境のみを利用できます。
- アプリケーションリカバリーキット： ARK 一覧 に記載されたアプリケーションリカバリーキットのみで構成された環境のみを利用できます。ノード内に利用不可のARKリソースが作成されている場合、その環境は利用できません。
認定されていないの環境でのコマンドライン操作をご検討されているお客様は、「 コマンドラインインターフェイス 」の使用をご検討ください。
root以外のユーザーで実行する方法
LKCLIを実行するには、ユーザーはLifeKeeperの次の3つグループのいずれかのメンバーである必要があります：lkadmin、lkoperまたはlkguest。これらのグループについては こちら を参照ください。
root以外のユーザーでLKCLIを実行する場合は、sudoコマンドを使用して実行してください。なお、lkcliコマンドは絶対パスで指定してください。コマンド実行時にsudoコマンドを実行しているユーザーの認証が求められます。以下、LifeKeeper起動の例です。
$ sudo /opt/LifeKeeper/bin/lkcli start
LifeKeeperのsudo設定は /etc/sudoers.d/lifekeeper で行っています。もし /etc/sudoers で LifeKeeperの設定がインクルードされていない場合は、 "#includedir /etc/sudoers.d" もしくは "#include /etc/sudoers.d/lifekeeper" を /etc/sudoers に追記してください。その他にも /etc/sudoers で secure_path オプションを設定することでパスを指定したり、認証の設定を変更することができます。詳細は man sudoers(5) を参照してください。
制限事項
- ホスト名を正しく設定できていない場合、 GUIの起動やログインができません。このとき一部のlkcliコマンドは使用できますが、多くのlkcliコマンドの処理が停止します。ホスト名が正しく設定されていることを確認してください。
コマンド一覧
| lkcli license | ライセンスキーのインストール |
| lkcli start | LifeKeeperの起動 |
| lkcli stop | LifeKeeperの停止 |
| lkcli import | コミュニケーションパス、リソース作成 |
| lkcli export | コミュニケーションパス、リソース情報の出力 |
| lkcli clean | コミュニケーションパスとリソースの削除 |
| lkcli commpath | コミュニケーションパスの操作 |
| lkcli dependency | 依存関係の操作 |
| lkcli resource | リソースの操作 |
| lkcli status | リソース状態の一覧表示 |
| lkcli log | LifeKeeperのログ表示 |
| lkcli server | サーバーの設定・操作 |
| lkcli mirror | DataKeeperのミラーリング操作 |
| lkcli esxi | VMDK RKで利用するESXiホストの設定 |
| lkcli drbd | DRBDのリソース管理 |
すべてのコマンドで利用できる共通オプション
| オプション | デフォルト | 説明 |
|---|---|---|
| [--remote <str>] | コマンドを実行したいマシンのホスト名。 このオプションを指定しない場合は、ローカルマシン上で実行されます。 リモートでコマンドを実行するには、事前に実行したいマシンとコミュニケーションパスが双方向に接続されている必要があります。 なお、start、stop、commpath および clean コマンドはサポートされません。 |
lkcli license
LifeKeeperのライセンスを登録します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --file <str> | ライセンスファイルのパス |
lkcli start
LifeKeeper を起動します。
| 権限 | lkadmin |
|---|
lkcli stop
LifeKeeper を停止します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| [-f] | LifeKeeper daemonのみを停止し、保護しているサービスは停止しません。 | |
| [-r] | LifeKeeper daemonの自動起動の設定を変更せずにLifeKeeperを停止します。 | |
| [-n] | LifeKeeper daemon および保護しているサービスを停止します。シャットダウンストラテジー “Switchover Resources” に設定されている場合は待機系にフェイルオーバーします。また、/etc/default/LifeKeeperで “LKSTOP_FAILOVER_N=1” が設定されている場合は、シャットダウンストラテジーの設定にかかわらずフェイルオーバーします。 このオプションは -f, -i, -r とは併用できません。 |
|
| [-i] | LifeKeeper daemon のみを停止し、保護対象のサービスは停止しません。停止処理を続行するために 「yes/no」の確認を行う必要があります。 |
lkcli import
LifeKeeperの設定をファイルから読み込み、コミュニケーションパス、リソースを作成します。
lkcli import commpath
LifeKeeperの設定をファイルから読み込み、コミュニケーションパスを作成します。
双方向にコミュニケーションパスを接続するには、ローカルマシン・リモートマシンの双方でこのコマンドを実行し、コミュニケーションパスを作成する必要があります。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --file <str> | LifeKeeperの設定ファイルのパス。 lkcli export で出力を保存したファイル (YAML形式) からコミュニケーションパスを作成します。 作成できるコミュニケーションパスのプロトコルは、TCP/IP (ソケット) です。 |
lkcli import resource
LifeKeeperの設定をファイルから読み込み、リソースを作成します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --file <str> | LifeKeeperの設定ファイルのパス。 lkcli export で出力を保存したファイル (YAML形式) からリソースを作成します。 インポート可能なリソースタイプは、 ARK一覧 のページにリストされているARKです。 |
lkcli export
LifeKeeperの設定を出力。
現在のLifeKeeperの設定が出力され、コマンドを実行したノードとコミュニケーションパスが接続されているすべてのノードが対象となります。
出力結果をファイルにYAML形式で保存してください。
# lkcli export > lk_export.yml
| 権限 | lkadmin |
|---|
lkcli clean
LifeKeeperの設定を削除。
コマンドを実行したノードのコミュニケーションパスとリソース設定を削除します。
全てのノードのLifeKeeperの設定を削除したい場合は、すべてのノードでこのコマンドを実行してください。その際、コミュニケーションパスが削除されると、その後リモートでコマンドを実行できないのでご注意ください。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --mode <str> | all または resource を指定。
|
lkcli commpath
コミュニケーションパスの操作
lkcli commpath create
コマンドを実行したノードのコミュニケーションパスを作成。
作成されるコミュニケーションパスは、ローカルマシンからリモートマシンへのパスとなります。そのため、双方向にコミュニケーションパスを接続するには、ローカルマシン・リモートマシンの双方でこのコマンドを実行し、コミュニケーションパスを作成する必要があります。作成できるコミュニケーションパスのプロトコルは、TCP/IP (ソケット) です。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --laddr <str> | コミュニケーションパスに設定するローカルマシン上のIPアドレス。 | |
| --raddr <str> | コミュニケーションパスに設定するリモートマシン上のIPアドレス。 | |
| --dest <str> | コミュニケーションパスに設定するリモートマシンのホスト名。 | |
| [--priority <str>] | 既存のパスの最大値 +1 | コミュニケーションパスのプライオリティー。 注意: ローカルマシン・リモートマシンの双方で同一の値を指定してください。 |
lkcli commpath delete
コマンドを実行したノードのコミュニケーションパスを削除。
削除されるコミュニケーションパスは、ローカルマシンからリモートマシンへのパスとなります。そのため、双方向にコミュニケーションパスを削除するには、ローカルマシン・リモートマシンの双方でこのコマンドを実行し、コミュニケーションパスを削除する必要があります。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --laddr <str> | コミュニケーションパスに設定するローカルマシン上のIPアドレス。 | |
| --raddr <str> | コミュニケーションパスに設定するリモートマシン上のIPアドレス。 | |
| --dest <str> | コミュニケーションパスに設定するリモートマシンのホスト名。 |
lkcli dependency
LifeKeeper のリソースの依存関係を作成・削除します。
lkcli dependency create
2つのリソース間に新しく依存関係を作成します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --parent <str> | 親となるリソースのタグ名。 | |
| --child <str> | 子となるリソースのタグ名。 |
lkcli dependency delete
2つのリソース間にある依存関係を削除します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --parent <str> | 削除したい依存関係の親にあたるリソースのタグ名。 | |
| --child <str> | 削除したい依存関係の子にあたるリソースのタグ名。 |
lkcli resource
LifeKeeper のリソースを操作します。
lkcli resource create
リソースを作成します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 作成するリソースのタグ名。 存在するタグ名は、作成できません。その他については、「 リソースタグ名の制限 」を参照してください。 |
|
| [--switchback <str>] | INTELLIGENT | リソースのスイッチバック設定。 「INTELLIGENT」か「AUTOMATIC」を指定してください。 |
| ARK毎のオプション | オプションはARKによって異なります。 ARK毎のオプションに関しては、「 ARK毎のサブコマンド 」を参照してください。 |
lkcli resource extend
リソースを拡張します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 拡張するリソースのタグ名。 拡張先に存在するタグ名は、拡張できません。その他については、「 リソースタグ名の制限 」を参照してください。 |
|
| --dest <str> | リソース階層を拡張するターゲットサーバーのホスト名。 | |
| [--switchback <str>] | INTELLIGENT | リソースのスイッチバック設定。 「INTELLIGENT」か「AUTOMATIC」を指定してください。 |
| [--template_priority <num> | 1 | 拡張元のリソース階層の優先順位。 優先順位は 1 ～ 999 の範囲で未使用の値が有効で、小さい数字ほど優先順位が高くなります。 |
| [--target_priority <num>] | 10, 20, 30… | 拡張先のリソース階層の優先順位。 優先順位は 1 ～ 999 の範囲で未使用の値が有効で、小さい数字ほど優先順位が高くなります。 子リソースに依存関係が存在する場合、デフォルトは子リソースの優先順位になります。それ以外の場合、デフォルトは10、20、30などの順序で次の優先度になります。 |
| ARK毎のオプション | オプションはARKによって異なります。 ARK毎のオプションに関しては、「 ARK毎のサブコマンド 」を参照してください。 |
lkcli resource config
リソースの設定を変更します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 変更するリソースのタグ名。 | |
| ARK毎のオプション | オプションはARKによって異なります。 ARK毎のオプションに関しては、「 ARK毎のサブコマンド 」を参照してください。 |
lkcli resource unextend
リソースの拡張を解除します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 拡張を解除するリソースのタグ名。 | |
| --dest <str> | リソース階層の拡張を解除するターゲットサーバーのホスト名。 |
lkcli resource delete
リソースを削除します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 削除するリソースのタグ名。 |
lkcli resource restore
実行ノード上のリソース階層を In Service にします。
| 権限 | lkadmin, lkoper |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | In Serviceにするリソースのタグ名。 |
lkcli resource remove
実行ノード上のリソース階層をOut of Serviceにします。
| 権限 | lkadmin, lkoper |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | Out of Service にするリソースのタグ名。 |
lkcli resource info
リソースのプロパティー情報を出力します。出力内容は ARK 毎に異なります。
| 権限 | lkadmin, lkoper, lkguest |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | プロパティー情報を出力するリソースのタグ名。 |
lkcli resource eqv
リソースのイクイバレンシ情報を出力します。
| 権限 | lkadmin, lkoper, lkguest |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | イクイバレンシ情報を出力するリソースのタグ名。 |
lkcli resource reorder-priority
実行ノード上のリソースの優先順位を変更します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 優先順位を変更するリソースのタグ名。 | |
| --priority <num> | 変更後の優先順位。 優先順位は 1 ～ 999 の範囲で未使用の値が有効で、小さい数字ほど優先順位が高くなります。 |
lkcli resource switchback
実行ノード上のリソースのスイッチバック設定を変更します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | 変更するリソースのタグ名。 | |
| --switchback <str> | INTELLIGENT | リソースのスイッチバック設定。 「INTELLIGENT」か「AUTOMATIC」を指定してください。 |
lkcli status
LifeKeeper のステータスを表示します。
出力されるステータス情報は「 ステータスの詳細表示 」をご参照ください。
| 権限 | lkadmin, lkoper, lkguest |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| [-q] | ローカルシステムに存在する各リソースの情報を短いレポートで出力します。 | |
| [-e] | ローカルシステムに存在する各リソースの情報を短いレポートで出力し、（次に優先度の高い）バックアップシステムをリストします。 | |
| [-u] | -qまたは-eオプションの出力の重複リソースエントリーを抑制します。 | |
| [-r <str>] | リソースルートタグの指定。 レポートを特定のリソースルートタグに制限します。 |
lkcli log
LifeKeeperのログを表示します。
| 権限 | lkadmin, lkoper, lkguest |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --lines <num> | 10 | 表示するログの行数。 |
lkcli server
LifeKeeperのサーバーに関する操作を行います。
lkcli server info
サーバーのシャットダウン方法とフェイルオーバー機能を確認します。
| 権限 | lkadmin, lkoper, lkguest |
|---|
lkcli server shutdown-strategy
サーバーのシャットダウン方法を設定します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --mode <str> | switchover または do_not_switchover の値。
|
lkcli server confirmso
LifeKeeperクラスターのノード障害によるフェイルオーバーが発生した時、バックアップノードへの切り替えの実行に対してユーザー確認をするか設定します。
詳細については、「 [Confirm Failover] と [Block Resource Failover] の設定 」の [Confirm Failover] の項目を参照してください。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --server <str> | フェイルオーバー先のサーバー名。 | |
| --value <str> | enable または disable の値。
|
lkcli server block-failover
指定したシステムでのリソース障害に起因するフェイルオーバーをブロックする設定を行います。
詳細については、「 [Confirm Failover] と [Block Resource Failover] の設定 」の [Block Resource Failover] の項目を参照してください。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --server <str> | フェイルオーバー先のサーバー名。 | |
| --value <str> | enable または disable の値。
|
lkcli server block-all-failovers
全サーバーでノード障害とリソース障害のいずれかの障害に起因するフェイルオーバーもブロックする設定を行います。ブロックの設定を解除する場合は、次の設定を見直してください。
- ノード障害に起因するフェイルオーバーのブロック設定
- lkcli server confirmso
- /etc/default/LifeKeeper の CONFIRMSODEF パラメーター
- /etc/default/LifeKeeper の CONFIRMSOTO パラメーター
- リソース障害に起因するフェイルオーバーのブロック設定
lkcli mirror
DataKeeperによるミラーリング操作を行います。
ミラーリングの詳細については、「 SIOS DataKeeper for Linux によるミラーリング 」を参照してください。
| オプション | デフォルト | 説明 |
|---|---|---|
| --tag <str> | DataKeeperリソースのタグ名。 |
lkcli mirror status
ミラーのステータスを表示します。
| 権限 | lkadmin, lkoper, lkguest |
|---|
lkcli mirror resume
ミラーを再開します。
| 権限 | lkadmin |
|---|
lkcli mirror pause
ミラーを一時停止します。
| 権限 | lkadmin |
|---|
lkcli mirror fullresync
全体を再同期します。
| 権限 | lkadmin |
|---|
lkcli mirror force
ミラーリングを強制実行します。
| 権限 | lkadmin |
|---|
lkcli esxi
VMDK RKを利用するときのESXiホストの設定を行います。
VMDK RKの詳細については「 VMDK as Shared Storage Recovery Kit管理ガイド 」を、ESXiホストの設定については「 ESXiホストの登録 」や「 メンテナンス 」を参照してください。
lkcli esxi add
ESXiホストの情報を追加します。オプションでユーザー名とパスワードを指定しない場合は対話的にユーザー名・パスワードを入力することになります。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --host <host> | 追加するESXiホスト名。 | |
| [--user <user>] | ESXiホストにログインするときのユーザー名。 | |
| [--password <password>] | ESXiホストにログインするときのパスワード。 |
lkcli esxi list
登録されているESXi ホストの一覧を表示します。
| 権限 | lkadmin, lkoper, lkguest |
|---|
lkcli esxi update
登録されているESXiホストの情報を更新します。オプションでユーザー名とパスワードを指定しない場合は対話的にユーザー名・パスワードを入力することになります。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --host <host> | 更新するESXiホスト名。 | |
| [--user <user>] | ESXiホストにログインするときのユーザー名。 | |
| [--password <password>] | ESXiホストにログインするときのパスワード。 |
lkcli esxi delete
登録されているESXiホストの情報を削除します。
| 権限 | lkadmin |
|---|
| オプション | デフォルト | 説明 |
|---|---|---|
| --host <host> | 削除するESXiホスト名。 |
このトピックへフィードバック