前のトピック: コネクタ サーバの設定次のトピック: csfconfig コマンドの例


csfconfig Command

csfconfig コマンドを使用するためのコマンド ライン構文は以下のとおりです。

csfconfig [--help[=op]] [operation] [argument]

これらのフラグは任意の順で指定できます。 ユーザが --help 引数を使用していない場合、操作引数は必要です。

--help[=op]オプションは最小のオンライン ヘルプを提供します。 「=op」引数は、操作に必要かまたはオプションの引数をリスト表示するために使用され得ます。 たとえば、「--help=add」は、加算操作の説明を提供します。その一方で「--help」は一般情報を提供します。

ヘルプがリクエストされている場合、他の引数は無視され、リクエストはサーバに送信されません。

: ドメイン パラメータは、それが常に全体のインストールで使用されるドメインである場合、省略できます。

以下のパラメータが使用可能です。

add

新しい CS 接続オブジェクトを追加します。 名前は、1 つがユーザによって指定されなければ、この操作によって生成されます。 必要な引数: authhost、pass。 オプションの引数: authpwd、br-add、desc、domain、name、port、usetls、debug。

addspec

1 つのプロビジョニング サーバに対するブランチの特殊化を追加します。

ユーザが代替プロビジョニング サーバをインストールした場合、コネクタ サーバがこれらのすべてプロビジョニング サーバ用に使用されないことがあります。 または、さまざまなプロビジョニング サーバが、さまざまなブランチ(エンドポイント タイプまたはエンドポイント)用の同じコネクタ サーバを使用することがあります。 ブランチの特殊化は、1 つのプロビジョニング サーバに固有のブランチのリストです。 特殊化のないプロビジョニング サーバのみが、メイン CS 接続オブジェクトで指定されたブランチを使用します。 必要な引数: auth、name、server。 オプションの引数: authpwd、br-add、domain、debug。

list

CS 接続オブジェクトをすべてリスト表示します。 必要な引数: auth。 オプションの引数: authpwd、domain、debug。

modify

CS 接続オブジェクトを変更します。 必要な引数: auth、name。 オプションの引数: authpwd、br-add、br-rem、desc、domain、host、pass、port、usetls、debug。

modspec

addspec によって作成された特殊化を編集します。 必要な引数: auth、name、server。 オプションの引数: authpwd、br-add、br-rem、domain、debug。

remove

既存の CS 接続オブジェクトを削除します。 必要な引数: auth、name。 オプションの引数: authpwd、debug。

remspec

addspec によって作成された特殊化を削除します。 必要な引数: auth、name、server。 オプションの引数: authpwd、domain、debug。

modify

CS 接続オブジェクトを変更します。 必要な引数: auth、name。 オプションの引数: authpwd、br-add、br-rem、desc、domain、host、pass、port、server、tls、usetls。

show

特定の CS 接続オブジェクトを表示するか、または CS 接続オブジェクトをすべて表示します。 その出力は、コネクタ サーバのホストおよびポートを表示します(利用可能な場合)。 必要な引数: auth オプションの引数: authpwd、name、domain、debug。

各操作は、「name=value」の形式の複数の引数をとります。 スペースは「=」記号の前またはこの記号の後に許可されません。また、値にスペースが含まれる場合、引数はプラットフォーム(Windows または UNIX)用に適切に引用される必要があります。 記述されているものを除き、値は提供され、空でない必要があります。

上述したように、以下の引数が操作に使用されます。

auth=<value>

認証のためにグローバル ユーザを識別します。

値形式: 「name」(name はグローバル ユーザの名前です。)

authpwd=<value>

最初の行上にグローバル ユーザのパスワードを含むファイルを識別します。 この引数が指定されないと、ユーザはパスワードを求められます。

値形式: 任意の適切なオペレーティング システム ファイル パス。

br-add=<value>

新しいブランチ グループを追加します。 この引数は、複数のブランチを追加するために、複数回指定される場合があります。

値形式: 「[[endpoint,]endpoint type][@[domain]]」。 すべてのブランチを表すには、「@」単独のブランチを使用します。 特定のエンドポイント タイプまたはエンドポイントを識別するには、「endpoint type」または「endpoint,endpoint type」を追加します。

