Oracle Traffic DirectorのWebLogic Scripting Toolの概要

1 Oracle Traffic DirectorのWebLogic Scripting Toolの概要

WebLogic Scripting Tool (WLST)は、Oracle Traffic Director構成およびインスタンスを作成、管理および監視するために使用できるコマンドライン・スクリプト環境です。WLSTは、Javaのスクリプト・インタプリタであるJythonに基づいています。WLSTは、ローカル変数、条件変数およびフロー制御文などのJythonの標準機能に対するサポートに加えて、Oracle Traffic Directorに固有の一連のスクリプト機能(コマンド)も提供します。次のようにwlst.shを実行して、WLSTを起動できます。

cd ORACLE_HOME/oracle_common/common/bin
./wlst.sh

ORACLE_HOMEは、インストール時に指定したOracleホーム・ディレクトリです。

注意:

12.2.1.4.0で、Oracle Traffic Directorは非推奨になりました。将来、同等の機能を実現するには、Oracle HTTP Server、Microsoft IIS Web ServerまたはApache HTTP Serverプラグインか、TraefikなどのネイティブKubernetesロード・バランサを使用してください。

このガイドでは、Oracle Traffic Directorを構成および管理するためにサポートされているカスタムWLSTコマンドをすべて定義します。

リリース11gからの変更点

Oracle Traffic Directorの管理は共通管理モデル(CAM)上で構築されるようになりました。CAMでは、Oracle HTTP ServerやOracle Traffic Directorなどのシステム・コンポーネントがWebLogicドメインに含まれます。Oracle Traffic Director管理サーバーは必要ありません。Oracle WebLogic Serverをインストールし、Oracle WebLogicドメインを作成し、Oracle WebLogic管理サーバーを使用してOracle Traffic Directorを管理する必要があります。

WLSTは、リリース11gのOracle Traffic Directorのtadmコマンドラインと同等です。コマンドはスタンドアロン・モードではなくスクリプト・モードでのみ実行できます。コマンドはWLSTのカスタム・コマンド機能として解釈され、ハイフンでつながれず、otd_MixedCaseCommandNameというパターンに従います。たとえば、リリース11gのcreate-configコマンドはotd_createConfigurationになります。

12cでの変更

次の表に、12cで変更された11gのコマンドを示します

11gのコマンド	12cのコマンド	コメント
	Oracle Traffic Directorドメインが含まれるディレクトリへのパス	必須。
	Oracle Traffic Directorインスタンスの名前。	必須。

使用モード

次の技術を使用して、Oracle Traffic Directorのカスタム・コマンドを呼び出すことができます。これらのモードのWLSTの使用の詳細は、WebLogic Scripting Tool Guideの理解の対話モード、スクリプト・モードおよび組込みモードに関する項を参照してください。

対話モード

対話モードでは、WLSTスクリプト・シェルは、WebLogic Serverのインスタンスとの永続的な接続を維持します。Oracle Traffic Directorコマンドを入力し、コマンドライン・プロンプトでレスポンスを表示できます。

# Launch wlst.sh
<oracle_home>/otd/common/bin/wlst.sh
 
# Connect to WLS admin server
> connect('weblogic', 'password',"t3://localhost:7001")
 
# Execute an OTD command - list existing configurations
> otd_listConfigurations()
['origin-server-1', 'test', 'origin-server-2', 'origin-server-3']
 
# Execute another command - get http properties of configuration 'test'
> props={'configuration': 'test'}
> ret = otd_getHttpProperties(props)
> print ret
{'ecid': 'true', 'unchunk-timeout': '60', 'discard-misquoted-cookies': 'true', 'max-request-headers': '64', 'favicon': 'true',
'request-body-timeout': '-1', 'request-header-buffer-size': '8192', 'etag': 'true', 'max-unchunk-size': '8192', 'io-timeout': '30',
'body-buffer-size': '1024', 'output-buffer-size': '8192', 'websocket-strict-upgrade': 'false', 'strict-request-headers': 'false',
'request-header-timeout': '30', 'server-header': None}

スクリプト・モード

スクリプトは、シェル・スクリプトと同様に、対話型入力を必要とすることなくWLSTコマンドのシーケンスを呼び出します。スクリプトは、.pyファイル拡張子の付いたテキスト・ファイルにWLSTコマンドを格納します。

