Expressway インターフェイス

Web インターフェースについて

このセクションでは、Expressway Web ユーザ インターフェイスと CLI および API について概要を説明します。

システム構成は通常、Web インターフェイスを通じて実行されます。 Web インターフェイスを使用するには:

  1. ブラウザ ウィンドウを開き、アドレス バーにシステムの IP アドレスまたは FQDN を入力します。

  2. 有効な管理者「ユーザー名」と「パスワード」を入力し、[ログイン(Login)] をクリックします (管理者アカウントの設定の詳細については、ユーザーアカウントのセクションを参照してください)。 概要 ページが表示されます。

Expressway のセキュリティ証明書に関する警告メッセージが表示された場合は、システムのセキュリティ保護の準備ができるまでこれを無視できます。

フィールドマーカー

  • 赤い星印 は必須項目です

  • オレンジ色のシンボル は、クラスタ内の各ピアで設定する必要があるフィールドを示します。

サポートされるブラウザ

Expressway Web インターフェイスは、Microsoft Edge、Firefox、Chrome 向けに設計され、テストされています。 ユーザ インターフェイスにアクセスするために他のブラウザーを使用することは、公式にはサポートされていません。

Expressway Web インターフェイスを使用するには、JavaScript と Cookie を有効にする必要があります。

HTTP メソッド

Expressway Web サーバでは、次の HTTP メソッドが許可されます。

方法

Web UI で使用されますか?

API で使用されていますか?

次のために使用される...

GET

対応

対応

指定されたリソースからデータを取得します。 たとえば、Expressway Web インターフェイス内の特定のページを返す場合などです。

POST

対応

対応

Web リソースにデータを適用します。 たとえば、管理者が Expressway Web インターフェイスを使用して設定の変更を保存する場合などです。

OPTIONS

未対応

対応

指定された URL に対して、サーバでサポートされている HTTP メソッドを返します。 たとえば、Expressway は OPTIONS を使用して、プロキシ サーバの HTTP/1.1 準拠をテストできます。

PUT

未対応

対応

指定された URI に保存するリソースを送信します。 当社の REST API コマンドは、このメソッドを使用して Expressway の構成を変更します。

DELETE

未対応

対応

指定されたリソースを削除します。 たとえば、REST API はレコードの削除に DELETE を使用します。

API へのユーザアクセスを無効にする方法

管理者はデフォルトで API にアクセスできます。 これは次の 2 つの方法で無効にできます。

  • Expressway が高度なアカウント セキュリティ モードで実行されている場合、すべてのユーザに対して API アクセスが自動的に無効になります。

  • 個々の管理者の API アクセスは、ユーザ設定オプションを通じて無効にすることができます。

ウェブページの機能とレイアウト

このセクションでは、Expressway Web インターフェイス ページで利用可能な機能について説明します。

図 1. リストページの例
図 2. 設定ページの例

ここで示すサンプル Web ページに含まれる要素については、以下の表で説明します。

ページ要素

説明

ページ名と場所

各ページには、ページ名とそのページへのメニュー パスが表示されます。 メニュー パスの各部分はリンクになっており、上位レベルのメニュー項目をクリックするとそのページに移動します。

システムアラーム

システムアラームが発生している場合、このアイコンはすべてのページ右上隅に表示されます。 このアイコンをクリックすると、アラームに関する情報と推奨される解決策を示すアラーム ページに移動します。

ヘルプ

このアイコンは各ページの右上隅に表示されます。 このアイコンをクリックすると、表示しているページに固有のヘルプを含む新しいブラウザ ウィンドウが開きます。 ページの目的の概要を示し、ページから設定される概念を紹介します。

ログアウト

このアイコンは各ページの右上隅に表示されます。 このアイコンをクリックすると、管理者セッションが終了します。

フィールドレベルの情報

情報アイコンをクリックするか、フィールド内をクリックすると、構成ページに情報ボックスが表示されます。 このボックスには、該当する場合は有効な範囲とデフォルト値を含む、特定のフィールドに関する情報が表示されます。 情報ボックスを閉じるには、右上隅の X をクリックします。

情報バー

Expressway は、設定が保存されたときや、さらにアクションを実行する必要があるときなど、特定の状況でフィードバックを提供します。 このフィードバックは、ページ上部の黄色の情報バーに表示されます。