br-rem=<value>

既存のブランチを削除します。 この引数は、複数のブランチを削除するために、複数回指定される場合があります。

値形式: br-add について指定された形式と同じです。

debug=<value>

コマンドのトレース ログ記録をオンにします。 トレースするメッセージは、ファイル SHOME\logs\etaclientYYYYMMDD.log ファイルに書き込まれます。

値形式: 値「yes」はログ記録を有効にします。

desc=<value>

オブジェクトの任意の説明を提供します。 加算操作で指定されない場合、これがホスト引数の値のデフォルトになります。

値形式: 任意の文字列。

domain=<value>

デフォルト ドメインを定義します。 指定されない場合、認証引数で指定されたドメインがデフォルトとして使用されます。

この値のみがデフォルトになり得るので、このパラメータは常に省略できます。

host=<value>

コネクタ サーバを実行するホストの名前を定義します。

値形式: 任意の正しいホスト名または IP アドレス。

name=<value>

コネクタ サーバの名前を定義します。 Add の中で指定されなければ、csfconfig は名前を割り当てて、作成された名前を表示します。

値形式: 大文字の英語文字(A-Z)、小文字の英語文字(a-z)、数字(0-9)、ハイフン(-)、またはアンダースコア(_)から構成される、大文字と小文字を区別しない 1 字以上の文字列。

pass[=<value>]

コネクタ サーバ接続オブジェクトのパスワードが含まれるファイルを定義します。 値が指定されない場合、プロンプトが表示されます。

値形式: 任意の適切な OS ファイル パス。

重要: 指定する必要があるパスワードは、そのコネクタ サーバをインストールしたときに入力したパスワード、またはインストール後にそのコネクタ サーバシステムで pwdmgr ユーティリティを実行してユーザが変更したパスワード。

port=<value>

オブジェクトのポート番号を定義します。 これは、コネクタ サーバが接続をリスンするポートの有効な数である必要があります。

値形式: 整数。

server[=<value>]

addspec、modspec および remspec コマンドで、コネクタ サーバによってサーブされるプロビジョニング サーバの名前を定義します。 特殊化が上書きで定義されたブランチ、特定のプロビジョニング サーバについては、add または modify コマンドで CS 設定オブジェクトに定義されたブランチ。

値形式: システムのホスト名コマンドによって返される、プロビジョニング サーバが実行されているホストの名前です。

: コネクタ サーバ設定オブジェクトは、他のドメイン設定パラメータと共にプロビジョニング ディレクトリに格納されます。 プロビジョニング マネージャでコネクタ サーバ設定パラメータを直接に表示できないか、または変更できない一方で、プロビジョニング マネージャ(システム タスク、ドメイン設定ボタン)を使用して既知のプロビジョニング サーバのリストを取得できます。 リストを開くには、「Servers」パラメータ フォルダを開きます。そうすれば、既知のプロビジョニング サーバがリスト表示されます。

usetls[=<value>]

コネクタ サーバと通信するために TLS が使用されるべきかどうかを示します。 値は操作の追加に対してのみのオプションであり、その場合、「yes」がデフォルトになります。

値形式: 文字列の「yes」または「no」。

操作の追加が正常に完了すると、新しく作成された コネクタ サーバ接続オブジェクトの名前がリスト表示されます。 name パラメータがない場合、名前が生成されます。 以下に例を示します。

Created CS object with name = SA000

ほとんどの操作に対して、成功してもしなくても、ステータスおよびメッセージ(もしあれば)が表示されます。 以下に例を示します。

ホスト名、ポート番号、または TLS フラグが正常に変更されました。 ブランチ設定は正常に変更されました。

無効なコマンド ライン パラメータなどいくつかのエラーについては、ステータス コードまたはサーバ エラー メッセージが表示されません。 これらの場合で、エラーの単純なステートメントが表示されます。 以下に例を示します。

$ csfconfig add
No authentication information supplied.  
For on-line help, use "--help [=<op>]