名称

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

書式

ngctl

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

解説

ngctl ユーティリティは、netgraph コマンドを発行するために使用できる、タイプ socket の新しい netgraph ノードを作成します。 -f フラグが与えられず、コマンドがコマンド行に提供されず、標準入力が 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       Assign name <name> to the node at <path> 
name       <path>でノードに名前 <name>を割り当て 
read       Read and execute commands from a file 
read       ファイルからコマンドを読み込み、実行 
rmhook     "path"のノードのフック "hook"を切断 
show       <path>でノードに関する情報を表示 
shutdown   <path>でノードをシャットダウン 
status     <path>でノードから人間に読み込み可能な状態情報を取得 
types      すべてのインストールされたノードのタイプに関する情報を表示 
write      "hook"によって指定されたフックにデータパケットを送信 
quit       プログラムを終了

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

終了ステータス

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

関連項目

netgraph(3), netgraph(4), nghook(8)

歴史

netgraph システムは、Whistle InterJet のためにカスタマイズされた FreeBSD 2.2 のバージョンで Whistle Communications, Inc. において設計され、最初に実装されました。

作者

Archie Cobbs <archie@whistle.com>