組込みモード

組込みモードでは、Javaコード内でWLSTインタプリタをインスタンス化し、それを使用してWLSTコマンドおよびスクリプトを実行できます。組込みモードでOracle Traffic Directorコマンドを実行するには、次のように、環境を拡張してOracle Traffic Directorコマンドおよびライブラリを含める必要があります。

Javaクラスパスを拡張して<oracle_home>/otd/lib/admin.jarを含めます。
<oracle_home>/otd/common/wlstを指し示すようweblogic.wlstHome Javaシステム・プロパティを設定します。

例: -Dweblogic.wlstHome=<oracle_home>/otd/common/wlst

Oracle Traffic Directorコマンドを呼び出すためのJavaプログラムを作成します。

package oracle.otd.wlst;
 
import weblogic.management.scripting.utils.WLSTInterpreter;
import org.python.util.InteractiveInterpreter;
 
public class WLSTClient
{
   public static void main(String[] args)
   {
       InteractiveInterpreter interpreter = new WLSTInterpreter();
       interpreter.exec("connect('weblogic', 'weblogic1','t3://localhost:1894')");
       interpreter.exec("print otd_listConfigurations()");
   }
}

オフライン・コマンド

次のOracle Traffic Director WLSTコマンドは、Oracle Traffic Directorインスタンス/管理サーバーが構成されているホスト上で直接オフライン・モードで実行できます。

オフライン・プロビジョニング

Oracle Traffic Directorドメイン・テンプレートを使用してドメインを作成および拡張した後、次のオフライン・コマンドを使用して、管理サーバーのOracle Traffic Director構成およびインスタンスを作成および削除します。これらのコマンドは、管理サーバーを実行する必要はありません。管理サーバーが存在するホストでこれらのコマンドを実行します。

これらはオフライン・コマンドであるため、変更を適用するためにアクティブ化を実行する必要はありません。これらのコマンドではconfig-storeが直接操作され、変更は管理サーバーが再起動されないかぎり編集セッションに適用されないため、これらのコマンドの実行中はオープンの編集セッションがないことを確認してください。

注意:

前述のコマンドは、readDomainを使用してドメインが読み取られるまではオフライン・モードで呼び出すことはできません。変更を適用するには、コマンドの後にupdateDomainを使用してドメインを更新するようにしてください。

監視

次のコマンドは、OTDインスタンスが存在するホスト上でコマンドを直接実行することにより、インスタンスに関連する統計を監視するために使用できます。

SNMP実行時管理

次のコマンドは、マシンに対応するホスト上でコマンドを直接実行することにより、SNMPサブエージェントを開始/停止するために使用できます。

フェイルオーバー実行時管理

次のコマンドは、OTDインスタンスが存在するホスト上でコマンドを直接実行することにより、フェイルオーバーを開始/停止するために実行できます。

カスタムWLSTコマンドの使用

すべてのOracle Traffic DirectorのカスタムWLSTコマンドはすべて、関数の引数として渡されるオプション(存在する場合)とともにJython関数として実装されます。

構文

> <otd_custom_command>(props)または<otd_custom_command>()

使用するWLST

特に指示がないかぎり、コマンドは、実行中のサーバーへの接続が必要であるオンラインでのみ実行できます。オフラインとして指定されている場合、コマンドは、Oracle Traffic Directorインスタンスを構成するホスト上で直接実行できます。

Microsoft WindowsシステムでWLSTコマンドにパスを指定する場合は、二重のバックスラッシュのみでパスを指定するようにしてください。たとえば、C:\\newlineです。

引数

コマンドでは、引数を使用しないか、pythonディクショナリを引数として使用します。プロパティはすべて、pythonディクショナリ内のコマンドに名前/値のペアとして渡されますが、この場合、名前と値は両方とも文字列です。

戻り値

特に指示がないかぎり、すべてのゲッター・コマンド(otd_getX)では名前(文字列)/値(文字列)のペアとしてのプロパティとともにpythonディクショナリが返され、セッター・コマンド(otd_setX)および作成/削除ではいずれの値も返されませんが、リスト・メソッド(otd_listX)では名前(文字列)/値(文字列)のペアのpythonディクショナリのリストが返されます

エラー・メッセージ

