manページ  — NGCTL

ngctl – netgraph 制御ユーティリティ

書式 解説 コマンド 診断 関連項目 歴史 作者

ngctl [-d] [-f filename] [-n nodename] [command ...]

ngctl ユーティリティは、netgraph コマンド発行に使用可能な、 socket タイプの netgraph ノードを作成します。 -f フラグを指定せず、コマンドライン上で command を指定しない場合で、 標準入力が tty であるとき、 ngctl は対話モードに入ります。そうでない場合、 ngctl は与えられたコマンド (複数可) を実行し、すぐに終了します。

ノードは、作成、削除、相互接続等が可能です。 ノードがバイナリ / ASCII 制御メッセージの変換をサポートしている場合、 そのノードに対して ASCII 形式の制御メッセージを送信可能です。

対話モードでは、 ソケットノードが受信したすべての制御メッセージとデータパケットを ngctl は表示します。 制御メッセージについては、 送出元のノードが変換をサポートしている場合には、 メッセージの引数は ASCII 形式で表示されます。

オプションは次の通りです:

-f nodeinfo
	指定したファイルからコマンドを読み込みます。 単一のダッシュは標準入力を示します。 空行および "#" から開始する行は無視されます。
-n nodename
	新規作成された netgraph ノードに nodename を割り当てます。 デフォルト名は ngctlXXX であり、 XXX はプロセス ID 番号です。
-d
	デバッグ用冗長レベルを増加します。

ngctl が現在サポートしているコマンドは次の通りです:

config     <path> のノードの設定を取得もしくは設定
connect    <relpath> のノードのフック <peerhook> を <hook> に接続
debug      デバッグ用冗長レベルを取得/設定
dot        netgraph 全体の GraphViz (.dot) を作成
help       コマンドサマリを表示または指定のコマンドのより詳細なヘルプを取得
list       全ノードの情報を表示
mkpeer     新規ノードを作成し "path" のノードへ接続
msg        "path" のノードに対して netgraph 制御メッセージを送信
name       <path> のノードへ名前 <name> を割り当て
read       ファイルからコマンドを読み込み、実行
rmhook     "path" のノードのフック "hook" を切断
show       <path> のノード情報を表示
shutdown   <path> のノードをシャットダウン
status     <path> のノードからの可読形式の状態情報を取得
types      組み込み済の全ノードタイプの情報を表示
write      データパケットを "hook" という名前のフックへ送信
quit       プログラムを終了

コマンドには別名を持つものがあります。 例えば "ls" は "list" と同じです。 "help" コマンドは、 使用可能なコマンドと、それらの用法と別名、短い解説を表示します。

The utility exits 0 on success, and >0 if an error occurs.

netgraph システムのデザインと最初の実装は、Whistle Communications, Inc.amp; で、 Whistle InterJet 向けにカスタマイズされた FreeBSD 2.2 で行われました。

Archie Cobbs <archie@whistle.com>