列の並べ替え

列見出しをクリックすると、情報が昇順または降順に並べ替えられます。

すべて選択とすべて選択解除

これらのボタンを使用して、リスト内のすべての項目を選択または選択解除します。

必須項目

入力する必要がある入力フィールドを示します。

ピア固有の構成項目

Expressway がクラスタの一部である場合、ほとんどの設定項目はクラスタ内のすべてのピアに適用されます。 ただし、 で示される項目は、各クラスタ ピアで個別に指定する必要があります。

システム情報(System Information)

現在ログインしているユーザの名前とアクセス権限、システム名 (システム名が設定されていない場合は LAN 1 IPv4 アドレス)、ローカル システム時刻、現在選択されている言語、シリアル番号、および Expressway ソフトウェア バージョンがページの下部に表示されます。


(注)  


管理者アカウントに読み取り専用権限がある場合は、構成設定を変更することはできません。


Web ユーザ インターフェースにアプリケーション メニューが表示されない

Expressway をインストールすると、ウェブ ユーザー インターフェイスに表示されるメニューは、サービス セットアップ ウィザードで選択されたサービスに合わせてカスタマイズされます。 場合によっては、選択したサービスの組み合わせに応じて、 アプリケーション メニューがインターフェースに表示されないことがあります。 このような状況が発生し、メニューを復元したい場合は、次の操作を行ってください。

  1. [ステータス] > [概要] に移動し、 [サービス セットアップを実行] をクリックして、サービス セットアップ オプションに戻ります。

  2. オプション 「サービスを選択せずに続行」 をチェックし、 「続行」をクリックします。

コマンドラインインターフェースについて

コマンド ライン インターフェイス (CLI) は、デフォルトで SSH 経由、およびアプライアンス ベースのシステムのシリアル ポート経由で利用できます。 これらの設定は、 システム管理 ページで制御されます。

CLI を使用するには

  1. SSH セッションを開始します。

  2. Expressway の IP アドレスまたは FQDN を入力します。

  3. Admin としてログインします( Adminとしてユーザ名とパスワードを入力します)。

    認証に秘密キーを使用する場合は、「 Expressway への SSH アクセスの有効化 」を参照してください。

  4. 適切なコマンドを入力して CLI の使用を開始できます。


(注)  


SSH アクセスには admin アカウントと root アカウントを使用します。 その他のローカル アカウントまたはリモート アカウントは、SSH 経由の CLI アクセスが制限されます。


コマンドの種類

コマンドは次のグループに分類されます。

  • xStatus はシステムの現在のステータスに関する情報を返します。 現在の呼び出しや登録などの情報は、このコマンド グループを通じて入手できます。 xStatus コマンドの完全なリストについては、「コマンド リファレンス - xStatus」を参照してください。

  • xConfiguration を使用すると、IP アドレスやゾーンなどのデータの単一項目を追加および編集できます。 xConfiguration コマンドの完全なリストについては、「コマンド リファレンス - xConfiguration」を参照してください。

  • xCommand これらのコマンドを使用すると、アイテムを追加および構成したり、情報を取得したりできます。 xCommand コマンドの完全なリストについては、「コマンド リファレンス - xCommand」 を参照してください。

  • xHistory は、通話と登録に関する履歴情報を提供します。

  • xFeedback は、通話や登録などのイベントが発生したときにその情報を提供します。

便利なコントロール

  • CLI に xConfiguration パスを入力すると、その要素 (および該当する場合はサブ要素) に対して現在設定されている値のリストが返されます。

  • CLI に xConfiguration パスを入力してから? を入力すると、その要素とサブ要素の使用状況に関する情報が返されます。

  • CLI に xCommand コマンドを入力すると、? の有無にかかわらず、そのコマンドの使用法に関する情報が返されます。

API について

Expressway が高度なアカウント セキュリティ モードになっているか、管理者のユーザー設定オプションで個別のアクセスが無効になっている場合を除き、管理者はデフォルトで Expressway REST API にアクセスできます。

API は、RESTful API モデリング言語 (RAML) を使用して自己文書化されています。 "『Expressway コンフィギュレーション ガイド』"ページでは、『REST API 概要ガイド』 が提供されており、ベース URL と RAML 定義にアクセスする方法がまとめられており、いくつかの要求と応答の例が示されています。

