Cisco ACE XML ゲートウェイ インストレーション アドミニストレーションガイド Software Version 5.1
CLI の使用方法
CLI の使用方法
発行日;2012/02/07 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 597KB) | フィードバック

CLI の使用方法

CLI について

  • ACE XML アプライアンスには、ACE XML Manager のコマンドラインからさまざまな共通管理操作を実行できるようにする CLI が組み込まれています。
  • CLI が提供する機能は、システム管理用のインターフェイスである ACE XML Manager の Web コンソールで使用できる機能の一部です。CLI は、ACE XML Manager の Web コンソール環境ですでに作業を行っている場合などに Web コンソールの代わりとして使用すると、管理操作を即座に実行できるので便利です。
  • 具体的には、CLI はスクリプトから管理操作を実行するメカニズムを管理者に提供します。CLI コマンドのスクリプトを作成すると、テスト環境から実働環境へポリシーを配布するプロセスが非常に簡単になります。
  • CLI の多くのコマンドは、このプロセスを簡易化する目的で設計されています。たとえば、CLI には、ポリシーのコンパイルと配布、ポリシー アーティファクトの名前変更、証明書の置換(実働環境のセキュリティ証明書は開発またはテスト環境のものと異なることが多い)のためのコマンドが含まれています。
  • Manager ユーザが ACE XML Manager の Web コンソールでポリシーを編集するのと同時に CLI コマンドでそのポリシーが編集される可能性もあります。CLI コマンドによるポリシーの変更は、ACE XML Manager の Web コンソールの表示にすぐには反映されません。コマンドの結果を表示するには、コンソール ユーザがいったんコンソールをログアウトし、再度ログインする必要があります。CLI ユーザも含めて、複数のコンソール ユーザ間の設定の衝突を避けるために十分な注意が必要です。

コマンドの概要

  • 次の表に、ACE XML Gateway の CLI コマンドの概要を示します。
 

コマンド

説明

compile

ヘッド ポリシーにタグ付けし、それをコンパイルして、結果をコンパイル済みポリシーのディレクトリに格納します。

crl_status

Gateway にとって既知の無効な証明書を報告します。

deploy

ACE XML Manager の作業ポリシーにタグ付けし、指定の ACE XML Gateway に配布します。

exportppf

指定ファイルに現在の作業ポリシーをエクスポートします。

getdeployed

配布されたポリシーの ID を取得します。

renamecert

指定証明書の名前を変更します。

renamehandler

指定ハンドラの名前を変更します。

replacecert

指定証明書を置換します。

replacepkcs12key

PKCS12 ファイルを使用して、指定キーを置換します。

replacekeyandcert

別のキーおよび証明書ファイルを使用して指定キーを置換します。

setserverhostname

指定のバックエンド HTTP サーバを宛先とするために使用されるホスト名を変更します。

setserverport

指定のバックエンド HTTP サーバを宛先とするために使用されるポート番号を変更します。

sethttpport

指定の HTTP ポート オブジェクト(着信要求の待ち受けに使用)のポート番号を変更します。

sethttphostname

指定の HTTP ポート オブジェクト(着信要求の待ち受けに使用)のホスト名を変更します。

sethandlerloglevel

指定ハンドラのメッセージ ロギング レベルを変更します。

translate

ポリシーの形式を最新バージョンに変換します。

validity

ACE XML Manager の作業ポリシーに有効性の問題がないかどうか調べ、標準出力に報告します。

version

製品バージョンを取得します。

