From 8ef13b38478018dc58c41cfa7c2966099a05361f Mon Sep 17 00:00:00 2001 From: Shinya TAKEBAYASHI Date: Wed, 12 Aug 2009 11:15:14 +0900 Subject: [PATCH] Updated man pages. --- man/l7vsadm.8 | 283 ++++++++++++++++++++-------------------------------------- man/l7vsd.8 | 5 +- 2 files changed, 101 insertions(+), 187 deletions(-) diff --git a/man/l7vsadm.8 b/man/l7vsadm.8 index 4192973..d906e37 100644 --- a/man/l7vsadm.8 +++ b/man/l7vsadm.8 @@ -1,8 +1,8 @@ -.TH L7VSADM 8 "8 Dec 2008" "UltraMonkey-L7" -.SH 名前 +.TH L7VSADM 8 "12 Aug 2009" "UltraMonkey-L7" +.SH NAME .B l7vsadm -\- UltraMonkey-L7 管理コマンド -.SH 書式 +\- UltraMonkey-L7 administration tool +.SH SYNOPSIS .B l7vsadm [\-A | \-E] \-t \fIservice\-address\fR:\fIserivice\-port\fR \-m \fIproto\-module\fR [\fImodule\-args\fR] [\-s \fIscheduler\fR] [\-u \fIconnection\-count\fR] [\-b \fIsorry\-server\fR] [\-f \fIsorry\-flag\fR] [\-Q \fIQoSval\-service\fR] [\-q \fIQoSval\-clients\fR] @@ -39,288 +39,199 @@ .B l7vsadm \-h -.SH 説明 -\fBl7vsadm\fR は，UltraMonkey\-L7 の負荷分散フレームワークである \fBl7vsd\fR の制御を行うコマンドである． -.PP -各オプションを指定することで，仮想サービスの状態監視・追加・削除・変更，レプリケーション機能の開始・停止，ログレベルの動的変更を行うことができる． - -.SH コマンド +.SH DESCRIPTION +Control the virtual services, alternating logging levels and etc... .TP .B "\-A, \-\-add\-service" -仮想サービスの追加を行う．後述の \-t, \-m オプションを同時に指定する必要がある． +Add the virtual service. Must be used with \-t and \-m arguments. .TP .B "\-E, \-\-edit\-service" -現在登録されている仮想サービスの変更を行う．後述の \-t, \-m オプションを同時に指定する必要がある． +Edit the virtual service. Must be used with \-t and \-m arguments. .TP .B "\-D, \-\-delete\-service" -現在登録されている仮想サービスを削除する．後述の \-t, \-m オプションを同時に指定する必要がある． +Delete the virtual service. Must be used with \-t and \-m arguments. .TP .B "\-C, \-\-flush" -現在登録されている仮想サービスを，すべて削除する． +Flush all virtual services. .TP .B "\-a, \-\-add\-server" -仮想サービスに対してリアルサーバを追加する．\-A または \-E コマンド実行時に指定した \fIservice-address\fR:\fIserivice\-port\fR, \fIproto-module\fR を同時に指定し，\-r オプションでリアルサーバの情報を与える． +Add the real server to existing virtual service. + +.br +# l7vsadm -A -t 192.168.0.1:80 -m sessionless .br -「l7vsadm \-A \-t 192.168.0.1:80 \-m cinsert」として追加した仮想サービスに 192.168.0.100:80 のリアルサーバを追加する場合は，「l7vsadm \-a \-t 192.168.0.1:80 \-m cinsert \-r 192.168.0.100:80」を実行する． +# l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.0.100:80 .TP .B "\-e, \-\-edit\-server" -現在登録されているリアルサーバの変更を行う．\-A または \-E コマンド実行時に指定した \fIservice-address\fR:\fIserivice\-port\fR, \fIproto-module\fR を同時に指定し，\-r オプションでリアルサーバの情報を与える． -.br -「l7vsadm \-A \-t 192.168.0.1:80 \-m cinsert」として追加した仮想サービスに追加された 192.168.0.100:80 のリアルサーバの weight を 10 に変更する場合は，「l7vsadm \-e \-t 192.168.0.1:80 \-m cinsert \-r 192.168.0.100:80 \-w 10」を実行する． +Edit the real server that registered to the existing virtual service. + +.br +# l7vsadm -A -t 192.168.0.1:80 -m sessionless +.br +# l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 -w 1 +.br +# l7vsadm -e -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 -w 0 .TP .B "\-d, \-\-delete\-server" -現在登録されているリアルサーバを削除する．\-A または \-E コマンド実行時に指定した \fIservice-address\fR:\fIserivice\-port\fR, \fIproto-module\fR を同時に指定し，\-r オプションでリアルサーバの情報を与える． -.br -「l7vsadm \-A \-t 192.168.0.1:80 \-m cinsert」として追加した仮想サービスに 192.168.0.100:80 のリアルサーバを削除する場合は，「l7vsadm \-d \-t 192.168.0.1:80 \-m cinsert \-r 192.168.0.100:80」を実行する． +Delete the real server that registered to the existing virtual service. + +.br +# l7vsadm -A -t 192.168.0.1:80 -m sessionless +.br +# l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 +.br +# l7vsadm -d -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 + .TP .B "\-R, \-\-replication" -レプリケーション関連の設定変更を行う．下記のオプションを同時に指定する必要がある． +Edit replication function. This option must be using with \fB\-L\fR or \fB\-P\fR option. .TP .B "\-L, \-\-log" -ログレベルの変更を行う．\fB\-c\fR オプションを同時に指定する必要がある． +Edit logging level. Must be used with \fB\-c\fR option. .TP .B "\-P, \-\-parameter" -設定ファイルのリロードを行う． \-r オプションを同時に指定する必要がある． +Reload configuration file. Must be used with \fB\-r\fR option. .TP .B \-l, \-\-list -現在登録されている仮想サービスの一覧を表示する． +List the registered virtual services. .TP .B \-K \-\-key -現在登録されている仮想サービスの一覧を，キー情報を含んだ形式で表示する． +List the registered virtual services with keywords. .TP .B \-V, \-\-verbose -現在登録されている仮想サービスと，l7vsd および l7vsadm の各種設定値を表示する． +List the registered virtual services, keywords and settings. + .TP .B \-h \-\-help -ヘルプメッセージを表示する． +Show help messages. -.SH オプション +.SH OPTIONS .TP .B "\-t , \-\-tcp\-service \fIservice\-address\fR" -TCP サービスを作成する．\fIservice\-address\fR には，"address:port" 形式でエンドポイントとする IP アドレスとポート番号を指定する．address にはホスト名または十進表記の IP アドレスが指定可能である． +Create the TCP service. + +.br +\fIservice\-address\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME } + .TP .B "\-m , \-\-proto\-module \fIproto\-module\fR \fI[module\-args]\fR" -プロトコルモジュールを指定する．\fIproto\-module\fR の値は，\fBcinsert\fR, \fBurl\fR, \fBsslid\fR, \fBsessionless\fR のいずれかでなければならない．\fImodule\-args\fR によって，プロトコルモジュールのパラメータを設定する． +Specify the protocol module. + +.br +\fIproto\-module\fR := { url | sslid | sessionless | pfilter | ip } + +.br +\fImodule\-args\fR := see the operation manual. .TP .B "\-s, \-\-scheduler \fIscheduler\fR" -使用するスケジューラを指定する．\fIscheduler\fR の値は，\fBrr\fR, \fBlc\fR, \fBwrr\fR のいずれかでなけらばならない．\fB\-A\fR, \fB-E\fR コマンドで使用する． +Specify the scheduler module. + +.br +\fIscheduler\fR := { rr | lc | wrr } .TP .B "\-u, \-\-upper \fIconnection\-count\fR" -最大コネクション数を指定する．\fIconnection\-count\fR は 0 から 100000 の範囲で指定する．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Set up maximum connection limit. + +.br +\fIconnection\-count\fR := { 0 - 10000 } .TP .B "\-b, \-\-bypass \fIsorry\-server\fR" -アクティブなコネクション数が \fI\-u\fR オプションで指定したコネクション数に達した場合に，リクエストを転送するサーバを設定する．\fIsorry\-server\fR には，"address:port" 形式でエンドポイントとする IP アドレスとポート番号を指定する．address にはホスト名または十進表記の IP アドレスが指定可能である．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Set up sorry server. + +.br +\fIsorry\-server\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME } .TP .B "\-f, \-\-flag \fIsorry\-flag\fR" -sorry\-server へリクエストを転送するフラグをセットまたは解除する．1 または 0 を指定する．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Switch sorry server flag. When \fBsorry\-flag\fR is 0, switched off. + +.br +\fIsorry\-flag\fR := { 0 | 1 } .TP .B "\-Q, \-\-qos\-up \fIQoSVal\-up\fR" -上り（クライアントからリアルサーバ方向）の制限帯域幅を設定する．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Set QoS(client->realserver) limit. .TP .B "\-q, \-\-qos\-down \fIQoSVal\-down\fR" -下り（リアルサーバからクライアント方向）の制限帯域幅を設定する．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Set QoS(realserver->client) limit. .TP .B "\-r, \-\-real\-server \fIserver\-address\fR" -リクエストを転送するリアルサーバを設定する．\fIserver\-address\fR には，"address:port" 形式でエンドポイントとする IP アドレスとポート番号を指定する．address にはホスト名または十進表記の IP アドレスが指定可能である．\fB\-A\fR, \fB\-E\fR コマンドで使用する． +Specify the real server. + +.br +\fIsorry\-server\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME } .TP .B "\-w, \-\-weight \fIweight\fR" -リアルサーバへ振り分ける際の重みを設定する．\fB\-r\fR オプションで使用する． +Set up weight value. .TP .B "\-s , \-\-status \fIreplication\-switch\fR" -レプリケーション機能の動作を開始・停止する．\fIreplication\-switch\fR の値は，下記のいずれかでなければならない．\fB\-R\fR コマンドで使用する． -.RS -.TP -.B "start" -レプリケーション機能の動作を開始する． +Switch replication system. + +.br +\fIreplication\-switch\fR := { start | stop } -.TP -.B "stop" -レプリケーション機能を停止する． -.RE .TP .B "\-f, \-\-force" -強制的にレプリケーションを実行する．\fB\-R\fR コマンドで使用する． +Run force replication. .TP .B "\-d, \-\-dump" -レプリケーション情報を標準出力にダンプする．\fB\-R\fR コマンドで使用する． +Dump replication data area. .TP .B "\-c , \-\-category \fIlog\-category\fR" -設定を変更するログのカテゴリを指定する．\fIlog\-category\fR の値は，下記のいずれかでなければならない． -.RS -.TP -.B "l7vsd_network, nw" -ネットワーク関連すべて - -.TP -.B "l7vsd_network.bandwidth, nw.bw" -ネットワーク関連（帯域幅関連のみ） - -.TP -.B "l7vsd_network.num_connection, nw.conn" -ネットワーク関連（コネクション数のみ） - -.TP -.B "l7vsd_network.qos, nw.qos" -ネットワーク関連（QoS 関連のみ） - -.TP -.B "l7vsd_virtual_service, vs" -仮想サービス関連 - -.TP -.B "l7vsd_real_server, rs" -リアルサーバ関連すべて - -.TP -.B "l7vsd_real_server.balancing, rs.bal" -リアルサーバ関連（ロードバランス関連のみ） - -.TP -.B "l7vsd_sorry_server, sorry" -Sorry サーバ関連 - -.TP -.B "l7vsd_replicatio, rep" -Replication 機能関連 - -.TP -.B "l7vsd_start_stop, stastp" -起動・終了関連 +Specify target log category. -.TP -.B "l7vsd_system, sys" -フレームワーク関連すべて - -.TP -.B "l7vsd_system.memory, sys.mem" -フレームワーク関連（メモリ管理関連のみ） - -.TP -.B "l7vsd_system.socket, sys.sock" -フレームワーク関連（ソケット関連のみ） - -.TP -.B "l7vsd_system.signal, sys.sig" -フレームワーク関連（シグナル処理関連のみ） - -.TP -.B "l7vsd_environment, env" -環境関連すべて - -.TP -.B "l7vsd_environment.parameter, env.para" -環境関連（設定ファイル関連のみ） - -.TP -.B "l7vsd_logger, logger" -ログ出力関連 - -.TP -.B "l7vsd_parameter, para" - -.TP -.B "l7vsd_event, event" -イベント管理機構関連 - -.TP -.B "l7vsd_schedule, sched" -スケジューラ関連 - -.TP -.B "l7vsd_program, prog" -本体内部処理関連 - -.TP -.B "l7vsd_protocol, prot" -プロトコルモジュール関連 - -.TP -.B "l7vsd_module, mod" -モジュール関連 - -.TP -.B "all" -すべてのログ - -.RE +.br +\fIlog\-category\fR := { l7vsd_network | l7vsd_network.bandwidth | l7vsd_network.num_connection | l7vsd_network.qos | l7vsd_virtual_service | l7vsd_real_server | l7vsd_real_server.balancing | l7vsd_sorry_server | l7vsd_replication | l7vsd_start_stop | l7vsd_system | l7vsd_system.memory | l7vsd_system.socket | l7vsd_system.signal | l7vsd_environment | l7vsd_environment.parameter | l7vsd_logger | l7vsd_parameter | l7vsd_event | l7vsd_schedule | l7vsd_program | l7vsd_protocol | l7vsd_module | all } .TP .B -l , \-\-level \fIlevel\fR -ログレベルを指定する．\fBfatal\fR, \fBerror\fR, \fBwarn\fR, \fBinfo\fR, \fBdebug\fR のいずれかでなければならない．． +Specify logging level. -.TP -.B "\-r, \-\-reload \fIreload\-parameter\fR" -リロードするセクションを指定する．\fIreload\-parameter\fR に指定する値は，下記のいずれかでなければならない． -.RS -.TP -.B "all" -すべてのセクション +.br +\fIlevel\fR := { fatal | error | warn | info | debug } .TP -.B "replication" -レプリケーションセクション +.B "\-r, \-\-reload \fIreload\-parameter\fR" -.TP -.B "replication" -logger セクション +Reload configuration file. -.RE +.br +\fIreload\-parameter\fR := { all | replication | logger } .TP .B "\-n, \-\-numeric" -ホスト名・サービスポート番号を解決せずに，IP アドレス・ポート番号で表示する．\fB\-l\fR, \fB\-K\fR, \fB\-V\fR コマンドで使用する． - - -.SH 使用方法 - -.TP -.B 192.168.0.10:80 に対して，sessionless モジュールを用いて，ラウンドロビン方式で負荷分散を行う仮想サービスを作成する場合 - -.RS -.B l7vsadm \-A \-t 192.168.0.10:80 \-m sessionless \-s rr -.RE +Don't resolve hostname and service name when listing the virtual services and real server. -.TP -.B 上記仮想サービスに対して 192.168.0.200:80 のリアルサーバを使いする場合 -.RS -.B l7vsadm \-a \-t 192.168.0.10:80 \-m sessionless \-r 192.168.0.200:80 -.RE - -.SH 関連項目 +.SH SEE ALSO .BR l7vsd (8) -.SH 注意 -本プログラムには米 F5 社が所有する米国特許 6,374,300 6,473,802 "Method and system for storing load balancing information with an HTTP cookie" の実装を含んでいるため，使用は日本国内限定とする． -.PP -Due to a possible conflict with an U.S. patent owned by F5 Networks, the use of the cookie-based persistence module included in this package is restricted to Japan. -.PP -このプログラムに関する問い合わせは，ultramonkey-l7-users@lists.sourceforge.jp 宛てにメールを送付してください． + +.SH AUTHOR +UltraMonkey-L7 Project team diff --git a/man/l7vsd.8 b/man/l7vsd.8 index 63c8a35..858573b 100644 --- a/man/l7vsd.8 +++ b/man/l7vsd.8 @@ -1,4 +1,4 @@ -.TH L7VSD 8 "25 May 2009" "UltraMonkey-L7" +.TH L7VSD 8 "12 Aug 2009" "UltraMonkey-L7" .SH NAME .B l7vsd \- UltraMonkey-L7 the load balancing framework @@ -32,3 +32,6 @@ configuration file .SH SEE ALSO .BR l7vsadm (8) + +.SH AUTHOR +UltraMonkey-L7 Project team -- 2.11.0