クロスサイトリクエストフォージェリ保護ヘッダー

クロスサイト リクエスト フォージェリ (CSRF) は、認証されたユーザに、現在認証されている Web アプリケーションにリクエストを送信するよう強制する攻撃です。 CSRF 攻撃は、Web アプリケーションが認証されたユーザに対して持つ信頼を悪用します。

このような攻撃を防ぐために新しいヘッダーが追加され、CSRF 保護が 有効になっているときは常に、XML Put、SOAP、および CDB Rest API リクエストとともにこのヘッダーを送信する必要があります。 CSRF ヘッダー: X-CSRF-Header を有効または無効にするコマンドについては、「リファレンス マテリアル - xConfiguration コマンド」の章を参照してください。


(注)  


CDB Rest、SOAP、または XMLPut API を呼び出すすべてのスクリプト/コードは、CSRF が有効になると、リクエスト ヘッダーの一部として「X-CSRF-Header」を送信する必要があります。


X14.2 リリース以降、これらの RAML API のいずれかを使用している場合は、POST リクエストを行うときに X-CSRF-Header というカスタム ヘッダーを追加する必要があります。 ヘッダーの値は重要ではありません。

/api/プロビジョニング/再起動

/api/プロビジョニング/共通/デフォルトリンク

/api/provisioning/controller/b2bua/microsoftinterop/restartservice

/api/provisioning/domaincerts/domain/<domain>

/api/provisioning/certs/acme/pendingcert

/api/provisioning/certs/acme/pendingcert/deploy

/api/provisioning/domaincerts/domain/<domain>/acme/pendingcert/deploy

X15.0 リリースから、CDB、XMLPut、SOAP API に CSRF 保護ヘッダーが導入されました。

クロスサイト リクエスト フォージェリ保護の無効化または有効化: X15.0.3 以降のリリースでは、CSRF 保護はデフォルトで 有効 になっています。 次のコマンドを実行して、カスタム ヘッダーを有効または無効にすることができます。

  • xConfiguration セキュリティ CSRFProtection の状態:「無効」

    詳細については、 リンクを参照してください

  • xConfiguration セキュリティ CSRFProtection 状態: "有効"

    詳細については、 リンクを参照してください。


(注)  


  • 上記以外の RAML API を使用する場合は、スクリプトに変更を加える必要はありません。

  • クライアント アプリケーション接続を受け入れるすべてのホスト API リソース (Web サービス) は、API の機能を保護し、API のデータ機密性に応じたデータへのアクセスを保護するために、認証と承認を使用する必要があります。

    以前の API アクセスはデフォルトで「有効」でしたが、現在は「無効」になっています。


ハードウェアプラットフォームでサポートされるソフトウェアバージョン

表 1. このリリースでサポートされる Expressway プラットフォーム

プラットフォーム名

シリアル番号

ソフトウェアバージョンのサポート範囲

小規模 VM (OVA)

(自動生成)

X8.1 以降

中規模 VM (OVA)

(自動生成)

X8.1 以降

大規模 VM (OVA)

(自動生成)

X8.1 以降

CE1300 ハードウェア

(UCS C220 M6S には Expressway がプリインストールされています)

52E5####

X14.3.1 以降

CE1200 ハードウェア リビジョン 2 (UCS C220 M5L にプリインストール)

52E1####

X12.5.5 以降

CE1200 ハードウェア リビジョン 1 (UCS C220 M5L にプリインストール)

52E0####

X8.11.1 以降

CE1100 (UCS C220 M4L にプリインストールされた Expressway)

52D#####

サポートなし(X12.5.x 以降)、ただしメンテナンスとバグ修正のみを目的とした X12.6.x バージョンでの制限付きサポートを除く。

CE1000 (UCS C220 M3L にプリインストールされた Expressway)

52B#####

サポートされていません (X8.10.x 以降)。 注記を参照してください。

CE500 (UCS C220 M3L にプリインストールされた Expressway)

52C#####

サポートされていません (X8.10.x 以降)。 注記を参照してください。


(注)  


これは、製造中止およびサポートが終了したアプライアンスに適用されます。 サポート終了日を過ぎたハードウェアの場合: ハードウェアの問題やソフトウェアの問題 (BIOS、ファームウェア、ドライバーなどのハードウェアに組み込まれたソフトウェアを含む) についてはサポートされません。