エラーが発生した場合、すべてのコマンドで、WLSTExceptionとともに、OTD-XXXXX形式の例外メッセージIDおよび説明がスローされます。次に例を示します。

WLSTException: OTD-67853 オブジェクトが存在しません: oracle.otd.admin:type=Configuration,configuration=test1

ルート上でURIマッピングを設定解除/無効化できない

プロパティの値を設定解除するには、必ず「None」を入力してください。空の文字列のままにすると、プロパティの設定が解除されません。

コマンドのリスト

この項には、Oracle Fusion Middlewareで使用されるWLSTコマンドの機能リストが含まれます。この項を使用して、Oracle Fusion Middlewareの機能的な役割に基づいて特定のコマンドを検索できます。

プロビジョニング

同じ場所に配置されたドメインまたはスタンドアロン・ドメインをプロビジョニングするためのコマンド。

同じ場所に配置されたドメイン

次のコマンドは、同じ場所に配置されたドメインをプロビジョニングするためのコマンドです。

スタンドアロン・ドメイン

次のコマンドは、スタンドアロン・ドメインをプロビジョニングするためのコマンドです。

インスタンス管理

次に、インスタンス管理コマンドを示します。

構成デプロイメント

次に、構成デプロイメント・コマンドを示します。

構成管理

構成管理のコマンド。

構成

次に、構成コマンドを示します。

設定/チューニング

次に、設定/チューニング・コマンドを示します。

仮想サーバー管理

仮想サーバーの構成およびプロパティを管理するためのコマンド。

構成

次に、構成コマンドを示します。

設定/チューニング

次に、設定/チューニング・コマンドを示します。

TCPロード・バランサ管理

次に、TCPロード・バランサ管理用のコマンドを示します。

サーバー・プール管理

サーバー・プール管理のコマンド。

サーバー・プール

次に、サーバー・プール管理コマンドを示します。

ヘルス・チェック

次に、ヘルス・チェック・コマンドを示します。

オリジナル・サーバー

次に、オリジン・サーバー・コマンドを示します。

メンテナンス

次に、メンテナンス・コマンドを示します。

リスナー管理

リスナーを管理するためのコマンド。

HTTP

次に、HTTPリスナー・コマンドを示します。

TCP

次に、TCPリスナー・コマンドを示します。

SSLの管理

SSLを管理するためのコマンド。

証明書管理

次に、証明書管理コマンドを示します。

SSL設定

次に、SSL設定用のコマンドを示します。

暗号

次に、デフォルトで有効になる、サーバーによってサポートされている暗号を示します。

TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

次の暗号はデフォルトで無効化され、非推奨になりました。

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
SSL_RSA_WITH_3DES_EDE_CBC_SHA

ルール管理

ルール管理のコマンド。

ルート

次に、ルート・コマンドを示します。

プロキシ・キャッシュ・ルール

次に、プロキシ・キャッシュ・ルール・コマンドを示します。

リクエスト制限ルール

次に、リクエスト制限ルール・コマンドを示します。

圧縮ルール

次に、圧縮ルール・コマンドを示します。

コンテンツ・ルール

次に、コンテンツ・ルール・コマンドを示します。

Webアプリケーション・ファイアウォール(WAF)管理

Webアプリケーション・ファイアウォール(WAF)管理のコマンド。

構成

次に、設定/チューニング・コマンドを示します。

ルールセット・ファイル管理

次に、設定/チューニング・コマンドを示します。

監視

監視のコマンド。

ランタイム統計

次に、ランタイム統計の表示用のコマンドを示します。

設定/チューニング

次に、設定/チューニング監視設定用のコマンドを示します。

SNMP構成

次に、SNMP構成用のコマンドを示します。

SNMP実行時管理

次に、SNMP実行時管理用のコマンドを示します。

ロギング構成

次に、ロギング構成コマンドを示します。

フェイルオーバーの管理

次に、フェイルオーバー管理コマンドを示します。

構成

次に、構成コマンドを示します。

実行時管理

次に、実行時管理コマンドを示します。

イベント

次に、イベント・コマンドを示します。

マルチテナンシ(WebLogic Server MTあり)

WebLogic Server MT環境内でOracle Traffic Directorとともに使用するコマンド。

サービス管理

Oracle Traffic Directorインスタンスのオペレーティング・システム・サービスを作成または削除するために使用するコマンド。