LKCLI は、LifeKeeper の GUI で操作可能な機能をコマンドラインインターフェースで実現しています。
また、GUI には無い機能として、コミュニケーションパスおよびリソース情報の export/import 機能があります。export/import 機能は、作成したシステムの量産や、テスト環境から本番環境のデプロイを容易に行える手段となります。

 

サポート対象

次に示す環境での使用をサポート対象としています。

  • ノード数: 2ノード構成のクラスタ環境のみサポートされます。
  • 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 ホストの設定


すべてのコマンドで利用できる共通オプション

オプション デフォルト 説明
[--remote <str>] コマンドを実行したいマシンのホスト名。
このオプションを指定しない場合は、ローカルマシン上で実行されます。
リモートでコマンドを実行するには、事前に実行したいマシンとコミュニケーションパスが双方向に接続されている必要があります。
なお、startstopcommpath および clean コマンドはサポートされません。


lkcli license

LifeKeeper のライセンスを登録します。

 権限  lkadmin
オプション デフォルト 説明
--file <str> ライセンスファイルのパス


lkcli start

LifeKeeper を起動します。

 権限  lkadmin


lkcli stop

LifeKeeper を停止します。

 権限  lkadmin
オプション デフォルト 説明
[-f] LifeKeeper daemon のみを停止し、保護しているサービスは停止しません。
[-r] LifeKeeper daemon の自動起動の設定を変更せずに LifeKeeper を停止します。
[-n] LifeKeeperの停止と共に、フェイルオーバーが実行されます。
このオプションは -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 一覧 を参照してください。


lkcli export

LifeKeeper の設定を出力。
現在の LifeKeeper の設定が出力され、コマンドを実行したノードとコミュニケーションパスが接続されているすべてのノードが対象となります。
出力結果をファイルに YAML 形式で保存してください。

# lkcli export > lk_export.yml

 権限  lkadmin


lkcli clean

LifeKeeper の設定を削除。
コマンドを実行したノードのコミュニケーションパスとリソース設定を削除します。
全てのノードの LifeKeeper の設定を削除したい場合は、すべてのノードでこのコマンドを実行してください。その際、コミュニケーションパスが削除されると、その後リモートでコマンドを実行できないのでご注意ください。

 権限  lkadmin
オプション デフォルト 説明
--mode <str> all または resource を指定。
  • 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 拡張先のリソース階層の優先順位。
優先順位は 1 ~ 999 の範囲で未使用の値が有効で、小さい数字ほど優先順位が高くなります。
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 の値。
  • switchover : LifeKeeper は、正常なシャットダウンでバックアップサーバーのリソースを起動します。
  • do_not_switchover : LifeKeeper は、正常なシャットダウンではバックアップサーバーのリソースを起動しません。

lkcli server confirmso

LifeKeeper クラスタのノード障害によるフェイルオーバーが発生した時、バックアップノードへの切り替えの実行に対してユーザー確認をするか設定します。
詳細については、「 [Confirm Failover] と [Block Resource Failover] の設定 」の [Confirm Failover] の項目を参照してください。

 権限  lkadmin
オプション デフォルト 説明
--server <str> フェイルオーバー先のサーバー名。
--value <str> enable または disable の値。
  • enable : フェイルオーバー時のユーザー確認を有効にします。
  • disable : フェイルオーバー時にユーザー確認をしません。

lkcli server block-failover

指定したシステムでのリソース障害に起因するフェイルオーバーをブロックする設定を行います。
詳細については、「 [Confirm Failover] と [Block Resource Failover] の設定 」の [Block Resource Failover] の項目を参照してください。

 権限  lkadmin
オプション デフォルト 説明
--server <str> フェイルオーバー先のサーバー名。
--value <str> enable または disable の値。
  • enable : 指定サーバーへのフェイルオーバーをブロックします。
  • disable : 指定サーバーへのフェイルオーバーをブロックしません。

lkcli server block-all-failovers

全サーバーでノード障害とリソース障害のいずれかの障害に起因するフェイルオーバーもブロックする設定を行います。ブロックの設定を解除する場合は、次の設定を見直してください。



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 ホスト名。

フィードバック

フィードバックありがとうございました

このトピックへフィードバック

送信