ssh-broker-ctl

ssh-broker-ctl — SSH Tectia Connection Broker 制御ユーティリティ

書式

ssh-broker-ctl command
[options...]

説明

ssh-broker-ctl (Windows では ssh-broker-ctl.exe) は、Connection Broker (ssh-broker-g3) のための制御ユーティリティです。これを使用すると、たとえば、Connection Broker の状態を表示したり、Connection Broker を再設定または停止したり、秘密鍵をメモリにロードしたりすることができます。

オプション

以下の一般的なオプションが使用できます。

-a, --broker-address ADDRESS

接続を確立する対象の個別の SSH Tectia Connection Broker プロセスのアドレスを定義します。

環境変数 SSH_SECSH_BROKER を使用して Connection Broker のアドレスを定義することによって、同じ効果を実現できます。

-D, --debug LEVEL

デバッグレベルを定義します。

-e, --charset=CS

出力で使用される文字セットを定義します。サポートされる文字セットは、utf8、iso-8895-1、latin1、iso-8859-15、latin9、および ascii です。

-q, --quiet

コマンドに応じて、少量の出力を表示するか、またはまったく表示しないことを定義します。

-s, --short

より短く、マシンで読み取りやすい出力形式を使用することを定義します。

--time-format=FMT

出力で使用される時刻の形式を定義します。デフォルトの形式は、システムロケールの設定によって異なります。

-v, --verbose

詳細情報 (使用可能な場合) を出力することを定義します。

-V, --version

バージョン文字列を表示します。

-w, --wide

行が長くなっても、出力を切り捨てないことを定義します。

-h, --help

コマンドラインオプションに関する状況依存のヘルプテキストを表示します。ヘルプはまた、特定のコマンドでも取得できます。たとえば、status コマンドに関するヘルプを取得するには、以下のコマンドを実行します。

ssh-broker-ctl status --help

コマンド

ssh-broker-ctl は、以下のコマンドを受け入れます。

add-key

新しい秘密鍵を追加します。

close-channel channel-id ...

定義されたチャネルを閉じます。また、複数のチャネルを閉じるために複数のチャネル ID を入力することもできます。

close-connection connection-id ...

定義された接続を閉じます。また、複数の接続を閉じるために複数の接続 ID を入力することもできます。

connection-status [--show-channels] [--write-hostkey=FILE] connection-ID

接続 ID の詳細な接続状態を表示します (数値識別子はコマンド list-connections によって示されます)。

オプション:

--show-channels: チャネル情報を表示します。
--write-hostkey=FILE: ホスト鍵 (公開鍵または x509 証明書) を定義されたファイルに書き込みます。

debug [--append] [--clear] [--log-file=FILE] [--monitor] [debug-level]

Connection Broker のデバッグレベルを定義されたレベルに設定します。ここに debug-level パラメータが指定されていない場合、現在のデバッグレベルは変更されません。

オプション:

--append: 追加モードでログファイルを開きます。
--clear: デバッグの設定をクリアします。開いているログファイルをすべて閉じ、デバッグレベルを 0 に設定します。
--log-file=FILE: すべてのデバッグメッセージを定義されたファイルに書き込みます。
--monitor: stderr 内の Connection Broker のデバッグ出力を監視します。

key-passphrase [--all] [--clear] [--passphrase-file= FILE] [--passphrase-string= passphrase] key-id | key-hash

ユーザの秘密鍵のパスフレーズまたは PIN コードを入力するよう求めます。

オプション:

--all: パスフレーズが必要なすべての既知の鍵のパスフレーズを入力するよう求めます。
--clear: キャッシュされた秘密鍵データと、キャッシュされている可能性のある鍵の認証コードをクリアします。
--passphrase-file=FILE: 入力を求める代わりに、定義されたファイルからパスフレーズを読み取ります。
--passphrase-string=passphrase: パスフレーズの入力を求める代わりに、コマンドラインで指定されたパスフレーズを使用します。

list-channels [-s, --short]

現在開かれている接続チャネルと、チャネルの種類およびトラフィック統計のリストを表示します。また、接続を識別するために他のコマンドで使用されるチャネル ID も表示します。

オプション:

-s, --short: チャネルごとに 1 行の説明を表示します。

list-connections [-s, --short] [--show-channels]

現在開かれている接続と、接続パラメータおよびトラフィック統計のリストを表示します。また、接続を識別するために他のコマンドで使用される接続 ID も表示します。

オプション:

-s, --short: 接続ごとに 1 行の説明を表示します。
--show-channel: 開いているチャネルごとの簡単な説明を表示します。

list-keys [-s, --short]

ユーザの秘密鍵と、鍵の種類やサイズなどの基本的な鍵属性、および存在する可能性のあるファイル名または鍵プロバイダ情報のリストを表示します。また、鍵のフィンガープリントおよび識別子も出力します。この識別子は、秘密鍵を識別するために他の Connection Broker コマンドで使用されます。

オプション:

-s, --short: ユーザの秘密鍵ごとに 1 行の説明を表示します。

reload

Connection Broker の設定ファイルを再度読み取ります

stop

Connection Broker を停止します。

status [-s, --short] [-q, --quiet] [--pid]

パラメータを指定しない場合は、現在実行されている Connection Broker プロセスの簡単な統計および設定の概要を表示します。

オプション:

-s, --short: Connection Broker PID に関する 1 行の出力を表示します。
-q: 何も出力しません。終了状態は、Connection Broker の接続が成功した場合は 0、接続が失敗した場合は 1 です。
--pid: PID のみを表示します。

view-key [-s, --short] [-v, --verbose] [--clear] [--write-key FILE] key-id

定義された鍵に関する情報を表示します。鍵に証明書がある場合は、各証明書の簡単な概要も表示されます。

オプション:

--clear: キャッシュされた秘密鍵データと、キャッシュされた鍵の認証コードをクリアします。
-s, --short: 鍵ごとに 1 行の説明を表示します。
-v, --verbose: 鍵または証明書に関するより詳細な情報を表示します。
--write-key=FILE: 公開鍵または証明書を定義されたファイルに書き込みます。