設定データの概要

  • ポリシーに関する作業に CLI コマンドを使用する前に、ACE XML Manager 内での設定値の保存方法を知っておくことは有益です。ポリシーは、ACE XML Gateway をトラフィックがどのように通過するかを制御する設定値を集めたものです。ポリシーには、ハンドラ、サービス記述子、アクセス ルール、およびサービス トラフィックに関連するその他の動作とルールが定義されています。
  • ACE XML アプライアンスはポリシーを 2 つの形式で保存します。
  • 作業ポリシー ― ACE XML Manager 内のポリシーの作業草案です。作業ポリシーは、コンパイルされるまで配布できません。
  • コンパイル済みポリシー ― コンパイル済みポリシーは、エラー チェックを行って、ACE XML Gateway への配布に適したランタイム形式に変換できます。
  • CLI のコマンドの多くは、そのコマンドの作用を受けるファイルストアへのパスを引数として渡す必要があります。ACE XML Manager は複数の ACE XML Gateway クラスタを管理できるので、Manager には複数のファイルストアが存在する可能性があります。
  • 作業ポリシーとコンパイル済みポリシーは、ACE XML Manager ファイルシステムの次の場所に保持されています。
  • var/lib/reactivity/console_documents/cluster<num>/filestore
  • 上記の cluster<num> はこの CLI コマンドが作用するクラスタに適したディレクトリ名です。
  • クラスタのディレクトリ名には、任意の番号の前に「cluster」というプレフィクスが付けられています。Web コンソール内で識別されるクラスタをディレクトリ名と関連付けるには、クラスタ ディレクトリ内の cluster.properties ファイルを調べます。このファイルには、ポリシーの対応先クラスタの Web コンソール名を示す名前フィールドがあります。
  • grep コマンドを使用すれば、この名前を取得できます。 /var/lib/reactivity ディレクトリから、次のコマンドを実行します。
  • grep "name=" /console_documents/*/ cluster.properties
  • このコマンドは、ポリシー内にあるクラスタ名を返します。
  • コマンド引数で渡されるパスで、 cluster<num> を、この CLI コマンドが作用するクラスタに適したディレクトリ名に置き換えます。
  • ポリシーを操作する CLI コマンドを使用する場合、ハンドラの名前変更のようにポリシーのアーティファクトを変更する操作は、作業ポリシー、つまりファイルストア内容に適用されます。CLI コマンドで実行した変更を ACE XML Manager の管理下の Gateway を通過するトラフィックに適用できるようにするには、その前に、このポリシーをコンパイルし、配布する必要があります。
  • CLI コマンドは Web コンソールと同じファイルシステム データに作用するので、アプライアンス上の同じユーザ、つまり agateway として CLI コマンドを実行する必要があります。 root ユーザとしてコマンドを実行している場合、このコマンドを実行するには、 agateway として sudo を実行しなければなりません。
  • ポリシーを修正する CLI コマンドの呼び出し時に、ACE XML Manager の Web コンソールが開いている場合、そのコマンドによる変更は、コンソールにすぐには反映されません。一般的に、CLI コマンドを使用するのは、Web コンソールが使用されていないときだけにすることを推奨します。

CLI の使用方法

  • CLI コマンドは、ACE XML アプライアンスの Bash コマンドラインから使用できます。
  • このシェルへのアクセス方法については、 bash シェルのアクセスを参照してください。
  • ACE XML アプライアンスの usr/local/reactivity ディレクトリから、次の形式で CLI コマンドを実行します。
  • # sudo -u agateway ./scripts/cli <command> <arg1> <arg2>
  • たとえば、ソフトウェアのリリース バージョンを表示するには、次のコマンドを入力します。
  • # sudo -u agateway ./scripts/cli version
  • 使用可能なコマンドのリストを表示するには、次のように入力します。
  • # sudo -u agateway ./scripts/cli
  • 特定のコマンドの使用方法に関する情報を入手するには、引数なしで次のように入力します。
  • # sudo -u agateway ./scripts/cli sethttpport

コマンド リファレンス

  • ここでは、ACE XML Gateway の CLI コマンドについて説明します。コマンドごとに、呼び出しの例と出力を示します。

version

  • ACE XML Manager ソフトウェアのバージョン番号とリリース識別番号を次の形式で出力します。
  • <version number>-<release identifier>
  • リリース識別番号はトラブルシューティングに役立ちます。カスタマー サポートに問い合わせる場合、リリース識別番号が必要になります。
  • また、リリース識別番号は、クラスタ内のすべての Gateway インスタンスのリリース番号が一致していることを確認する際にも便利です。

  • # sudo -u agateway ./scripts/cli version
  • 4.2-2005-04-09TOO

getdeployed

  • 特定の Gateway のアーカイブ ポリシーの識別番号、作者、コンパイル日を取得します。ポリシー作成者は、そのポリシーを配布した ACE XML Manager の Web コンソール ユーザです。識別番号は、ACE XML Manager が内部で生成した固有の識別番号です。
  • このコマンドを使用すると、クラスタ内のすべての ACE XML Gateway が同じポリシーを使用していることを確認できます。

形式

  • getdeployed <host> <port>

オプション

  • host は、ACE XML Gateway の IP アドレスまたはホスト名です。
  • port は、その Gateway が Manager のトラフィックを待ち受けるポート番号(デフォルトでは 8200)です。

  • # sudo -u agateway ./scripts/cli getdeployed localhost 8200

Current policy version: ee579c2426064759

Policy author: administrator

Policy compiled on: Sat May 28 19:29:21 UTC 2005

compile

  • ACE XML Manager の作業ポリシーをコンパイルし、指定した記述をタグ付けして、結果をディレクトリに格納します。
  • var/lib/reactivity/console_documents/cluster<num>/filestore
  • 上記の cluster <num> は、クラスタ ファイルストアの内部識別番号です。詳細については、設定データの概要を参照してください。
  • これは、テスト用のコマンドです。ほとんどの場合、ポリシーのコンパイルと配布を両方実行できる deploy が使用されます。

形式

  • compile <filestore> <description>

オプション

  • filestore は、コンパイルされる作業ポリシーが含まれているフォルダです。
  • description は、このバージョンのポリシーの簡単な説明です。

deploy

  • ファイルストア内の現在の作業ポリシーをコンパイルし、記述をタグ付けして、指定の Gateway に配布します。
  • CLI ベースの配布には承認要求は必要ありません。承認要求は ACE XML Manager でイネーブルにすることが可能で、Manager ベースの配布の場合に適用されます。

形式

  • deploy <filestore> <host> <port> <description>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • host は、コンパイル済みポリシーの配布先 ACE XML Gateway の IP アドレスまたはホスト名です。
  • port は、その Gateway が Manager のトラフィックを待ち受けるポート番号(デフォルトでは 8200)です。
  • description は、そのポリシーの説明です。

  • # sudo -u agateway ./scripts/cli deploy var/lib/reactivity/console_documents/cluster25233/filestore 10.0.101.72 8200 myPolicy

validity

  • 作業ポリシーに有効性の問題がないかどうか調べ、標準出力に報告します。このコマンドは、次のような問題を報告する可能性があります。
  • 証明書の期限が切れている
  • SOAP メッセージで noNamespace スキーマが使用されている
  • その他の原因でリソースがなくなっているか、または壊れている

形式

  • validity <filestore>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。

exportppf

  • 現在の作業ポリシーを PPF ファイルにエクスポートします。PPF は ACE XML Gateway の Portable Policy Format です。PPF ファイルを使用して、ポリシーをバックアップ メディアにアーカイブしたり、1 つの Manager から別の Manager にポリシーを転送したりすることができます。
  • コマンド引数として、ポリシーを書き込むファイルの名前を指定します。同じ名前のファイルがあると、そのファイルは上書きされます。
  • 出力 PPF ファイルは現在のディレクトリに書き込まれます。 scp (セキュア コピー)または ACE XML システムで使用可能な ftp クライアントを使用して、このファイルを別のマシンに移動することも可能です。

形式

  • exportppf <filestore> <outputfile>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • outputfile は、そのポリシーの書き込み先ファイルの名前です。

  • # sudo -u agateway ./scripts/cli exportppf /var/lib/reactivity/console_documents/cluster25325/filestore myPPFFilestore.ppf

crl_status

  • ACE XML Gateway の Certificate Revocation List(CRL; 証明書失効リスト)の状態を報告します。CRL には、Gateway にとって既知の無効な証明書が示されます。

形式

  • crl_status <host> <port>

オプション

  • host は、レポートを表示する ACE XML Gateway の IP アドレスまたはホスト名です。
  • port は、その Gateway が Manager のトラフィックを待ち受けるポート(通常は 8200 )です。

  • # sudo -u agateway ./scripts/cli crl_status 10.0.101.73 8200
  • <crlstatus><crl><certid>...</certid><server>10.0.101.73</server><status>Fri Jun 24 14:59:22 UTC 2005...</status></crl></crlstatus>

translate

  • ACE XML Gateway 製品にアップデートが発生した場合、変更はファイルストアの XML 形式に導入される可能性があります。通常、このような変更は、製品アップデート プロセスと PPF ファイルのインポートによって、透過的に処理されます。
  • このコマンドを使用すると、XML 形式の作業ポリシーを最新バージョンに変換する操作を明示的に実行できます。このコマンドは、主として製品アップデータとして使用されています。

形式

  • translate <filestore>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。

  • # sudo -u agateway ./scripts/translate console_documents_filestore

replacecert

  • 指定のファイルストアの証明書を別の証明書に置き換えます。証明書は、このコマンドの実行前に作業していた ACE XML Manager のファイルシステムにアップロードされている必要があります。

形式

  • replacecert <filestore> <certResourceName> <certificate>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • certResourceName は、置換する証明書リソースの識別名です。
  • certificate は、現在の証明書の代わりに使用する証明書です。

replacepkcs12key

  • PKCS12 ファイルを使用して、指定キーを置換します。このコマンドを実行する前に、作業を行っている ACE XML Manager のファイルシステムに、PKCS12 ファイルがアップロードされている必要があります。

形式

  • replacepkcs12key <filestore> <keyName> <pkcs12File> <password>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • keyName は、置換するキーの名前です。
  • pkcs12File は、現在のキーの代わりに使用するキーが格納されている PKCS12 ファイルです。
  • password は、キーを暗号化するために使用するストリングです。

replacekeyandcert

  • 別のキーおよび証明書ファイルを使用して指定キーを置換します。

形式

  • replacekeyandcert <filestore> <keyName> <keyFile> <password>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • keyName は、置換するキーの名前です。
  • keyFile は、使用する新しいキー ファイルです。
  • certFile は、使用する新しい証明書です。
  • password は、キーを暗号化するために使用するストリングです。

renamecert

  • 指定証明書の名前を変更します。

形式

  • renamecert <filestore> <oldCertName> <newCertName>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • oldCertName は、名前を変更する証明書の名前です。
  • newCertName はその証明書の新しい名前です。

renamehandler

  • 指定ハンドラの名前を変更します。ファイルストア内に同じ名前のハンドラが 2 つ以上あると、その名前のハンドラのオカレンス数を示すエラー メッセージが表示されます。

形式

  • renamehandler <filestore> <oldHandlerName> <newHandlerName>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • oldHandlerName は、名前を変更するハンドラの名前です。
  • newHandlerName は、そのハンドラの新しい名前です。

  • # sudo -u agateway ./scripts/cli renamehandler var/lib/reactivity/console_documents/cluster25233/filestore oldname newname

setserverhostname

  • 指定のバックエンド HTTP サーバのホスト名を変更します。この値は、そのサーバへの発信要求トラフィックの処理に使用されます。

形式

  • setserverhostname <filestore> <serverName> <newHost>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • serverName は変更する HTTP の名前です。これは、ACE XML Manager で使用される、そのサーバの識別名です。
  • newHost は、その HTTP サーバの新しいホスト名です。

  • # sudo -u agateway ./scripts/cli setserverhostname var/lib/reactivity/console_documents/cluster25233/filestore erpserver server2
  • Found one HTTPServer named: 'erpserver'
  • Server hostname set

setserverport

  • 指定のバックエンド HTTP サーバのポートを変更します。この値は、そのサーバへの発信要求トラフィックの処理に使用されます。

形式

  • setserverport <filestore> <serverName> <newPort>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • serverName は変更する HTTP の名前です。これは、そのポリシー内で認識されている、そのサーバの論理名です。
  • newPort は、そのサーバへのトラフィックの処理に使用される新しい HTTP ポート番号です。

  • # sudo -u agateway ./scripts/cli setserverport var/lib/reactivity/console_documents/cluster25233/filestore erpserver 81
  • Found one HTTPServer named: 'erpserver'
  • Server port set

sethttpport

  • ポート オブジェクトの HTTP ポート番号を変更します。ポート オブジェクトには、ポート番号と、その他のリスニング ポート アトリビュートが定義されており、ハンドラはこのポートで着信トラフィックを待ち受けます。

形式

  • sethttpport <filestore> <portName> <newPortNumber>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • portName は、そのポリシー内で認識されている、そのポート オブジェクトの論理名です。
  • newPortNumber は、指定のポート オブジェクトが着信トラフィックを待ち受ける新しいポート番号です。

  • # sudo -u agateway ./scripts/cli sethttpport var/lib/reactivity/console_documents/cluster25233/filestore myHandlerPort 8181
  • Found one HTTPPort named: 'myHandlerPort'
  • Port set

sethttphostname

  • sethttphostname コマンドを使用すると、ポート オブジェクトが待ち受けるホスト名を変更できます(ACE XML Manager の Web コンソールには、図13-1 と同様の設定が表示されます)。
ホスト名ポート アトリビュート
 

形式

  • sethttphostname <filestore> <portName> <newHostname>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • portName は、そのポリシー内で認識されている、そのポート オブジェクトの論理名です。
  • newHostName は、そのポート オブジェクトが着信トラフィックを待ち受ける新しいホスト名です。

  • # sudo -u agateway ./scripts/cli sethttphostname var/lib/reactivity/console_documents/cluster25233/filestore myPort docs.example.com
  • Found one HTTPPort named: 'myHandlerPort'
  • Hostname set

sethandlerloglevel

  • 指定ハンドラのメッセージ ロギング レベルを変更します。

形式

  • sethandlerloglevel <filestore> <handlerName> <level>

オプション

  • filestore は、作業ポリシーが含まれているフォルダです。詳細については、設定データの概要を参照してください。
  • handlerName は、そのポリシー内で認識されている、そのハンドラ オブジェクトの論理名です。
  • level は新しいログ レベルです。次のオプションがあります。
  • debug ― インバウンドおよびアウトバウンドのメッセージ本文を記録します。
  • full ― アウトバウンドのメッセージ本文のみを記録します。
  • stats ― 統計のみを記録し、メッセージ内容は記録しません。