Oracle® Fusion Middleware

Oracle Traffic Director WebLogic Scripting Toolコマンド・リファレンス

12c (12.2.1.1.0)

E77303-02(原本部品番号:E71406-02)

2016年7月

Oracle Fusion Middleware Oracle Traffic Director WebLogic Scripting Toolコマンド・リファレンス, 12c (12.2.1.1.0)

E77303-02

Copyright © 2013, 2016, Oracle and/or its affiliates.All rights reserved.

原本著者: Thrupthi N.T

原本協力者: Amit Gupta、Nanada kishore、Isvaran Krishnamurthy、Mohamed kamaruddin

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

タイトルおよび著作権情報

はじめに

- 対象読者

- ドキュメントのアクセシビリティについて

- 関連ドキュメント

- 表記規則

1 Oracle Traffic DirectorのWebLogic Scripting Toolの概要

- 1.1 コマンドライン・インタフェース

- 1.2 使用モード

- 1.2.1 対話方式モード

- 1.2.2 スクリプト・モード

- 1.2.3 組込みモード

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

- 1.4 オフライン・コマンド

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

- 1.4.2 監視

- 1.4.3 SNMP実行時管理

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

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

- 1.5.1 構文

- 1.5.2 WLSTとの使用

- 1.5.3 引数

- 1.5.4 戻り値

- 1.5.5 エラー・メッセージ

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

- 1.6 コマンドのリスト

- 1.6.1 プロビジョニング

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

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

- 1.6.2 インスタンス管理

- 1.6.3 構成デプロイメント

- 1.6.4 構成管理

- 1.6.4.1 構成

- 1.6.4.2 設定/チューニング

- 1.6.5 仮想サーバー管理

- 1.6.5.1 構成

- 1.6.5.2 設定/チューニング

- 1.6.6 TCPロード・バランサ管理

- 1.6.7 サーバー・プール管理

- 1.6.7.1 サーバー・プール

- 1.6.7.2 ヘルス・チェック

- 1.6.7.3 オリジナル・サーバー

- 1.6.7.4 メンテナンス

- 1.6.8 リスナー管理

- 1.6.8.1 HTTP

- 1.6.8.2 TCP

- 1.6.8.3 ステータス

- 1.6.9 SSL管理

- 1.6.9.1 証明書管理

- 1.6.9.2 SSL設定

- 1.6.9.3 暗号

- 1.6.10 ルール管理

- 1.6.10.1 ルート

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

- 1.6.10.3 リクエスト制限ルール

- 1.6.10.4 圧縮ルール

- 1.6.10.5 コンテンツ・ルール

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

- 1.6.11.1 構成

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

- 1.6.12 監視

- 1.6.12.1 ランタイム統計

- 1.6.12.2 設定/チューニング

- 1.6.12.3 SNMP構成

- 1.6.12.4 SNMP実行時管理

- 1.6.13 ロギング構成

- 1.6.14 イベント

- 1.6.15 イベント・サブスクリプション

- 1.6.16 フェイルオーバー管理

- 1.6.16.1 構成

- 1.6.16.2 実行時管理

- 1.6.16.3 インスタンス管理

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

2 Oracle Traffic Director WLSTのコマンド

- activate

- deleteKeyStoreEntry

- displayLogs

- displayMetricTables

- enableOverwriteComponentChanges

- exportKeyStoreCertificate

- exportKeyStoreCertificateRequest

- generateKeyPair

- getKeyStoreCertificates

- 「help」

- importKeyStoreCertificate

- listExpiringCertificates

- listKeyStores

- listKeyStoreAliases

- otd_addFailoverInstance

- otd_blockProxyInfo

- otd_copyConfiguration

- otd_copyVirtualServer

- otd_createCacheRule

- otd_createCompressionRule

- otd_createConfiguration

- otd_createContentRule

- otd_createErrorPage

- otd_createEvent

- otd_createEventSubscription

- otd_createFailoverGroup

- otd_createHttpListener

- otd_createInstance

- otd_createMimeType

- otd_createOriginServer

- otd_createOriginServerPool

- otd_createRequestLimit

- otd_createRoute

- otd_createStandaloneDomain

- otd_createStandaloneInstance

- otd_createTcpListener

- otd_createTcpProxy

- otd_createConfigurationVariable

- otd_createVirtualServer

- otd_createVirtualServerVariable

- otd_deleteCacheRule

- otd_deleteCompressionRule

- otd_deleteConfigFile

- otd_deleteConfiguration

- otd_deleteConfigurationWebappFirewallRulesetFile

- otd_deleteContentRule

- otd_deleteCrl

- otd_deleteErrorPage

- otd_deleteEvent

- otd_deleteEventSubscription

- otd_deleteFailoverGroup

- otd_deleteHttpListener

- otd_deleteInstance

- otd_deleteMimeType

- otd_deleteOriginServer

- otd_deleteOriginServerPool

- otd_deleteRequestLimit

- otd_deleteRoute

- otd_deleteStandaloneInstance

- otd_deleteTcpListener

- otd_deleteTcpProxy

- otd_deleteConfigurationVariable

- otd_deleteVirtualServer

- otd_deleteVirtualServerVariable

- otd_deleteVirtualServerWebappFirewallRulesetFile

- otd_disableOriginServerPoolMaintenance

- otd_disablePerfDump

- otd_disableRequestLimitEvents

- otd_disableRouteAuth

- otd_disableRouteBandwidthLimit

- otd_disableStatsXml

- otd_disableStatusListener

- otd_disableVirtualServerAccessLog

- otd_disableWebAppFirewall

- otd_disableVirtualServerRequestBandwidthLimit

- otd_disableVirtualServerResponseBandwidthLimit

- otd_enableOriginServerPoolMaintenance

- otd_enablePerfDump

- otd_enableRequestLimitEvents

- otd_enableRouteAuth

- otd_enableRouteBandwidthLimit

- otd_enableStatsXml

- otd_enableStatusListener

- otd_enableWebAppFirewall

- otd_enableVirtualServerAccessLog

- otd_enableVirtualServerRequestBandwidthLimit

- otd_enableVirtualServerResponseBandwidthLimit

- otd_exportKeyStore

- otd_forwardProxyInfo

- otd_getAccessLogBufferProperties

- otd_getCacheProperties

- otd_getCacheRuleProperties

- otd_getCompressionRuleProperties

- otd_getConfigFile

- otd_getConfigurationAccessLogProperties

- otd_getConfigurationCrlProperties

- otd_getConfigurationProperties

- otd_getContentRuleProperties

- otd_getDnsCacheProperties

- otd_getDnsProperties

- otd_getEventProperties

- otd_getEventSubscriptionProperties

- otd_getFileCacheProperties

- otd_getFailoverGroupProperties

- otd_getHealthCheckProperties

- otd_getHttpListenerProperties

- otd_getHttpListenerSslProperties

- otd_getHttpProperties

- otd_getHttpThreadPoolProperties

- otd_getKeepaliveProperties

- otd_getLogProperties

- otd_getOriginServerPoolMaintenanceProperties

- otd_getOriginServerPoolProperties

- otd_getOriginServerProperties

- otd_getOriginServerPoolSslProperties

- otd_getPartitionAccessLogProperties

- otd_getPerfDump

- otd_getPerfDumpProperties

- otd_getRequestLimitProperties

- otd_getRouteAuthProperties

- otd_getRouteBandwidthLimitProperties

- otd_getRouteProperties

- otd_getSnmpProperties

- otd_getSslSessionCacheProperties

- otd_getStatsProperties

- otd_getStatsXml

- otd_getStatsXmlProperties

- otd_getStatusListenerProperties

- otd_getStatusListenerSslProperties

- otd_getTcpAccessLogProperties

- otd_getTcpListenerProperties

- otd_getTcpListenerSslProperties

- otd_getTcpProxyProperties

- otd_getTcpThreadPoolProperties

- otd_getVirtualServerAccessLogProperties

- otd_getVirtualServerRequestBandwidthLimitProperties

- otd_getVirtualServerResponseBandwidthLimitProperties

- otd_getVirtualServerProperties

- otd_getVirtualServerSslProperties

- otd_getWebappFirewallProperties

- otd_installConfigurationWebappFirewallRulesetFile

- otd_installCrl

- otd_installVirtualServerWebappFirewallRulesetFile

- otd_listCacheRules

- otd_listCertificates

- otd_listCompressionRules

- otd_listConfigFiles

- otd_listConfigurations

- otd_listConfigurationWebappFirewallRulesetFiles

- otd_listContentRules

- otd_listCrls

- otd_listErrorPages

- otd_listEvents

- otd_listEventSubscriptions

- otd_listFailoverGroups

- otd_listFailoverInstances

- otd_listHttpListeners

- otd_listInstances

- otd_listMimeTypes

- otd_listOriginServers

- otd_listOriginServerPools

- otd_listPartitions

- otd_listProxyInfo

- otd_listRequestLimits

- otd_listResourceGroups

- otd_listRoutes

- otd_listTcpListeners

- otd_listTcpProxies

- otd_listConfigurationVariables

- otd_listVirtualServers

- otd_listVirtualServerVariables

- otd_listVirtualServerWebappFirewallRulesetFiles

- otd_removeFailoverInstance

- otd_rotateLog

- otd_saveConfigFile

- otd_setAccessLogBufferProperties

- otd_setCacheProperties

- otd_setCacheRuleProperties

- otd_setCompressionRuleProperties

- otd_setConfigurationAccessLogProperties

- otd_setConfigurationCrlProperties

- otd_setConfigurationProperties

- otd_setContentRuleProperties

- otd_setDnsCacheProperties

- otd_setDnsProperties

- otd_setEventProperties

- otd_setEventSubscriptionProperties

- otd_setFailoverInstanceOrder

- otd_setFileCacheProperties

- otd_setHealthCheckProperties

- otd_setHttpListenerProperties

- otd_setHttpProperties

- otd_setHttpListenerSslProperties

- otd_setHttpThreadPoolProperties

- otd_setKeepaliveProperties

- otd_setLogProperties

- otd_setOriginServerPoolSslProperties

- otd_setOriginServerPoolProperties

- otd_setOriginServerProperties

- otd_setPartitionAccessLogProperties

- otd_setRequestLimitProperties

- otd_setRouteProperties

- otd_setSnmpProperties

- otd_setSslSessionCacheProperties

- otd_setStatsProperties

- otd_setStatusListenerSslProperties

- otd_setTcpAccessLogProperties

- otd_setTcpListenerProperties

- otd_setTcpListenerSslProperties

- otd_setTcpProxyProperties

- otd_setTcpThreadPoolProperties

- otd_setVirtualServerProperties

- otd_setVirtualServerSslProperties

- otd_setWalletPassword

- otd_setWebappFirewallProperties

- otd_startFailover

- otd_startSnmpSubAgent

- otd_stopFailover

- otd_stopSnmpSubAgent

- otd_toggleFailoverGroupPrimary

- pullComponentChanges

- resync/resyncAll

- showComponentChanges

- softRestart

- start

- state

- stop

- stopEdit

- undo

はじめに

このドキュメントでは、Oracle Traffic Directorを管理するために使用できるカスタムWLSTコマンドについて説明します。

対象読者

このドキュメントは、Oracle Traffic Director管理者を対象としています。このドキュメントでは、次の内容を十分に理解していると想定します。

- ソフトウェアのインストール

- ターミナル・ウィンドウでのコマンドの発行

- Oracle WebLogic Serverの管理タスク

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

サポートをご購入のOracleのお客様は、My Oracle Supportにアクセスして電子サポートを受けることができます。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info) か、聴覚に障害のあるお客様は (http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。

関連ドキュメント

詳細は、Oracle Technology Networkで入手可能な次のドキュメントを参照してください。

- Oracle Traffic Directorの管理

- Oracle Traffic Directorの構成ファイル参照

- Oracle Traffic Directorのインストール

- WebLogic Server MTの使用

表記規則

このマニュアルでは次の表記規則を使用します。

規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

イタリック体

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

1 Oracle Traffic DirectorのWebLogic Scripting Toolの概要

この章では、Oracle Traffic Directorに関連する一般的な構文、使用モード、WLST (WebLogic Scripting Tool)コマンド、共通オプション、変数、セキュリティおよびエラー・メッセージの概要について説明します。

このガイドでは、リリース12.2.1.1.0のOracle Traffic Directorを構成および管理するためにサポートされているカスタムWLSTコマンドをすべて定義します。リリース12.2.1以降、Oracle Traffic Directorの管理は共通管理モデル(CAM)上で構築されます。CAMでは、Oracle HTTP ServerやOracle Traffic Directorなどのシステム・コンポーネントがWebLogicドメインに組み込まれます。リリース11gと比べると、Oracle Traffic Director管理サーバーがなくなりました。CAMでは、Oracle WebLogicをインストールし、Oracle WebLogicドメインを作成し、Oracle WebLogic管理サーバーを使用してOracle Traffic Directorを管理する必要があります。

Oracle Traffic Directorでは、Oracle Traffic Directorの構成およびインスタンスを管理するために使用される構成MBeanを介してすべての構成タスクが公開されます。カスタムWLSTコマンドは、これらのMBeanと相互作用するラッパーです。

1.1 コマンドライン・インタフェース

Oracle Traffic Director 12.2.1.1.0のコマンドライン・インタフェースは、WLST (Weblogic Scripting Tool)です。WLSTスクリプティング環境は、Javaプラットフォーム用のPython言語の実装であるJythonに基づいています。このツールは、オンラインとオフラインの両方で使用できます。WLSTと様々なオンライン・コマンドおよびオフライン・コマンドの詳細は、『Oracle WebLogic Scripting Tool』を参照してください。Oracle Traffic Directorには、WLSTを使用して実行できるカスタムWLSTコマンドが同梱されています。

注意:
Oracle Traffic Directorには、Oracle Traffic Directorコマンドに必要な環境およびライブラリを初期化するwlst.shラッパー<oracle_home>/otd/common/bin/wlst.shが同梱されています。Oracle Traffic Directorのカスタム・コマンドはすべて、このwlst.shからのみ実行できます。

1.2 使用モード

次の技術を使用して、Oracle Traffic Directorのカスタム・コマンドを呼び出すことができます。これらのモードでのWLSTの使用に関する詳細は、『Oracle WebLogic Scripting Tool』のWebLogic Scripting Toolの使用に関する項を参照してください。

1.2.1 対話モード

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

# Launch wlst.sh
<oracle_home>/otd/common/bin/wlst.sh

# Connect to WLS admin server
> connect('weblogic', 'welcome1',"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}

1.2.2 スクリプト・モード

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

1.2.3 組込みモード

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

1. Javaクラスパスを拡張して<oracle_home>/otd/lib/admin.jarを含めます。

2. <oracle_home>/otd/common/wlstを指し示すようweblogic.wlstHome Javaシステム・プロパティを設定します。
例: -Dweblogic.wlstHome=<oracle_home>/otd/common/wlst

3. 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()");
}
}

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

リリース12.2.1以降、WLSTは、リリース11gのOracle Traffic Directorのtadmコマンドラインと同等です。リリース11gとは異なり、コマンドはスタンドアロン・モードではなくスクリプト・モードでのみ実行できます。コマンドはWLSTのカスタム・コマンド機能として解釈され、ハイフンでつながれず、otd_MixedCaseCommandNameというパターンに従います。たとえば、リリース11gのcreate-configコマンドはリリース12.2.1ではotd_createConfigurationになります。リリース12.2.1では演算子がありません。オプションはすべて、名前/値のペアとしてPythonディクショナリ内のコマンドに渡されます。

1.4 オフライン・コマンド

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

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

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

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

- otd_createConfiguration

- otd_deleteConfiguration

- otd_listConfigurations

- otd_createInstance

- otd_deleteInstance

- otd_listInstances

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

1.4.2 監視

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

- otd_getStatsXml

- otd_getPerfDump

1.4.3 SNMP実行時管理

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

- otd_startSnmpSubAgent

- otd_stopSnmpSubAgent

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

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

- otd_startFailover

- otd_stopFailover

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

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

1.5.1 構文

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

1.5.2 WLSTとの使用

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

1.5.3 引数

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

1.5.4 戻り値

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

1.5.5 エラー・メッセージ

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

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

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

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

1.6 コマンドのリスト

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

1.6.1 プロビジョニング

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

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

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

- otd_createConfiguration

- otd_deleteConfiguration

- otd_listConfigurations

- otd_createInstance

- otd_deleteInstance

- otd_listInstances

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

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

- otd_createStandaloneDomain

- otd_createStandaloneInstance

- otd_deleteStandaloneInstance

1.6.2 インスタンス管理

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

- start

- stop

- state

- softRestart

- otd_rotateLog

1.6.3 構成デプロイメント

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

- activate

- undo

- stopEdit

- showComponentChanges

- pullComponentChanges

- resync/resyncAll

- enableOverwriteComponentChanges

1.6.4 構成管理

構成管理のコマンド。

1.6.4.1 構成

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

- otd_copyConfiguration

- otd_listConfigFiles

- otd_getConfigFile

- otd_saveConfigFile

- otd_deleteConfigFile

1.6.4.2 設定/チューニング

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

- otd_setConfigurationProperties

- otd_getConfigurationProperties

- otd_setHttpProperties

- otd_getHttpProperties

- otd_setKeepaliveProperties

- otd_getKeepaliveProperties

- otd_setHttpThreadPoolProperties

- otd_getHttpThreadPoolProperties

- otd_setTcpThreadPoolProperties

- otd_getTcpThreadPoolProperties

- otd_setDnsProperties

- otd_getDnsProperties

- otd_setDnsCacheProperties

- otd_getDnsCacheProperties

- otd_setSslSessionCacheProperties

- otd_getSslSessionCacheProperties

- otd_setFileCacheProperties

- otd_getFileCacheProperties

- otd_createConfigurationVariable

- otd_deleteConfigurationVariable

- otd_listConfigurationVariables

- otd_setCacheProperties

- otd_getCacheProperties

- otd_setConfigurationCrlProperties

- otd_getConfigurationCrlProperties

- otd_installCrl

- otd_deleteCrl

- otd_listCrls

- otd_createMimeType

- otd_deleteMimeType

- otd_listMimeTypes

1.6.5 仮想サーバー管理

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

1.6.5.1 構成

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

- otd_createVirtualServer

- otd_deleteVirtualServer

- otd_listVirtualServers

- otd_listVirtualServers

1.6.5.2 設定/チューニング

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

- otd_setVirtualServerProperties

- otd_getVirtualServerProperties

- otd_createErrorPage

- otd_deleteErrorPage

- otd_listErrorPages

- otd_createVirtualServerVariable

- otd_deleteVirtualServerVariable

- otd_listVirtualServerVariables

- otd_disableVirtualServerResponseBandwidthLimit

- otd_enableVirtualServerResponseBandwidthLimit

- otd_getVirtualServerRequestBandwidthLimitProperties

- otd_disableVirtualServerRequestBandwidthLimit

- otd_enableVirtualServerRequestBandwidthLimit

- otd_getVirtualServerRequestBandwidthLimitProperties

1.6.6 TCPロード・バランサ管理

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

- otd_createTcpProxy

- otd_deleteTcpProxy

- otd_listTcpProxies

- otd_setTcpProxyProperties

- otd_getTcpProxyProperties

1.6.7 サーバー・プール管理

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

1.6.7.1 サーバー・プール

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

- otd_createOriginServerPool

- otd_deleteOriginServerPool

- otd_listOriginServerPools

- otd_getOriginServerPoolProperties

1.6.7.2 ヘルス・チェック

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

- otd_getHealthCheckProperties

- otd_setHealthCheckProperties

1.6.7.3 オリジン・サーバー

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

- otd_createOriginServer

- otd_deleteOriginServer

- otd_listOriginServers

- otd_setOriginServerProperties

- otd_getOriginServerProperties

1.6.7.4 メンテナンス

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

- otd_enableOriginServerPoolMaintenance

- otd_disableOriginServerPoolMaintenance

- otd_getOriginServerPoolMaintenanceProperties

1.6.8 リスナー管理

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

1.6.8.1 HTTP

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

- otd_createHttpListener

- otd_deleteHttpListener

- otd_listHttpListeners

- otd_setHttpListenerProperties

- otd_getHttpListenerProperties

1.6.8.2 TCP

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

- otd_createTcpListener

- otd_deleteTcpListener

- otd_listTcpListeners

- otd_setTcpListenerProperties

- otd_getTcpListenerProperties

1.6.8.3 ステータス

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

- otd_enableStatusListener

- otd_disableStatusListener

- otd_getStatusListenerProperties

- otd_getStatusListenerSslProperties

- otd_setStatusListenerSslProperties

1.6.9 SSL管理

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

1.6.9.1 証明書管理

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

- listKeyStores

- generateKeyPair

- listKeyStoreAliases

- getKeyStoreCertificates

- exportKeyStoreCertificateRequest

- importKeyStoreCertificate

- exportKeyStoreCertificate

- listExpiringCertificates

- deleteKeyStoreEntry

- otd_setWalletPassword

- otd_exportKeyStore

- otd_listCertificates

1.6.9.2 SSL設定

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

- otd_setVirtualServerSslProperties

- otd_getVirtualServerSslProperties

- otd_setHttpListenerSslProperties

- otd_getHttpListenerSslProperties

- otd_setTcpListenerSslProperties

- otd_getTcpListenerSslProperties

- otd_setOriginServerPoolSslProperties

- otd_getOriginServerPoolSslProperties

1.6.9.3 暗号

次に、サーバーによってサポートされている暗号を示します。

- SSL_RSA_WITH_RC4_128_SHA

- SSL_RSA_WITH_3DES_EDE_CBC_SHA

- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

- TLS_ECDHE_RSA_WITH_RC4_128_SHA

- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA

- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA

- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA

- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA

- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA

- TLS_RSA_WITH_AES_128_CBC_SHA

- TLS_RSA_WITH_AES_256_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

1.6.10 ルール管理

ルール管理のコマンド。

1.6.10.1 ルート

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

- otd_createRoute

- otd_deleteRoute

- otd_listRoutes

- otd_setRouteProperties

- otd_getRouteProperties

- otd_enableRouteAuth

- otd_disableRouteAuth

- otd_listProxyInfo

- otd_forwardProxyInfo

- otd_blockProxyInfo

- otd_enableRouteBandwidthLimit

- otd_disableRouteBandwidthLimit

- otd_getRouteBandwidthLimitProperties

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

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

- otd_createCacheRule

- otd_deleteCacheRule

- otd_listCacheRules

- otd_setCacheRuleProperties

- otd_getCacheRuleProperties

1.6.10.3 リクエスト制限ルール

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

- otd_createRequestLimit

- otd_deleteRequestLimit

- otd_listRequestLimits

- otd_setRequestLimitProperties

- otd_getRequestLimitProperties

- otd_enableRequestLimitEvents

- otd_disableRequestLimitEvents

1.6.10.4 圧縮ルール

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

- otd_createCompressionRule

- otd_deleteCompressionRule

- otd_listCompressionRules

- otd_setCompressionRuleProperties

- otd_getCompressionRuleProperties

1.6.10.5 コンテンツ・ルール

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

- otd_createContentRule

- otd_deleteContentRule

- otd_listContentRules

- otd_setContentRuleProperties

- otd_getContentRuleProperties

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

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

1.6.11.1 構成

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

- otd_enableWebAppFirewall

- otd_disableWebAppFirewall

- otd_setWebappFirewallProperties

- otd_getWebappFirewallProperties

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

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

- otd_installConfigurationWebappFirewallRulesetFile

- otd_installVirtualServerWebappFirewallRulesetFile

- otd_deleteConfigurationWebappFirewallRulesetFile

- otd_deleteVirtualServerWebappFirewallRulesetFile

- otd_listConfigurationWebappFirewallRulesetFiles

- otd_listVirtualServerWebappFirewallRulesetFiles

1.6.12 監視

監視のコマンド。

1.6.12.1 ランタイム統計

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

- otd_getStatsXml

- otd_getPerfDump

- displayMetricTables

1.6.12.2 設定/チューニング

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

- otd_enableStatsXml

- otd_enableStatsXml

- otd_getStatsXmlProperties

- otd_enablePerfDump

- otd_disablePerfDump

- otd_getPerfDumpProperties

- otd_setStatsProperties

- otd_getStatsProperties

1.6.12.3 SNMP構成

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

- otd_setSnmpProperties

- otd_getSnmpProperties

1.6.12.4 SNMP実行時管理

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

- otd_startSnmpSubAgent

- otd_stopSnmpSubAgent

1.6.13 ロギング構成

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

- otd_setLogProperties

- otd_getLogProperties

- otd_setAccessLogBufferProperties

- otd_getAccessLogBufferProperties

- otd_setConfigurationAccessLogProperties

- otd_getConfigurationAccessLogProperties

- otd_enableVirtualServerAccessLog

- otd_disableVirtualServerAccessLog

- otd_getVirtualServerAccessLogProperties

- otd_setTcpAccessLogProperties

- otd_getTcpAccessLogProperties

- displayLogs

1.6.14 イベント

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

- otd_createEvent

- otd_deleteEvent

- otd_listEvents

- otd_getEventProperties

- otd_setEventProperties

1.6.15 イベント・サブスクリプション

次に、イベント・サブスクリプション・コマンドを示します。

- otd_createEventSubscription

- otd_deleteEventSubscription

- otd_getEventSubscriptionProperties

- otd_setEventSubscriptionProperties

- otd_listEventSubscriptions

1.6.16 フェイルオーバー管理

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

1.6.16.1 構成

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

- otd_createFailoverGroup

- otd_deleteFailoverGroup

- otd_getFailoverGroupProperties

- otd_toggleFailoverGroupPrimary

- otd_listFailoverGroups

1.6.16.2 実行時管理

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

- otd_startFailover

- otd_stopFailover

1.6.16.3 インスタンス管理

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

- otd_addFailoverInstance

- otd_removeFailoverInstance

- otd_listFailoverInstances

- otd_setFailoverInstanceOrder

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

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

- otd_listPartitions

- otd_listResourceGroups

- otd_getPartitionAccessLogProperties

- otd_setPartitionAccessLogProperties

2 Oracle Traffic Director WLSTのコマンド

この章では、Oracle Traffic DirectorのWebLogic Scripting Tool (WLST)コマンドとそのオプションをアルファベット順にリストし、その機能について説明します。

activate

説明

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。アクティブ化する変更内容にサーバーの再起動が必要なものがある場合、このコマンドはメッセージを出力します。

activateコマンドは、ユーザーが現在行っている変更、または最近行った変更の状態を反映する、最新のActivationTask MBeanを返します。メソッドを呼び出して、進行中または完了したばかりの、最近の構成マネージャのアクティブ化タスクに関する情報を取得できます。エラーが発生した場合は、WLSTExceptionが返されます。

このコマンドを使用して、インスタンスに対する構成の変更をデプロイします。このコマンドでは、コマンドstartEditを実行して編集セッションを開始した後に実行された変更のみがデプロイされます。また、このコマンドの効果はOracle Traffic Directorに限定されません。他の様々なコンポーネントおよび管理対象サーバーに対して編集セッションの開始後に実行された変更もすべてデプロイされます。

構文

activate([timeout], [block])

引数

定義

timeout

オプション。操作を取り消す前に、WLSTが構成の変更のアクティブ化が完了するのを待機する時間(ミリ秒単位)。値 -1は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

block

オプション。コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、現在の編集セッション中に変更され、ディスクに保存されていて、まだアクティブ化されていない変更内容をアクティブ化します。WLSTはアクティブ化が完了するのを100,000ミリ秒待機し、アクティブ化を停止する前に200,000ミリ秒待機します。

wls:/mydomain/edit !> activate(200000, block='true')
Activating all your changes, this may take a while ...
The edit lock associated with this edit session is released once the activation is completed.
Action completed.
wls:/mydomain/edit>

関連項目

「help」、「otd_createConfiguration」、「otd_listConfigurations」、「otd_deleteConfiguration」、「otd_copyConfiguration」、「otd_listConfigFiles」、「otd_getConfigFile」、「otd_saveConfigFile」

deleteKeyStoreEntry

説明

別名を使用してキーストアから証明書または信頼できる証明書を削除します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。

構文

deleteKeyStoreEntry(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

削除するエントリの別名を指定します。

keypassword

削除するエントリのキー・パスワードを指定します。

例

この例では、別名mycertで表されるキーストア・エントリを削除します。

svc = getOpssService("KeyStoreService")
svc.deleteKeyStoreEntry(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='')

関連項目

「help」、「exportKeyStoreCertificateRequest」、「otd_listCertificates」、「importKeyStoreCertificate」、「getKeyStoreCertificates」、「generateKeyPair」

displayLogs

説明

このコマンドを使用して、Oracle Traffic Directorログ・ファイル、アクセス・ログ、TCPアクセス・ログおよびエラー・ログのコンテンツを表示します。アクセス・ログは、サーバーを対象とするリクエストとレスポンスに関する情報を記録します。

コマンドは、returnDataオプションをtrueに設定した場合のみ値を返します。デフォルトでは、このコマンドによってデータは返されません。戻り値は使用するオプションによって異なります。

構文

displayLogs([searchString,][options])

引数

定義

searchString

オプションの検索文字列。指定した文字列(大文字と小文字は区別されない)を含むメッセージのみが返されます。
displayLogsコマンドでは、複数のフォーマットでログを読み込むことができ、ODLフォーマットにメッセージを変換できます。検索は、できるだけネイティブ・フォーマットで実行されます。それ以外の場合、検索がメッセージ・コンテンツ内に実行され、マークアップを除外する場合もあります。したがって、検索文字列でマークアップ文字の使用を避ける必要があります。

target

オプション。WebLogic Serverインスタンス、またはシステム・コンポーネントの名前。
システム・コンポーネントの場合、ターゲットの構文は次のとおりです:

sc:component-name

接続モードでは、デフォルトのターゲットはWebLogicドメインです。接続解除モードでは、デフォルト値がない、ターゲット・オプションは必須です。

oracleInstance

オプション。ORACLE_INSTANCEまたはWebLogicドメイン・ホームへのパスを定義します。このパラメータを使用すると、コマンドは接続解除モードで実行されます。

log

オプション。ログ・ファイルのパス。コマンドは、指定したログ・ファイルからメッセージを読み込みます。ログ・ファイルのパスを指定しない場合、コマンドは、指定したターゲットに関連付けられるすべてのログを読み込みます。

last

オプション。整数値。時間制限に達する数分前にログされたメッセージに検索を制限します。値に接尾辞(秒はs、分はm、時間はhまたは日はd)を付加することで、異なる時間単位を指定することができます。(たとえば、last='2h'は最後の2時間として解釈されます)。

tail

オプション。整数値。検索範囲を各ログ・ファイルに含まれる最後のn個のメッセージに制限し、表示されるメッセージ数をn個に制限します。

pattern

オプション。正規表現パターン。特定のパターンを含むメッセージのみが返されます。パターン・オプションの使用は、searchString引数の使用と同様ですが、正規表現を使用できる点が異なります。
正規表現パターンの検索では、(パターンの大文字/小文字を区別しないフラグを明示的に有効にしないかぎり)大文字と小文字が区別されます。パターンはjava.util.regex構文に従う必要があります。

ecid

オプション。ログ・メッセージのフィルタとして使用される1つ以上の実行コンテキストID (ECID)値を含む文字列または連続した文字列。

component

オプション。ログ・メッセージのフィルタとして使用される1つ以上のコンポーネントID値を含む文字列または連続した文字列。

module

オプション。ログ・メッセージのフィルタとして使用される1つ以上のモジュールID値を含む文字列または連続した文字列。

type

オプション。ログ・メッセージのフィルタとして使用される1つ以上のメッセージ・タイプ値を含む文字列または連続した文字列。

app

オプション。ログ・メッセージのフィルタとして使用される1つ以上のアプリケーション値を含む文字列または連続した文字列。

query

オプション。ログ・メッセージのコンテンツの絞込みに使用される式を指定する文字列。
単純な式の形式は次のとおりです:

field-name operator value

field-nameはログ・レコード・フィールド名で、operatorはフィールド・タイプに適する演算子です(たとえば、文字列フィールドのためにequals、startsWith、containsまたはmatchesを指定できます)。

フィールド名は、標準ODL属性名のいずれか(COMPONENT_ID、MSG_TYPE、MSG_TEXT、SUPPL_DETAILなど)、またはSUPPL_ATTRという接頭辞が付いたアプリケーション固有のサプリメンタル属性名(SUPPL_ATTR.myAttributeなど)のいずれかです。

いくつかの一般的なサプリメンタル属性は、接頭辞なしで使用できます。たとえば、APPを使用して、アプリケーション名でフィルタ処理することができます。

ブール演算子and、orおよびnotを使用し複数の単純な式を組み合せて複雑な式を作成することができます。そして、丸括弧を使用して式をグループ化できます。

問合せ構文の詳細は、『Oracle Fusion Middlewareの管理』を参照してください。

groupBy

オプション。文字列リスト。groupByオプションを使用する場合、出力は文字列リストに定義された属性でグループしたログ・メッセージの数です。

orderBy

オプション。結果のソート順序を定義する文字列リスト。値はログ・メッセージ属性の名前です。必要に応じて、名前に:ascまたは:descのサフィックスを追加することで昇順または降順のソートを指定できます。デフォルトのソート順を昇順です。
デフォルトでは、結果は時間でソートされます。

returnData

オプション。Jythonブール値(0または1)。値がtrueの場合、コマンドによってデータが返されます。(たとえば、スクリプトで使用するデータ)。デフォルト値がfalseです。つまり、コマンドはデータを表示するだけで、戻しません。

format

オプション。出力形式を定義する文字列。有効な値は、ODL-Text、ODL-XML、ODL-completeおよびsimpleです。デフォルト形式はODL-Textです。

exportFile

オプション。コマンド出力が書き込まれるファイルの名前。デフォルトでは、出力は標準出力に書き込まれます。

follow (f)

オプション。コマンドで引き続きログを読み取り、新規メッセージがログに追加された際にメッセージを表示するために、コマンドをフォロー・モードに設定します(Unixのtail -fコマンドと同様)。fオプションを使用すると、コマンドは値を戻しません。現在、このオプションは、システム・コンポーネントではサポートされていません。

例

displayLogs(target="sc:otd_test_varunam.in.example.com")

関連項目

「help」、「displayLogs」、「otd_getAccessLogBufferProperties」、「otd_enableVirtualServerAccessLog」、「otd_disableVirtualServerAccessLog」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

displayMetricTables

説明

このWLSTコマンドを使用して、サーバー・インスタンスに関する実行時統計を表示できます。

構文

displayMetricTables([metricTable_1] [, metricTable_2], [...] [, servers] [, variables])

引数

定義

metricTable_n

オプション。メトリック表のリストを指定します。デフォルトでは、この引数はすべての使用可能なメトリックを表示します。メトリック表名では、単純なパターン一致のための特殊文字を使用できます。マッチング文字「?」は単一の文字に一致します。文字「*」は、0文字以上の文字列に一致します。
メトリック表名を指定します。カンマ区切りのリストで、複数のメトリック表名を指定できます。

これらは、WLSTコマンドdisplayMetricTableNamesによって出力されるものと同じ名前です。

servers

オプション。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。
1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

variables

オプション。メトリックの集約パラメータを定義します。有効な値は、名前と値のペアのセットです。次の構文を使用します:

variables={name1:value1, name2:value2, ...}

特定の名前と値のペアは、集約されたメトリック表によって異なります。集約されたメトリック表のすべては、変数名の特定のセットがあります。

例

次の例が正しく機能するには、少なくとも1つのOracle Traffic Directorインスタンスが実行されている必要があります。

# View metrics for all OTD instances
displayMetricTables('OTD_*')

# View origin server metrics for all instances
displayMetricTables('OTD_OriginServer')

# Get list of metric tables for a specific instance
displayMetricTableNames(servers='/OTD/otd_test_myserver.example.com')

# View all metrics for a specific instance
displayMetricTables(servers='/OTD/otd_test_myserver.example.com')

# View instance metrics for a specific instance
displayMetricTables('OTD_Instance', servers='/OTD/otd_test_myserver.example.com')

関連項目

「help」、「otd_createOriginServer」、「otd_deleteOriginServer」、「otd_listOriginServers」、「otd_setOriginServerProperties」

enableOverwriteComponentChanges

説明

このコマンドをactivateの前に実行すると、activateコールで、インスタンスに対するローカル構成ファイルの変更を、対応するサーバー・バージョンを使用して上書きできるようになります。

インスタンスに対するローカル構成ファイルの変更が存在する場合、activateコールは失敗します。このような場合、インスタンスに対する変更を破棄するか、pullComponentChangesを実行して変更をインスタンスから構成ストアにプルできます。どちらの場合も、activateの前にコマンドenableOverwriteComponentChangesを実行し、インスタンスに対するローカル変更が原因でactivateコールが失敗しないようにする必要があります。

注意:
このコマンドは、オープンの編集セッションからのみ実行できます。オープンの編集セッションの外部からインスタンスの変更を上書きする方法の詳細は、resync/resyncAllを参照してください。

構文

enableOverwriteComponentChanges()

例

props={'configuration': 'test', 'name': 'var_foo', 'value': 'bar'}
otd_createVariable(props)

activate()
weblogic.management.provider.UpdateException: [Management:141191]The prepare phase of the configuration update failed with an exception.
Caused by: weblogic.nodemanager.NMException: Received error message from Node Manager Server:
[ChangeList validation failed for transaction '3033897627106602' with cause:
OTD-67807 Validation failed for instance 'otd_test.example.com':
The instance configuration has been locally modified. The following changes can either be discarded on the next activate using 'enableOverwriteComponentChanges' or pulled into the current configuration using 'pullComponentChanges'.
Modified files: config/server.xml,config/test-obj.conf,config/obj.conf

# Scenario 1: Pull the changes on instance to config store and call enableOverwriteComponentChanges and activate.

showComponentChanges("otd_test.example.com")
component otd_test.example.com changes on machine example.com:
edit OTD/test/config/obj.conf 2014.12.01-16:20:50 1970.01.01-05:29:59
edit OTD/test/config/test-obj.conf 2014.12.01-16:20:50 1970.01.01-05:29:59
edit OTD/test/config/server.xml 2014.12.01-16:50:27 2014.12.01-16:49:44

pullComponentChanges("otd_test.example.com")
pull component otd_test.example.com changes on machine in.example.com:
edit OTD/test/config/obj.conf
edit OTD/test/config/test-obj.conf
edit OTD/test/config/server.xml

enableOverwriteComponentChanges()
activate()
Activating all your changes, this may take a while ...
The edit lock associated with this edit session is released once the activation is completed.
Activation completed

# Scenario 2: Discard the changes on the instance and override them with changes from the current edit session

showComponentChanges("otd_test.example.com")
component otd_test.example.com changes on machine example.com:
edit OTD/test/config/obj.conf 2014.12.01-16:55:29 1970.01.01-05:29:59
edit OTD/test/config/test-obj.conf 2014.12.01-16:55:29 1970.01.01-05:29:59
edit OTD/test/config/server.xml 2014.12.01-16:55:29 2014.12.01-16:58:23

enableOverwriteComponentChanges()
activate()
Activating all your changes, this may take a while ...
The edit lock associated with this edit session is released
once the activation is completed.
Activation completed

関連項目

「help」、「pullComponentChanges」、「resync/resyncAll」、「showComponentChanges」、「stopEdit」、「undo」

exportKeyStoreCertificate

説明

証明書、信頼できる証明書または証明書チェーンをエクスポートします。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。

構文

exportKeyStoreCertificate(appStripe='stripe', name='keystore',password='password', alias='alias', keypassword='keypassword', type='entrytype',filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

エクスポートするエントリの別名を指定します

keypassword

キー・パスワードを指定します。

type

エクスポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。

filepath

証明書、信頼できる証明書または証明書チェーンのエクスポート先となるファイルの絶対パスを指定します。

例

svc = getOpssService("KeyStoreService")
svc.exportKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', type='Certificate', filepath='/scratch/cert.txt')

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」

exportKeyStoreCertificateRequest

説明

鍵ペアに対する証明書署名リクエストを生成し、ファイルに保存します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。このBase64エンコードの証明書リクエストは、サードパーティの認証局(CA)に送信できます。これにより、この認証局が送信者を検証し、証明書を署名し、署名された証明書を返信します。

構文

exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore', password='password', alias='alias', keypassword='keypassword', filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

エントリの別名を指定します。

keypassword

キー・パスワードを指定します。

filepath

証明書リクエストのエクスポート先となるファイルの絶対パスを指定します。

例

svc = getOpssService("KeyStoreService")

# generate a key pair with the proper DN
svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024')

# generate the CSR and put it in to a text file
svc.exportKeyStoreCertificateRequest(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', filepath='/scratch/certreq.crt')

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」

generateKeyPair

説明

このコマンドを使用して、キーストアに鍵ペアを生成し、デモCA署名証明書にラップします。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。このコマンドは、リリース11gにおける自己署名証明書の作成と同等です。この鍵ペアを使用して、exportKeyStoreCertificateRequestを使用して証明書署名リクエスト(CSR)を生成し、署名を求めてサードパーティの認証局(CA)に送信できます。

構文

generateKeyPair(appStripe='stripe', name='keystore', password='password',
dn='distinguishedname', keysize='keysize', alias='alias',
keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

dn

鍵ペアをラップする証明書の識別名を指定します。

keysize

キー・サイズを指定します。

alias

鍵ペア・エントリの別名を指定します。

keypassword

キー・パスワードを指定します。

例

svc = getOpssService("KeyStoreService")
svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024')

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」、「exportKeyStoreCertificateRequest」

getKeyStoreCertificates

説明

このコマンドを使用して、サブジェクト、発行者、発行日および有効期限を含む証明書のプロパティを表示します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。

構文

getKeyStoreCertificates(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

表示する証明書、信頼できる証明書または証明書チェーンの別名を指定します。

keypassword

キー・パスワードを指定します。

例

svc = getOpssService("KeyStoreService")
svc.getKeyStoreCertificates(appStripe='OTD', name='myconfig', password='', alias='mycert')

関連項目

「help」、「importKeyStoreCertificate」、「deleteKeyStoreEntry」、「otd_listCertificates」、「generateKeyPair」、「exportKeyStoreCertificateRequest」

help

説明

Oracle Traffic Directorで使用可能なカスタムWLSTコマンドをすべてリストするか、特定のコマンドのヘルプをリストします。

構文

Oracle Traffic Directorで使用可能なカスタムWLSTコマンドをすべてリストする手順:

help('otd')

特定のコマンドのヘルプをリストする手順:

help('<otd_custom_command>')

例

help('otd_createConfiguration')

importKeyStoreCertificate

説明

CAによって署名された証明書または信頼できる証明書をキーストアにインポートします。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。

CSRが署名のためにCAに送信された後、CAはリクエストに署名し、通常は証明書をBase-64エンコードの文字列として送信します。証明書リクエストを生成するために使用した鍵ペアの別名と同じ別名を使用して、この証明書をタイプCertificateChainとして、中間証明書およびルートCA証明書とともにインポートする必要があります。

証明書をCAからダウンロードしたら、任意の中間証明書およびルートCA証明書をCAのWebサイトからダウンロードし、テキスト・エディタを開き、各証明書の本文全体を、プライマリ証明書>中間証明書>ルート証明書の順で1つのテキスト・ファイルに貼り付けます。

完了すると、ファイルは次のようになります。

-----BEGIN CERTIFICATE-----
(Server SSL certificate)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Intermediate certificate)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Root certificate)
-----END CERTIFICATE-----

構文

importKeyStoreCertificate(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword',
type='entrytype',filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

インポートするエントリの別名を指定します。

keypassword

新たにインポートされるエントリのキー・パスワードを指定します。

type

インポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。

filepath

証明書、信頼できる証明書または証明書チェーンのインポート元となるファイルの絶対パスを指定します。

例

svc = getOpssService("KeyStoreService")

# generate a key pair with the proper DN
svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024')

# generate the CSR and put it in to a text file
svc.exportKeyStoreCertificateRequest(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', filepath='/scratch/certreq.crt')

# Submit the CSR to a CA who can sign the certificate and import signed cert into # the keystore using the same alias as the key pair. Note that the file being     # imported should contain the CA cert along with the server cert and should be
# imported as type 'CertificateChain'
svc.importKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', type='CertificateChain', filepath='/scratch/certsign.pem')

# Any CA cert can be imported into the keystore as a trusted cert
svc.importKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='ca-cert', keypassword='', type='TrustedCertificate', filepath='/scratch/cacert.crt')

関連項目

「help」、「exportKeyStoreCertificateRequest」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」、「generateKeyPair」

listExpiringCertificates

説明

指定された期間内に期限切れとなる証明書を一覧表示します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。

構文

listExpiringCertificates(days='days', autorenew=true|false)

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

days

日数を指定します。リストには、指定された日数内に期限切れとなる証明書のみが含まれます。

autorenew

期限切れとなる証明書を自動的に更新する場合はtrue、それらを一覧表示するのみの場合はfalseを指定します。

例

svc = getOpssService("KeyStoreService")
svc.listExpiringCertificates(days='365', autorenew=false)

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」、「exportKeyStoreCertificateRequest」

listKeyStores

説明

ストライプ内のすべてのキーストアを一覧表示します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。Oracle Traffic Directorの場合、権限が保護されたキーストアが構成と同時に作成されるだけでなく、このキーストアは構成と同じ名前を持ちます。したがって、通常、listKeyStoresによって返されるキーストア名は構成名と一致します。

構文

listKeyStores(appStripe='stripe')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアを一覧表示するストライプの名前を指定します。

例

svc = getOpssService("KeyStoreService")
svc.listKeyStores(appStripe='OTD')

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」、「exportKeyStoreCertificateRequest」

listKeyStoreAliases

説明

キーストア内の別名を一覧表示します。詳細は、セキュリティ・カスタムWLSTコマンドを参照してください。生成される証明書またはキーストアにインポートされる証明書はすべて、別名別にリストされます。

構文

listKeyStoreAliases(appStripe='stripe', name='keystore', password='password', type='entrytype')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

type

別名を一覧表示するエントリのタイプを指定します。有効な値は、Certificate、TrustedCertificate、SecretKeyまたは*です。

例

svc = getOpssService("KeyStoreService")

# List all certificates
svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='*')

# List all user certificates (both SSL server and client)
svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='Certificate')

# List only Trusted CA certificates
svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='TrustedCertificate')

関連項目

「help」、「importKeyStoreCertificate」、「otd_listCertificates」、「deleteKeyStoreEntry」、「getKeyStoreCertificates」、「exportKeyStoreCertificateRequest」

otd_addFailoverInstance

説明

このコマンドを使用して、フェイルオーバー・インスタンスを追加します。このコマンドは、アクティブ-アクティブ・フェイルオーバー・タイプに対してのみ有効です。フェイルオーバー・グループに最大254個のインスタンスを追加できます。

構文

otd_addFailoverInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

障害グループを一意に識別する仮想IP。

必須。

instance

インスタンスの名前。

必須。

nic

VIPを管理する必要のあるネットワーク・インタフェース。

必須。

例

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '10.128.67.44'
props['instance'] = '1.example.com'
props['nic'] = 'eth0'
otd_addFailoverInstance(props)

関連項目

「otd_removeFailoverInstance」、「otd_listFailoverInstances」、「otd_setFailoverInstanceOrder」

otd_blockProxyInfo

説明

このコマンドを使用して、特定のプロキシ・パラメータの生成およびオリジン・サーバーへの転送をブロックします。プロキシ・パラメータおよびヘッダーに関する情報は、otd_forwardProxyInfoに記載されています。

注意:
プロキシ・パラメータに対応するヘッダーが着信リクエストに含まれる場合、Oracle Traffic Directorは、このヘッダーが含まれる着信リクエストをオリジン・サーバーに受け渡します。

構文

otd_blockProxyInfo(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

param

ブロックするプロキシ・パラメータの名前。
値の範囲: jroute、via、ip、cipher、proxy-agent、keysize、secret-keysize、ssl-id、issuer-dn、user-dn、auth-cert、xforwarded-for、cache-info、ssl。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['param'] = 'ssl'
otd_blockProxyInfo(props)

関連項目

「help」、「otd_listProxyInfo」、「otd_forwardProxyInfo」

otd_copyConfiguration

説明

このコマンドを使用して、既存の構成のコピーを作成します。

構文

otd_copyConfiguration(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

source-configuration

コピーする構成の名前。

必須。

dest-configuration

新しい構成の名前。名前には、スペース、無効な文字、またはASCII以外の文字を含めることはできません。

必須。

例

props = {}
props['source-configuration'] = 'foo'
props['dest-configuration'] = 'bar'
otd_copyConfiguration(props)

関連項目

「help」、「otd_createConfiguration」、「otd_deleteConfiguration」、「otd_listConfigurations」、「activate」

otd_copyVirtualServer

説明

このコマンドを使用して、既存の仮想サーバーのコピーを作成します。

構文

otd_copyVirtualServer(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

source-virtual-server

コピーする仮想サーバーの名前。

必須。

dest-virtual-server

新しい仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['source-virtual-server'] = 'bar'
props['dest-virtual-server'] = 'baz'
otd_copyVirtualServer(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_deleteVirtualServer」、「otd_getVirtualServerProperties」、「otd_listVirtualServers」

otd_createCacheRule

説明

このコマンドを使用して、一連の初期値とともにキャッシュ・ルールを作成します。

構文

otd_createCacheRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

cache-rule

作成するキャッシュ・ルールの名前。

必須。

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['cache-rule'] = 'cache-rule-1'
otd_createCacheRule(props)

関連項目

「help」、「otd_deleteCacheRule」、「otd_getCacheProperties」、「otd_getCacheRuleProperties」、「otd_listCacheRules」

otd_createCompressionRule

説明

このコマンドを使用して、値の初期セットとともに圧縮ルールを作成します。

構文

otd_createCompressionRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

compression-rule

作成する圧縮ルールの名前。

必須。

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['compression-rule'] = 'compression-rule-1'
otd_createCompressionRule(props)

関連項目

「help」、「otd_deleteCompressionRule」、「otd_setCompressionRuleProperties」、「otd_listCompressionRules」

otd_createConfiguration

説明

このコマンドを使用して、特定のポートでHTTPおよびTCPトラフィックをリスニングし、一連のHTTPおよびTCPオリジン・サーバーに対するフロントエンドとなる新しい構成を作成します。このコマンドは、HTTPトラフィックを処理するデフォルト仮想サーバーおよびTCPトラフィックを処理するデフォルトTCPプロキシを作成します。さらに、デフォルト・ルートを作成し、すべてのトラフィックをオリジン・サーバーに転送します。

構文

otd_createConfiguration(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

name

作成する構成の名前。名前には、スペース、無効な文字、またはASCII以外の文字を含めることはできません。

必須。

listener-port

サーバーがリクエストを受け入れるリスナー・ポート。
値の範囲: ポート番号は1から65535の両端の値を含む範囲の整数にする必要があります。

必須。

server-name

origin-server-typeがhttpまたはhttpsである場合のみ有効。サーバー名は、サーバーによって自動的に生成されてクライアントに送信されているあらゆるURLで使用されています。このサーバー名は仮想ホスト名であるか、サーバーが別名を使用している場合は別名である必要があります。サーバー名にコロンとポート番号が付加されている場合、そのポートは生成されたURLで使用されます。

ip

サーバーは、デフォルト・リスナーのこのインターネット・プロトコル(IP)アドレスにバインドします。このIPアドレスに送信されたトラフィックのみが処理されます。*は、サーバーがすべてのIPアドレスをリスニングすることを示します。
値の範囲: *、ホスト名またはIPV4/IPV6アドレス

origin-server-type

オリジン・サーバーで処理されるリクエストのタイプ。
値の範囲: http/https/tcp

デフォルト: http

origin-server

バックエンドのサーバーであり、Oracle Traffic Directorはクライアントから受信したリクエストをこのサーバーに転送し、クライアント・リクエストに対するレスポンスをこのサーバーから受信します。たとえば、オリジン・サーバーとして、Oracle WebLogic Serverのようなアプリケーション・サーバー、Webサーバー、LDAPサーバーなどを使用できます。host:port形式のオリジン・サーバーのカンマ区切りリストとして指定する必要があります。

複数値。

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

例

オンライン:

# Online
props = {}
props['name'] = 'foo'
props['listener-port'] = '12345'
props['server-name'] = 'foo'
props['origin-server'] = 'vault.example.com:80'
otd_createConfiguration(props)

オフライン:

# Offline
readDomain('/export/domains/otd_domain')
props = {}
props['name'] = 'foo'
props['listener-port'] = '12345'
props['server-name'] = 'foo'
props['origin-server'] = 'vault.example.com:80'
otd_createConfiguration(props)
updateDomain()
closeDomain()

関連項目

「help」、「otd_listConfigurations」、「otd_deleteConfiguration」、「otd_copyConfiguration」、「otd_listConfigFiles」、「otd_getConfigFile」、「otd_saveConfigFile」、「activate」

otd_createContentRule

説明

このコマンドを使用して、コンテンツ・ルールを作成します。

構文

otd_createContentRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

コンテンツ・ルールを作成する仮想サーバーの名前。

必須。

content-rule

作成するコンテンツ・ルールの名前。

必須。名前は一意である必要があります。

uri-prefix

ディレクトリにマップする必要があるURI接頭辞。

必須。

directory-path

ドキュメントを格納する絶対サーバー・パスおよび有効なディレクトリ。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['uri-prefix'] = '/baz'
props['directory-path'] = '/qux'
props['content-rule'] = 'content-rule-1'
otd_createContentRule(props)

関連項目

「help」、「otd_getContentRuleProperties」、「otd_listContentRules」、「otd_deleteContentRule」、「otd_setContentRuleProperties」

otd_createErrorPage

説明

このコマンドを使用して、指定したエラー・コードに対応するエラー・ページを作成します。

構文

otd_createErrorPage(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

code

エラー・ページを作成するエラー・コード。
値の範囲: 400 - 599。

必須。

error-page

エラー・ページを作成する絶対パス。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['code'] = '408'
props['error-page'] = '/documents/otd'
otd_createErrorPage(props)

関連項目

「help」、「otd_deleteErrorPage」、「otd_listErrorPages」

otd_createEvent

説明

このコマンドを使用して、イベントを作成します。

構文

otd_createEvent(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

イベントを作成する構成の名前。

必須。

event

イベントを一意に識別する名前。
名前は、1つ以上の文字で構成できます。空白は許可されていません。

必須。

command

イベントで実行するコマンド。
値の範囲: 値として、restart、reconfig、rotate-log、rotate-access-logおよびupdate-crlまたは実行可能な任意のコマンドを指定できます。

必須。

time

このイベントを起動する時刻(12:30など)。
値の範囲: 時刻の形式はhh:mmです。

month

このイベントを実行する月。
値の範囲: 1-12。

day-of-month

このイベントを実行する日。
値の範囲: 1-31。

day-of-week

このイベントを実行する曜日。
値の範囲: Sun、Mon、Tue、Wed、Thu、FriまたはSat。

interval

このイベントを実行する間隔。
値の範囲: 60 (1分)から86400 (1日)の両端の値を含む秒単位の間隔。

enabled

イベントが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

例

props = {}
props['configuration'] = 'foo'
props['event'] = 'event-1'
props['command'] = 'rotate-log'
props['time'] = '12:00'
otd_createEvent(props)

関連項目

「help」、「otd_deleteEvent」、「otd_listEvents」、「otd_getEventProperties」、「otd_setEventProperties」

otd_createEventSubscription

説明

このコマンドを使用して、イベント・サブスクリプションを作成します。

構文

otd_createEventSubscription(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

イベント・サブスクリプションを作成する構成の名前。

必須。

event-subscription

イベント・サブスクリプションのユーザー定義名。

必須。

URL

サブスクリプションURLを指定します。これが構成されている場合、Oracle Traffic DirectorによってこのURLに通知がパブリッシュされます。
値の範囲: 有効なHTTP URL。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event-subscription'] = 'bar'
props['url'] = 'http://example.com:7777/subscriber'
otd_createEventSubscription(props)

関連項目

「help」、「otd_deleteEventSubscription」、「otd_getEventSubscriptionProperties」、「otd_setEventSubscriptionProperties」、「otd_listEventSubscriptions」

otd_createFailoverGroup

説明

このコマンドを使用して、一意の仮想IPアドレス(VIP)でグループ化された2つのOracle® Fusion Middlewareインスタンスで構成されるフェイルオーバー・グループを作成し、アクティブ/パッシブ・モードでの高可用性を実現します。リクエストは、指定したVIPアドレスで受信され、プライマリ・インスタンスとして指定されたOracle® Fusion Middlewareインスタンスにルーティングされます。プライマリ・インスタンスに到達できない場合、リクエストはバックアップ・インスタンスにルーティングされます。

アクティブ/アクティブ・フェイルオーバーでは、両方とも同じ2つのノードで構成され、プライマリ・ロールとバックアップ・ロールが逆になった2つのフェイルオーバー・グループを作成する必要があります。ノードの1つはマスター・ノードになり、残りのノードはバックアップ・ノードです。VIPへの着信リクエストはOTDインスタンス間に分散されます。マスター・ノードが失敗した場合、優先度が最も高いバックアップ・ノードが次のマスター・ノードとして選択されます。フェイルオーバー・グループを作成した後、otd_addFailoverInstanceコマンドを使用してフェイルオーバー・インスタンスを追加します。

複数の構成にわたって最大255個のフェイルオーバー・グループを作成できます。

フェイルオーバー・グループを作成する際、管理ノード・プロセスがインスタンスの置かれているノードで非rootとして実行中である場合、これらのノードでrootユーザーとしてotd_startFailoverを実行する必要があります。これはフェイルオーバーを手動で開始するためです。このコマンドを実行しないとフェイルオーバーは開始しないため、高可用性を実現できません。

Oracle Traffic Directorでのフェイルオーバーの動作方法の詳細は、『Oracle Traffic Directorの管理』を参照してください。

構文

otd_createFailoverGroup(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

フェイルオーバー・グループを作成する構成の名前。

必須。

virtual-ip

フェイルオーバーの作成対象のVIP。VIPは、フェイルオーバー・グループのノードと同じサブネットに属している必要があり、クライアントからアクセスできる必要があります。
値の範囲: ホスト名またはIPv4/IPv6アドレス。

必須。

primary-instance

プライマリとして指定されている既存のインスタンス。
failover-typeがアクティブ-パッシブの場合のみ必要です。

必須。

backup-instance

バックアップとして指定されている既存のインスタンス。
failover-typeがアクティブ-パッシブの場合のみ必要です。

必須。

primary-nic

VIPを管理する必要のある、プライマリ・インスタンスが実行されているノード上のネットワーク・インタフェース。
failover-typeがアクティブ-パッシブの場合のみ必要です。

必須。

backup-nic

VIPを管理する必要のある、バックアップ・インスタンスが実行されているノード上のネットワーク・インタフェース。
failover-typeがアクティブ-パッシブの場合のみ必要です。

必須。

router-id

VRRPの必要性は、VIPのフェイルオーバーに参加しているVRRPルーター・グループを識別します。値は、フェイルオーバー・グループ全体で一意にする必要があります。指定されていない場合、デフォルトのrouter-idは1 - 255のランダムな数値になります。
値の範囲: 正の整数。有効な範囲は1 - 255です。

デフォルト: 1 - 255のランダムな数値

failover-type

フェイルオーバー・グループ・タイプ。
値: 「アクティブ-パッシブ」、「アクティブ-アクティブ」。

デフォルト値: 「アクティブ-パッシブ」。

注意: このプロパティはLinuxプラットフォームでのみ有効です。

例

- アクティブ-パッシブ・フェイルオーバー・グループの作成

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '192.0.2.1'
props['primary-instance'] = '1.example.com'
props['backup-instance'] = '2.example.com'
props['primary-nic'] = 'eth0'
props['backup-nic'] = 'eth0'
otd_createFailoverGroup(props)

- アクティブ-アクティブ・フェイルオーバー・グループの作成

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '192.0.2.1'
props['failover-type'] = 'active-active'
otd_createFailoverGroup(props)

関連項目

「help」、「otd_deleteFailoverGroup」、「otd_getFailoverGroupProperties」、「otd_toggleFailoverGroupPrimary」、「otd_startFailover」、「otd_stopFailover」

otd_createHttpListener

説明

このコマンドを使用して、一連の初期値とともに新しいHTTPリスナー・ソケットを作成します。すべての仮想サーバーにおいて、HTTPリスナーが指定されています。新規リクエストが着信すると、Oracle® Fusion Middlewareでは、構成済のHTTPリスナーに基づいて、リクエストの送信先となる仮想サーバーを決定します。

構文

otd_createHttpListener(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

http-listener

HTTPリスナーを一意に識別する名前。名前は、1つ以上の文字で構成できます。空白は許可されていません。

必須。

port

リスニングするポート。
値の範囲: 1から65535の両端の値を含むポート番号。

必須。

server-name

デフォルトのサーバー名。スキーム接頭辞(http://など)とポート接尾辞(:80など)を含めることができます。ホスト名、完全修飾ドメイン名、IPアドレスまたはURL接頭辞を指定できます。URL接頭辞でパスを指定することはできません。

必須。

default-virtual-server-name

ホストが一致しなかったリクエストを処理する仮想サーバーの名前。

必須。

enabled

リスナーが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ip

リスニングするIPアドレス。
値の範囲: *、ホスト名またはIPアドレス。

acceptor-threads

このリスナーが受信する接続の受け入れに特化されたスレッドの数。
値の範囲: 1 - 128。

デフォルト: auto-tuned。

blocking-io

サーバーでブロッキングIOを使用するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

blocking-accept

クライアントのエンド・ポイントを非ブロッキングのままにしながら、サーバー・リスニング・ソケットのブロッキングを有効/無効にします(MaxProcsが1を上回る場合に役立ちます)。
値の範囲: trueまたはfalse。

デフォルト: false。

handle-protocol-mismatch

値の範囲: trueまたはfalse。
デフォルト: true。

family

オリジン・サーバーに接続するために使用するソケット・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp

デフォルト: auto-tuned。

listen-queue-size

オペレーティング・システムのリスニング・キュー・バックログの最大サイズ。
値の範囲: 1 - 1048576。

デフォルト: 128。

receive-buffer-size

オペレーティング・システムのソケット受信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

send-buffer-size

オペレーティング・システムのソケット送信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

max-requests-per-connection

キープ・アライブ接続が閉じられるまでにHTTP接続ごとに処理されるキープアライブ・リクエストの最大数。0は、制限がないことを示します。
値の範囲: 任意の正の整数

デフォルト: 0。

description

管理者の参照用のHTTPリスナーの説明。

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
props['port'] = '23456'
props['server-name'] = 'example.com'
props['default-virtual-server-name'] = 'bar'
otd_createHttpListener(props)

関連項目

「help」、「otd_setHttpListenerProperties」、「otd_listHttpListeners」、「otd_deleteHttpListener」

otd_createInstance

説明

このコマンドを使用して、指定したマシン上でこの構成のインスタンスを作成します。インスタンスとは、Oracle® Fusion Middlewareデーモンの環境のことで、構成、ログ・ファイルおよび他の実行時アーティファクト(ロック・データベース、キャッシュ、一時ファイルなど)が含まれます。

構文

otd_createInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

machine-name

Oracle WebLogic Serverコンソール内でマシンの作成中に指定した名前で、Oracle Traffic Directorインスタンスが実行されているマシンのホスト名に対応しています。

必須。

注意:
このコマンドをオフライン・モードで実行する場合、インスタンス・ファイル・アーティファクトが作成されるのは、指定したマシンが管理サーバーと同じホスト上にある場合のみです。それ以外の場合、インスタンス・ファイル・アーティファクトは、管理サーバーとノード・マネージャの両方が起動した後に作成されます。

例

# Online
props = {}
props['configuration'] = 'foo'
props['machine-name'] = 'machine1'
otd_createInstance(props)

# Offline
readDomain('/export/domains/otd_domain')
props = {}
props['configuration'] = 'foo'
props['machine-name'] = 'machine1'
otd_createInstance(props)
updateDomain()
closeDomain()

関連項目

「help」、「otd_deleteInstance」、「otd_listInstances」、「start」、「stop」、「softRestart」

otd_createMimeType

説明

このコマンドを使用して、MIMEタイプを作成します。

構文

otd_createMimeType(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

content-type

MIMEタイプのコンテンツ・タイプ。

必須。

extensions

MIME値のファイル拡張子。

必須。
複数のファイル拡張子を定義するには、これらをカンマ(,)で区切ります

例

props = {}
props['configuration'] = 'foo'
props['content-type'] = 'bar'
props['extensions'] = 'baz'
otd_createMimeType(props)

関連項目

「help」、「otd_deleteMimeType」、「otd_listMimeTypes」

otd_createOriginServer

説明

このコマンドを使用して、既存のオリジン・サーバー・プールにオリジン・プール・サーバーを一連の初期値とともに作成します。オリジン・サーバーは、サーバー・プールのメンバーを定義します。

構文

otd_createOriginServer(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

host

このオリジン・サーバーのIPアドレス/ホスト名。
値の範囲: ホスト名またはIPアドレス。

必須。

port

このオリジン・サーバーのポート番号。
値の範囲: 1から65535の両端の値を含むポート番号。

必須。

weight

このオリジン・サーバーの負荷分散の重み。
値の範囲: 1 - 1000。

デフォルト: 1

backup

このパラメータは、オリジン・サーバーがバックアップ・サーバーであるかどうかを指定します。
値の範囲: trueまたはfalse。

デフォルト: false。

max-connections

サーバーに対する同時接続の最大数。
値の範囲: 0 - 20480。

デフォルト: 0。

ramp-up-time

新しく起動したオリジン・サーバーの容量まで送信レートをランプアップする時間(秒単位)。このパラメータが指定されていない場合、このサーバーに対してリクエスト率の加速がアクティブ化されません。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 0.001。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['host'] = 'www.example.com'
props['port'] = '12345'
otd_createOriginServer(props)

関連項目

「help」、「otd_deleteOriginServer」、「otd_listOriginServers」、「otd_getOriginServerProperties」、「otd_setOriginServerProperties」

otd_createOriginServerPool

説明

このコマンドを使用して、オリジン・サーバー・プールを作成します。オリジン・サーバー・プールでは、ロード・バランシング・リクエストで使用するオリジン・サーバーのプールを構成します。

構文

otd_createOriginServerPool(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

このサーバー・プールが参照される名前。名前は1つ以上の文字で構成できますが、空白は許可されません。

必須。

origin-server

このサーバー・プールに属するオリジン・サーバーを表します。複数のカンマ区切り値を指定できます。

複数値。

type

このサーバー・プールの各サーバー(によって処理されるリクエスト)のタイプを指定します。
値の範囲: tcp、httpまたはhttps。

デフォルト: http。

family

このプールのサーバーに接続するために使用されるソケット・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp。

デフォルト: auto-tuned。

load-distribution

このサーバー・プールの負荷分散に使用されるアルゴリズム。
値の範囲: round-robin、least-connection-countまたはleast-response-time。

デフォルト: least-connection-count。

proxy-server

host:port形式でのプロキシ・サーバーの名前。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['origin-server'] = 'www.example.com:12345'
otd_createOriginServerPool(props)

関連項目

「help」、「otd_setOriginServerPoolProperties」、「otd_getOriginServerPoolProperties」、「otd_deleteOriginServerPool」、「otd_listOriginServerPools」

otd_createRequestLimit

説明

このコマンドを使用して、一連の初期値とともにリクエスト制限ルールを作成します。

構文

otd_createRequestLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

リクエスト制限ルールの名前。

必須。

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

max-rps

仮想サーバーで1秒当たりに受信できるリクエストの最大数。

max-connections

一致する同時接続の最大数。

monitor-attribute

監視するリクエスト属性。

例

props = {}props['configuration'] = 'foo'props['virtual-server'] = 'bar'props['request-limit'] = 'request-limit-1'
props['max-connections'] = '2048'
otd_createRequestLimit(props)

関連項目

「help」、「otd_deleteRequestLimit」、「otd_listRequestLimits」、「otd_getRequestLimitProperties」、「otd_setRequestLimitProperties」

otd_createRoute

説明

このコマンドを使用して、一連の初期値とともにルートを作成します。ルートの作成時に指定した条件に基づいて、ロード・バランシング・リクエストは、指定したオリジン・サーバー・プールにルーティングされます。仮想サーバーを作成すると、デフォルト・ルートが作成されます。

構文

otd_createRoute(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

作成するルートの名前。

必須。

origin-server-pool

負荷分散リクエストをルーティングする必要があるオリジン・サーバー・プールの名前。

必須。

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

uri-prefixが指定されている場合、conditionを指定することはできません。

uri-prefix

uri-prefixは、ワイルドカード・パターンを持つURIパスです。リクエストURIがuri-prefixと一致する場合、ルールが実行されます。

conditionが指定されている場合、uri-prefixを指定することはできません。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_createRoute(props)

関連項目

「help」、「otd_deleteRoute」、「otd_listRoutes」、「otd_getRouteProperties」、「otd_setRouteProperties」

otd_createStandaloneDomain

説明

このコマンドを使用して、指定した場所でOracle Traffic Directorスタンドアロン・ドメインを作成します。

このコマンドは、オフライン・モードでのみ実行できます。

構文

otd_createStandaloneDomain(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

domain-home

Oracle Traffic Directorスタンドアロン・ドメインが含まれている必要があるドメイン・ディレクトリへのパス。

必須。

例

props = {}
props['domain-home'] = '/export/domains/otd_standalone'
otd_createStandaloneDomain(props)

関連項目

「help」、「otd_createStandaloneInstance」、「otd_deleteStandaloneInstance」

otd_createStandaloneInstance

説明

このコマンドを使用して、Oracle Traffic Directorスタンドアロン・ドメインでOracle Traffic Directorインスタンスを作成します。

このコマンドは、オフライン・モードでのみ実行できます。

構文

otd_createStandaloneInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

instance

作成するインスタンスの名前。

必須。

domain-home

Oracle Traffic Directorスタンドアロン・ドメインが含まれている必要があるドメイン・ディレクトリへのパス。

必須。

listener-port

サーバーがリクエストを受け入れるリスナー・ポート。
値の範囲: ポート番号は1から65535の両端の値を含む範囲の整数にする必要があります。

必須。

server-name

origin-server-typeがhttpまたはhttpsである場合のみ有効。サーバー名は、サーバーによって自動的に生成されてクライアントに送信されているあらゆるURLで使用されています。このサーバー名は仮想ホスト名であるか、サーバーが別名を使用している場合は別名である必要があります。サーバー名にコロンとポート番号が付加されている場合、そのポートは生成されたURLで使用されます。

ip

サーバーは、デフォルト・リスナーのこのインターネット・プロトコル(IP)アドレスにバインドします。このIPアドレスに送信されたトラフィックのみが処理されます。*は、サーバーがすべてのIPアドレスをリスニングすることを示します。
値の範囲: *、ホスト名またはIPV4/IPV6アドレス。

origin-server-type

オリジン・サーバーで処理されるリクエストのタイプ。
値の範囲: http/https/tcp。

デフォルト: http。

origin-server

バックエンドのサーバーであり、Oracle Traffic Directorはクライアントから受信したリクエストをこのサーバーに転送し、クライアント・リクエストに対するレスポンスをこのサーバーから受信します。たとえば、オリジン・サーバーとして、Oracle WebLogic Serverのようなアプリケーション・サーバー、Webサーバー、LDAPサーバーなどを使用できます。
host:portという形式でオリジン・サーバーのカンマ区切りのリストとして指定されます。

例

props = {}
props['name'] = 'foo'
props['domain-home'] = '/export/domains/otd_standalone'
props['listener-port'] = '12345'
props['server-name'] = 'foo.bar'
otd_createStandaloneInstance(props)

関連項目

「help」、「otd_createStandaloneDomain」、「otd_deleteStandaloneInstance」

otd_createTcpListener

説明

このコマンドを使用して、一連の初期値とともに新しいTCPリスナーを作成します。新規リクエストが着信すると、Oracle Traffic Directorでは、構成済のTCPリスナーに基づいて、リクエストの送信先となるTCPプロキシを決定します。

構文

otd_createTcpListener(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

リスナーを一意に識別する名前。名前は、1つ以上の文字で構成できます。空白は許可されていません。

必須。

port

リスニングするポート。
値の範囲: 1から65535の両端の値を含むポート番号。

必須。

tcp-proxy-name

公開されたTCPサービスを識別する名前。

必須。

enabled

インスタンスが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ip

リスニングするIPアドレス。
値の範囲: ホスト名またはIPアドレス。

acceptor-threads

このリスニング・エンド・ポイントのアクセプタ・スレッド。
値の範囲: 1 - 128。

デフォルト: auto-tuned。

blocking-accept

クライアントのエンド・ポイントを非ブロッキングのままにしながら、サーバー・リスニング・ソケットのブロッキングを有効/無効にします(MaxProcsが1を上回る場合に役立ちます)。
値の範囲: trueまたはfalse。

デフォルト: false。

description

管理者の参照用のTCPリスナーの説明。

family

プロトコル・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp。

デフォルト: auto-tuned。

listen-queue-size

オペレーティング・システムのリスニング・キュー・バックログの最大サイズ。
値の範囲: 1 - 1048576。

デフォルト: 128。

receive-buffer-size

オペレーティング・システムのソケット受信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

send-buffer-size

オペレーティング・システムのソケット送信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
props['port'] = '34567'
props['tcp-proxy-name'] = 'tcp-proxy-1'
otd_createTcpListener(props)

関連項目

「help」、「otd_deleteTcpListener」、「otd_listTcpListeners」、「otd_getTcpListenerProperties」、「otd_setTcpListenerProperties」

otd_createTcpProxy

説明

このコマンドを使用して、一連の初期値とともに新しいTCPプロキシを作成します。TCPプロキシは、リストされたオリジン・サーバーへのトラフィック・トンネリングのために、TCPリスナーを介してTCPリクエストを処理します。TCPプロキシには複数のTCPリスナーを関連付けることができます。

TCPプロキシに対するFTPサポートを有効にできます。これによって、FTPサーバーをフロントエンド処理するために使用される、TCPプロキシを参照しているTCPリスナーとともにTCPプロキシが有効になります。

構文

otd_createTcpProxy(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-proxy

公開されたTCPサービスを一意に識別する名前。

必須。

origin-server-pool

TCPサービスを提供する既存のサーバー・プールの名前。

必須。

enabled

TCPサービスが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

session-idle-timeout

セッションでロード・バランサがデータの送受信を待機する最大時間(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

protocol

プロトコルが'ftp'の場合、TCPプロキシは、otd_setTcpProxyPropertiesまたはotd_getTcpProxyPropertiesを使用して設定または取得できる追加のftpプロパティを持ちます。
値の範囲: *、ftp。

デフォルト値: *。

otd_createTcpProxyがprotocolにftpを指定して実行された場合、FTP構成は、プロパティssl-termination、origin-explicit-ftpsおよびclient-explicit-ftpsがそれぞれfalse、trueおよびtrueであるtcpプロキシに対して有効になります。

例

props = {}
props['configuration'] = 'foo'
props['tcp-proxy'] = 'bar'
props['protocol'] = 'ftp'
props['origin-server-pool-name'] = 'tcp-origin-server-pool-1'
otd_createTcpProxy(props)

関連項目

「help」、「otd_deleteTcpProxy」、「otd_listTcpProxies」、「otd_getTcpProxyProperties」、「otd_setTcpProxyProperties」

otd_createConfigurationVariable

説明

このコマンドを使用して、式、ログ形式およびobj.confパラメータで使用する変数を定義します。

構文

otd_createConfigurationVariable(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

name

文字、数字およびアンダースコアで構成される変数名。変数名の先頭を数字にすることはできません。

必須。

value

変数名に対応する値。

必須。

例

props = {}
props['configuration'] = 'foo'
props['name'] = 'bar'
props['value'] = 'baz'
otd_createConfigurationVariable(props)

関連項目

「help」、「otd_deleteConfigurationVariable」、「otd_listVirtualServerVariables」

otd_createVirtualServer

説明

このコマンドを使用して、定義された初期値とともに新しい仮想サーバーを作成します。

構文

otd_createVirtualServer(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーを一意に識別する名前。名前は、1つ以上の文字で構成できます。空白は許可されていません。

必須。

origin-server-pool

仮想サーバーを作成するオリジン・サーバー・プールの名前。

必須。

canonical-server-name

仮想サーバーの正規ホスト名(別のホスト名を使用してリクエストすると、このホスト名にリダイレクトされます)。ホスト名、完全修飾ドメイン名、IPアドレスまたはURL接頭辞を指定できます。URL接頭辞でパスを指定することはできません。

log-file

仮想サーバーのログ・ファイル。

http-listener

1つ以上の仮想サーバーのホスト名に関連付けられたHTTPリスナーの名前。複数のカンマ区切り値を指定できます。

複数値。

host

仮想サーバー・サービスのホスト名。複数のカンマ区切り値を指定できます。この場合、各値は、1つ以上のホスト名と一致するワイルドカード・パターンにすることができます。

複数値。http-listenerが設定されている場合は必須です。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_createVirtualServer(props)

関連項目

「help」、「otd_setVirtualServerProperties」、「otd_deleteVirtualServer」、「otd_getVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」

otd_createVirtualServerVariable

説明

このコマンドを使用して、仮想サーバー・レベルで変数を作成します。変数は、式、ログ形式およびobj.confパラメータで使用できます。

構文

otd_createVirtualServerVariable(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

変数を作成する仮想サーバーの名前。

必須。

name

文字、数字およびアンダースコアで構成される変数名。変数名の先頭を数字にすることはできません。

必須。

value

変数に対応する値。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['name'] = 'baz'
props['value'] = 'qux'
otd_createVirtualServerVariable(props)

関連項目

「help」、「otd_deleteConfigurationVariable」、「otd_listVirtualServerVariables」

otd_deleteCacheRule

説明

このコマンドを使用して、指定した名前を持つキャッシュ・ルールを削除します。

構文

otd_deleteCacheRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

cache-rule

削除するキャッシュ・ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['cache-rule'] = 'cache-rule-1'
otd_deleteCacheRule(props)

関連項目

「help」、「otd_createCacheRule」、「otd_listCacheRules」

otd_deleteCompressionRule

説明

このコマンドを使用して、指定した名前を持つ圧縮ルールを削除します。

構文

otd_deleteCompressionRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

compression-rule

削除する圧縮ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['compression-rule'] = 'compression-rule-1'
otd_deleteCompressionRule(props)

関連項目

「help」、「otd_createCompressionRule」、「otd_getCompressionRuleProperties」、「otd_listCompressionRules」、「otd_setCompressionRuleProperties」

otd_deleteConfigFile

説明

このコマンドを使用して、既存の構成ファイルを削除します。

構文

otd_deleteConfigFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

config-file

削除する構成ファイルの名前。これは、仮想サーバーによって参照されるオブジェクト・ファイルおよびserver.xmlを除く既存の任意の構成ファイルにすることができます。

必須。

例

props = {}
props['configuration'] = 'foo'
props['config-file'] = 'bar.conf'
otd_deleteConfigFile(props)

関連項目

「help」、「otd_createConfiguration」、「otd_listConfigurations」、「activate」、「otd_copyConfiguration」、「otd_saveConfigFile」、「otd_deleteConfiguration」

otd_deleteConfiguration

説明

このコマンドを使用して、構成にインスタンスが関連付けられていない場合に構成を削除します。

構文

otd_deleteConfiguration(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

name

削除する構成の名前。

必須。

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

オフラインの場合は必須で、オンラインの場合は無効です。

例

# Online
props = {}
props['name'] = 'foo'
otd_deleteConfiguration(props)

# Offline
readDomain('/export/domains/otd_domain')
props = {}
props['name'] = 'foo'
otd_deleteConfiguration(props)
updateDomain()
closeDomain()

関連項目

「help」、「otd_createConfiguration」、「otd_listConfigurations」、「activate」、「otd_copyConfiguration」、「otd_saveConfigFile」、「otd_getConfigFile」

otd_deleteConfigurationWebappFirewallRulesetFile

説明

このコマンドを使用して、構成レベルでインストールされているWebアプリケーション・ファイアウォールのルールセット・ファイルを削除します。

構文

otd_deleteConfigurationWebappFirewallRulesetFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

ruleset-file

削除する必要があるルールセット・ファイルの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['ruleset-file'] = 'bar.conf'
otd_deleteConfigurationWebappFirewallRulesetFile(props)

関連項目

「help」、「otd_installVirtualServerWebappFirewallRulesetFile」、「otd_listVirtualServerWebappFirewallRulesetFiles」

otd_deleteContentRule

説明

このコマンドを使用して、コンテンツ・ルールを削除します。

構文

otd_deleteContentRule(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

content-rule

削除するコンテンツ・ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['content-rule'] = 'content-rule-1'
otd_deleteContentRule(props)

関連項目

「help」、「otd_getContentRuleProperties」、「otd_listContentRules」、「otd_createContentRule」、「otd_setContentRuleProperties」

otd_deleteCrl

説明

このコマンドを使用して、証明書失効リスト(CRL)を削除します。

構文

otd_deleteCrl(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

issuer

CRL発行者の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['issuer'] = 'CN=GlobalSign ServerSign CA,OU=ServerSign CA,O=GlobalSign nv-sa,C=BE'
otd_deleteCrl(props)

関連項目

「help」、「otd_installCrl」、「otd_listCrls」

otd_deleteErrorPage

説明

このコマンドを使用して、指定したエラー・コードに対応するエラー・ページを削除します。

構文

otd_deleteErrorPage(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

code

エラー・ページを削除するエラー・コード。
値の範囲: 400 - 599。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['code'] = '408'
otd_deleteErrorPage(props)

関連項目

「help」、「otd_createErrorPage」、「otd_listErrorPages」

otd_deleteEvent

説明

このコマンドを使用して、スケジュール済イベントを削除します。

構文

otd_deleteEvent(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event

イベントを一意に識別する名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event'] = 'event-1'
otd_deleteEvent(props)

関連項目

「help」、「otd_createEvent」、「otd_listEvents」、「otd_getEventProperties」、「otd_setEventProperties」

otd_deleteEventSubscription

説明

このコマンドを使用して、イベント・サブスクリプションを削除します。

構文

otd_deleteEventSubscription(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event-subscription

イベント・サブスクリプションのユーザー定義名。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event-subscription'] = 'bar'
otd_deleteEventSubscription(props)

関連項目

「help」、「otd_createEventSubscription」、「otd_getEventSubscriptionProperties」、「otd_setEventSubscriptionProperties」、「otd_listEventSubscriptions」

otd_deleteFailoverGroup

説明

このコマンドを使用して、指定したフェイルオーバー・グループを削除します。フェイルオーバー・グループのVIPまたは任意のプロパティを変更するには、フェイルオーバー・グループを削除してから新しく作成しなおす必要があります。

フェイルオーバー・グループを削除する際、管理ノード・プロセスがインスタンスの置かれているノードで非rootとして実行中であり、少なくとも1つのフェイルオーバー・グループが引き続き使用可能である場合、これらのノードでrootユーザーとしてotd_startFailoverを実行する必要があります。これは手動によるフェイルオーバーの再起動となります。それに対し、フェイルオーバー・グループを削除した後、対応するインスタンスに対して使用可能なフェイルオーバー・グループが他にない場合は、otd_stopFailoverを実行してフェイルオーバーを停止する必要があります。otd_startFailoverまたはotd_stopFailoverのいずれも実行しない場合、削除されたフェイルオーバー・グループに関連付けられたVIPが引き続き使用可能となります。

構文

otd_deleteFailoverGroup(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

削除するフェイルオーバー・グループのVIP。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-ip'] = '10.128.10.10'
otd_deleteFailoverGroup(props)

関連項目

「help」、「otd_createFailoverGroup」、「otd_toggleFailoverGroupPrimary」、「otd_getFailoverGroupProperties」、「otd_startFailover」、「otd_stopFailover」

otd_deleteHttpListener

説明

このコマンドを使用して、指定した名前を持つHTTPリスナー・ソケットを削除します。

構文

otd_deleteHttpListener(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

http-listener

削除するHTTPリスナーの名前。

必須。

force

HTTPリスナーの強制削除を有効にします。
デフォルト: false。

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
otd_deleteHttpListener(props)

関連項目

「help」、「otd_createHttpListener」、「otd_setHttpListenerProperties」、「otd_setHttpListenerProperties」、「otd_listHttpListeners」

otd_deleteInstance

説明

このコマンドを使用して、指定したインスタンスを削除します。

構文

otd_deleteInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

インスタンスが属する構成の名前。

必須。

instance

削除するインスタンスの名前。

必須。

注意:
このコマンドをオフライン・モードで実行する場合、インスタンス・ファイル・アーティファクトが削除されるのは、指定したマシンが管理サーバーと同じホスト上にある場合のみです。それ以外の場合、インスタンス・ファイル・アーティファクトは、管理サーバーとノード・マネージャの両方が起動した後に削除されます。

例

# Online
props = {}
props['configuration'] = 'foo'
props['instance'] = 'otd_foo_machine1'
otd_deleteInstance(props)

# Offline
readDomain('/export/.../domains/otd_domain')
props = {}
props['configuration'] = 'foo'
props['instance'] = 'otd_foo_machine1'
otd_deleteInstance(props)
updateDomain()
closeDomain()

関連項目

「help」、「otd_createInstance」、「otd_listInstances」、「start」、「stop」、「softRestart」

otd_deleteMimeType

説明

このコマンドを使用して、MIMEタイプを削除します。

構文

otd_deleteMimeType(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

content-type

MIMEタイプのコンテンツ・タイプ。

必須。

例

props = {}
props['configuration'] = 'foo'
props['content-type'] = 'bar'
otd_deleteMimeType(props)

関連項目

「help」、「otd_createMimeType」、「otd_listMimeTypes」

otd_deleteOriginServer

説明

このコマンドを使用して、指定したホストおよびポートを持つオリジン・サーバーを削除します。

構文

otd_deleteOriginServer(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

host

削除するオリジン・サーバーのIPアドレス/ホスト名。

必須。

port

削除するオリジン・サーバーのポート番号。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['host'] = 'www.example.com'
props['port'] = '12345'
otd_deleteOriginServer(props)

関連項目

「help」、「otd_deleteOriginServer」、「otd_listOriginServers」、「otd_getOriginServerProperties」、「otd_setOriginServerProperties」

otd_deleteOriginServerPool

説明

このコマンドを使用して、指定した名前を持つオリジン・サーバー・プールを削除します。

構文

otd_deleteOriginServerPool(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

削除するオリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_deleteOriginServerPool(props)

関連項目

「help」、「otd_listOriginServerPools」、「otd_deleteOriginServerPool」、「otd_getOriginServerPoolProperties」、「otd_setOriginServerPoolProperties」

otd_deleteRequestLimit

説明

このコマンドを使用して、指定した名前を持つリクエスト制限を削除します。

構文

otd_deleteRequestLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

リクエスト制限ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['request-limit'] = 'request-limit-1'
otd_deleteRequestLimit(props)

関連項目

「help」、「otd_createRequestLimit」、「otd_listRequestLimits」、「otd_getRequestLimitProperties」、「otd_setRequestLimitProperties」

otd_deleteRoute

説明

このコマンドを使用して、指定した名前を持つルートを削除します。

構文

otd_deleteRoute(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

削除するルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
otd_deleteRoute(props)

関連項目

「help」、「otd_createRoute」、「otd_listRoutes」、「otd_getRouteProperties」、「otd_setRouteProperties」

otd_deleteStandaloneInstance

説明

このコマンドを使用して、Oracle Traffic Directorスタンドアロン・ドメイン内で指定した名前を持つOracle Traffic Directorインスタンスを削除します。

このコマンドは、オフライン・モードでのみ実行できます。

構文

otd_deleteStandaloneInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

instance

削除するインスタンスの名前。

必須。

domain-home

Oracle Traffic Directorスタンドアロン・ドメインが含まれている必要があるドメイン・ディレクトリへのパス。

必須。

例

props = {}
props['instance'] = 'foo'
props['domain-home'] = '/export/domains/otd_standalone'
otd_deleteStandaloneInstance(props)

関連項目

「help」、「otd_createStandaloneDomain」、「otd_createStandaloneInstance」

otd_deleteTcpListener

説明

このコマンドを使用して、指定した名前を持つTCPリスナーを削除します。

構文

otd_deleteTcpListener(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

削除するTCPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
otd_deleteTcpListener(props)

関連項目

「help」、「otd_createTcpListener」、「otd_listTcpListeners」、「otd_getTcpListenerProperties」、「otd_setTcpListenerProperties」

otd_deleteTcpProxy

説明

このコマンドを使用して、指定した名前を持つTCPプロキシを削除します。

構文

otd_deleteTcpProxy(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-proxy

削除するTCPプロキシの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-proxy'] = 'bar'
otd_deleteTcpProxy(props)

関連項目

「help」、「otd_createTcpProxy」、「otd_listTcpProxies」、「otd_getTcpProxyProperties」、「otd_setTcpProxyProperties」

otd_deleteConfigurationVariable

説明

このコマンドを使用して、構成レベルで定義されている変数を削除します。

構文

otd_deleteConfigurationVariable(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

name

削除する変数の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['name'] = 'bar'
otd_deleteConfigurationVariable(props)

関連項目

「help」、「otd_createConfigurationVariable」、「otd_listVirtualServerVariables」

otd_deleteVirtualServer

説明

このコマンドを使用して、指定した名前を持つ仮想サーバーを削除します。

構文

otd_deleteVirtualServer(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

削除する仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_deleteVirtualServer(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_getVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」

otd_deleteVirtualServerVariable

説明

このコマンドを使用して、仮想サーバー・レベルで定義されている指定名を持つ変数を削除します。

構文

otd_deleteVirtualServerVariable(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

name

削除する変数の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['name'] = 'baz'
otd_deleteVirtualServerVariable(props)

関連項目

「help」、「otd_createConfigurationVariable」、「otd_listVirtualServerVariables」

otd_deleteVirtualServerWebappFirewallRulesetFile

説明

このコマンドを使用して、仮想サーバー・レベルでインストールされているWebアプリケーション・ファイアウォールのルールセット・ファイルを削除します。

構文

otd_deleteVirtualServerWebappFirewallRulesetFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

ruleset-filename

削除する必要があるルールセット・ファイルの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['ruleset-file'] = 'baz.conf'
otd_deleteVirtualServerWebappFirewallRulesetFile(props)

関連項目

「help」、「otd_installVirtualServerWebappFirewallRulesetFile」、「otd_listVirtualServerWebappFirewallRulesetFiles」

otd_disableOriginServerPoolMaintenance

説明

このコマンドを使用して、オリジン・サーバー・プールのメンテナンスを無効にします。

構文

otd_disableOriginServerPoolMaintenance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_disableOriginServerPoolMaintenance(props)

関連項目

「help」、「otd_enableOriginServerPoolMaintenance」、「otd_getOriginServerPoolMaintenanceProperties」

otd_disablePerfDump

説明

このコマンドを使用して、URIを介したperfdump出力へのアクセスを無効にします。

構文

otd_disablePerfDump(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disablePerfDump(props)

関連項目

「help」、「otd_enablePerfDump」、「otd_getPerfDumpProperties」

otd_disableRequestLimitEvents

説明

このコマンドを使用して、特定のリクエスト制限に対するイベントを無効にします。

構文

otd_disableRequestLimitEvents(props)

引数'props'は、次のプロパティを含める必要があるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

無効にするリクエスト制限の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['request-limit'] = 'request-limit-1'
otd_disableRequestLimitEvents(props)

関連項目

「help」、「otd_listRequestLimits」、「otd_deleteRequestLimit」、「otd_createRequestLimit」、「otd_setRequestLimitProperties」、「otd_enableRequestLimitEvents」、「otd_disableRequestLimitEvents」

otd_disableRouteAuth

説明

このコマンドを使用して、ルート認証を無効にします。

構文

otd_disableRouteAuth(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route'
otd_disableRouteAuth(props)

関連項目

「help」、「otd_enableRouteAuth」

otd_disableRouteBandwidthLimit

説明

このコマンドを使用して、ルート・レベルで帯域幅制限を無効にします。

構文

otd_disableRouteBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

type

無効にする帯域幅制限のタイプ。
値の範囲: requestまたはresponse。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['type'] = 'request'
otd_disableRouteBandwidthLimit(props)

関連項目

「help」、「otd_enableRouteBandwidthLimit」、「otd_getVirtualServerRequestBandwidthLimitProperties」

otd_disableStatsXml

説明

このコマンドを使用して、URIを介したXML形式の仮想サーバー統計へのアクセスを無効にします。

構文

otd_disableStatsXml(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disableStatsXml(props)

関連項目

「help」、「otd_getStatsXml」、「otd_getStatsXmlProperties」、「otd_enableStatsXml」

otd_disableStatusListener

説明

このコマンドを使用して、インスタンスのステータス・リスナーを無効にします。

構文

otd_disableStatusListener

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_disableStatusListener(props)

関連項目

「otd_enableStatusListener」、「otd_getStatusListenerProperties」、「otd_getStatusListenerSslProperties」、「otd_setStatusListenerSslProperties」

otd_disableVirtualServerAccessLog

説明

このコマンドを使用して、仮想サーバーのアクセス・ログを無効にします。

構文

otd_disableVirtualServerAccessLog(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disableVirtualServerAccessLog(props)

関連項目

「help」、「otd_enableVirtualServerAccessLog」、「otd_getVirtualServerAccessLogProperties」

otd_disableWebAppFirewall

説明

このコマンドを使用して、仮想サーバーのWebアプリケーション・ファイアウォールを無効にします。

構文

otd_disableWebAppFirewall(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disableWebappFirewall(props)

関連項目

「help」、「otd_enableWebAppFirewall」、「otd_getWebappFirewallProperties」

otd_disableVirtualServerRequestBandwidthLimit

説明

このコマンドを使用して、仮想サーバー・レベルでリクエスト帯域幅制限を無効にします。

構文

otd_disableVirtualServerRequestBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disableVirtualServerRequestBandwidthLimit(props)

関連項目

「help」、「otd_enableVirtualServerRequestBandwidthLimit」、「otd_getVirtualServerRequestBandwidthLimitProperties」

otd_disableVirtualServerResponseBandwidthLimit

説明

このコマンドを使用して、仮想サーバー・レベルでレスポンス帯域幅制限を無効にします。

構文

otd_disableVirtualServerResponseBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_disableVirtualServerResponseBandwidthLimit(props)

関連項目

「help」、「otd_enableVirtualServerResponseBandwidthLimit」、「otd_getVirtualServerRequestBandwidthLimitProperties」

otd_enableOriginServerPoolMaintenance

説明

このコマンドを使用して、オリジン・サーバー・プールのメンテナンスを有効にします。

構文

otd_enableOriginServerPoolMaintenance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

response-code

メンテナンスが有効なオリジン・サーバー・プールにリクエストが到達するときの、レスポンス・コードを指定します。
これが構成されていない場合、その暗黙的な値は、response-fileが指定されている場合は200、それ以外は503です。

response-code 200は、response-fileが構成されていない場合は許可されません。

response-file

メンテナンスが有効なオリジン・サーバー・プールにリクエストが到達するときに、クライアントに送信するHTMLファイルの絶対パス。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['response-code'] = '503'
otd_enableOriginServerPoolMaintenance(props)

関連項目

「help」、「otd_disableOriginServerPoolMaintenance」、「otd_getOriginServerPoolMaintenanceProperties」

otd_enablePerfDump

説明

URIを介したperfdump出力へのアクセスを有効にします。perfdumpユーティリティは、Oracle Traffic Directorのパフォーマンス・データを収集してASCII形式で表示します。このユーティリティによって、より多くの種類の統計を監視できます。perfdumpでは、統計が統合されます。単一のプロセスを監視するのではなく、統計はプロセスの数に応じて増加します。このため、サーバー・パフォーマンスのより正確なビューが提供されます。

構文

otd_enablePerfDump(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

uri

perfdumpレポートを使用可能にするURI。
デフォルト: /.perf。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_enablePerfDump(props)

関連項目

「help」、「otd_getPerfDump」、「otd_getPerfDumpProperties」、「otd_disablePerfDump」

otd_enableRequestLimitEvents

説明

このコマンドを使用して、指定したリクエスト制限に対するイベントを有効にします。

構文

otd_enableRequestLimitEvents(props)

引数'props'は、次のプロパティを含める必要があるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

有効にするリクエスト制限の名前。

必須。

event-notification-interval

時間間隔(秒)。通知メッセージは、間隔ごとにサブスクライバに送信され、構成されたリクエスト制限を超えたすべての監視に関する情報が含まれます。
範囲: 1から32767の両端の値を含む秒単位の間隔

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['request-limit'] = 'request-limit-1'
props['event-notification-interval'] = '60'
otd_enableRequestLimitEvents(props)

関連項目

「help」、「otd_listRequestLimits」、「otd_deleteRequestLimit」、「otd_createRequestLimit」、「otd_setRequestLimitProperties」、「otd_enableRequestLimitEvents」、「otd_disableRequestLimitEvents」

otd_enableRouteAuth

説明

このコマンドを使用して、ルート認証を有効にします。

構文

otd_enableRouteAuth(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

auth-user

認証ユーザーを指定します。

必須。

auth-password

ユーザーのパスワードを指定します。

必須。

auth-header

認証ヘッダーの名前を指定します。
デフォルトはAuthorizationです。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['auth-user'] = 'baz'
props['auth-password'] = 'qux'
otd_enableRouteAuth(props)

関連項目

「help」、「otd_disableRouteAuth」

otd_enableRouteBandwidthLimit

説明

このコマンドを使用して、ルート・レベルで帯域幅制限を有効にします。

構文

otd_enableRouteBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

帯域幅制限を有効にする仮想サーバーの名前。

必須。

route

帯域幅制限を有効にするルートの名前。

必須。

type

適用する帯域幅制限のタイプ。
値の範囲: requestまたはresponse。

必須。

max-bps-per-monitor

バケット全体の最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

max-bps-per-connection

接続当たりの最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

timeout

秒単位の値。リクエストがキュー内で待機した時間がこの長さに達すると、リクエストは中断されます。
デフォルト: 60。

monitor

リクエストが属するバケットの名前。
デフォルト: タイプがresponseである場合は$ip。

error-code

リクエストが中断されたときに返されるHTTPエラー・コード。
値の範囲: 400-599。

デフォルト: 503。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['type'] = 'request'
props['max-bps-per-monitor'] = '512'
otd_enableRouteBandwidthLimit(props)

関連項目

「help」、「otd_disableRouteBandwidthLimit」、「otd_getWebappFirewallProperties」

otd_enableStatsXml

説明

このコマンドを使用して、URIを介したXML形式の仮想サーバー統計へのアクセスを有効にします。

構文

otd_enableStatsXml(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

uri

XML形式の統計レポートを使用可能にするURI。
デフォルト: /stats-xml。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_enableStatsXml(props)

関連項目

「help」、「otd_getStatsXml」、「otd_getStatsXmlProperties」、「otd_disableStatsXml」

otd_enableStatusListener

説明

このコマンドを使用して、ステータス・チェック・リクエストに対するリスナーを有効にします。さらに、このコマンドを使用して、有効なステータス・リスナーのプロパティを変更します。

構文

otd_enableStatusListener

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

port

リスニングするポート。
値の範囲: 1から65535の両端の値を含むポート番号。

必須。

ip

リスニングするIPアドレス。
値の範囲: ホスト名またはIPアドレス。

family

プロトコル・ファミリ。
値の範囲: default、inetまたはinet6。

デフォルト: default

例

props = {}
props['configuration'] = 'foo'
props['port'] = '12345'
otd_enableStatusListener(props)

関連項目

「otd_disableStatusListener」、「otd_getStatusListenerProperties」、「otd_getStatusListenerSslProperties」、「otd_setStatusListenerSslProperties」

otd_enableWebAppFirewall

説明

このコマンドを使用して、特定の仮想サーバーのWebアプリケーション・ファイアウォールを有効にします。

構文

otd_enableWebAppFirewall(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_enableWebappFirewall(props)

関連項目

「help」、「otd_disableWebAppFirewall」、「otd_getWebappFirewallProperties」

otd_enableVirtualServerAccessLog

説明

このコマンドを使用して、仮想サーバーのアクセス・ログを有効にします。

構文

otd_VirtualServerAccessLog(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

log-file

この構成のアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log

format

形式は、アクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト:

%Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

log-ip

クライアントのIPアドレスをアクセス・ログに記録するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['log-file'] = 'logs/access.log'
otd_enableVirtualServerAccessLog(props)

関連項目

「help」、「otd_getVirtualServerAccessLogProperties」、「otd_disableVirtualServerAccessLog」

otd_enableVirtualServerRequestBandwidthLimit

説明

このコマンドを使用して、仮想サーバー・レベルでリクエスト帯域幅制限を有効にします。

構文

otd_enableVirtualServerRequestBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

帯域幅制限を有効にする仮想サーバーの名前。

必須。

max-bps-per-monitor

バケット全体の最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

max-bps-per-connection

接続当たりの最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

timeout

秒単位の値。リクエストがキュー内で待機した時間がこの長さに達すると、リクエストは中断されます。
デフォルト: 60。

monitor

リクエストが属するバケットの名前。
デフォルト: タイプがresponseである場合は$ip。

error-code

リクエストが中断されたときに返されるHTTPエラー・コード。
値の範囲: 400-599。

デフォルト: 503。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['max-bps-per-monitor'] = '1024'
otd_enableVirtualServerRequestBandwidthLimit(props)

関連項目

「help」、「otd_disableVirtualServerRequestBandwidthLimit」、「otd_getWebappFirewallProperties」

otd_enableVirtualServerResponseBandwidthLimit

説明

このコマンドを使用して、仮想サーバー・レベルでレスポンス帯域幅制限を有効にします。

構文

otd_enableVirtualServerResponseBandwidthLimit(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

帯域幅制限を有効にする仮想サーバーの名前。

必須。

max-bps-per-monitor

バケット全体の最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

max-bps-per-connection

接続当たりの最大リクエスト帯域幅のバイト/秒単位の値。
デフォルト: 0。

0に設定すると、帯域幅制限が適用されないことを意味します。

timeout

秒単位の値。リクエストがキュー内で待機した時間がこの長さに達すると、リクエストは中断されます。
デフォルト: 60。

monitor

リクエストが属するバケットの名前。
デフォルト: タイプがresponseである場合は$ip。

error-code

リクエストが中断されたときに返されるHTTPエラー・コード。
値の範囲: 400-599。

デフォルト: 503。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['max-bps-per-monitor'] = '1024'
otd_enableVirtualServerResponseBandwidthLimit(props)

関連項目

「help」、「otd_disableVirtualServerRequestBandwidthLimit」、「otd_getWebappFirewallProperties」

otd_exportKeyStore

説明

このコマンドを使用して、構成のconfigディレクトリに配置されるOracleウォレットにキーストア内のすべての証明書をエクスポートします。ウォレット・パスワードが設定されている場合、エクスポートしたウォレットはパスワードで保護されたウォレット(ewallet.p12)ですが、そうでない場合は、自動ログイン専用のウォレット(cwallet.sso)です。

構文

otd_exportKeyStore(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_exportKeyStore(props)

関連項目

「help」、「exportKeyStoreCertificateRequest」、「deleteKeyStoreEntry」、「importKeyStoreCertificate」、「getKeyStoreCertificates」、「generateKeyPair」

otd_forwardProxyInfo

説明

このコマンドを使用して、プロキシ情報を転送します。特定のプロキシ・パラメータに関する情報が生成され、HTTPヘッダーを使用してオリジン・サーバーに転送されます。デフォルトで使用されるHTTPヘッダーは、オリジン・サーバーがOracle WebLogic Serverであるかどうかに応じて異なります。

パラメータ名

説明

WLSのデフォルトのHTTPヘッダー

WLS以外のデフォルトのHTTPヘッダー

jroute

セッションの固定性を実装するためにset-origin-server関数と一部のサーブレット・コンテナによって使用されるリクエスト・ルーティングに関する情報。

Proxy-jroute

Proxy-jroute

via

リクエストのルーティングに関与していたプロキシ・サーバーおよびプロトコル・バージョン。

Via

Via

ip

クライアントの実際のIPアドレス。

Wl-proxy-client-ip

Client-ip

xforwarded-for

プロキシを介して接続する元のクライアントIPを追跡するために使用されます。

X-forwarded-for

X-forwarded-for

proxy-agent

プロキシ・サーバーの説明名およびバージョン。

Proxy-agent

Proxy-agent

cache-info

クライアントのキャッシュ・ヒット数。

Cache-info

Cache-info

ssl

クライアント接続がSSLを介して行われたかどうかを示すtrue/falseの値

Wl-proxy-ssl

Proxy-ssl

cipher

クライアントのSSL/TLS暗号スイート。

Proxy-cipher

Proxy-cipher

keysize

クライアントのSSL/TLS鍵サイズ。

Wl-Proxy-client-keysize

Proxy-keysize

secret-keysize

クライアントのSSL/TLS秘密鍵のサイズ。

Wl-proxy-client-secretkeysize

Proxy-secret-keysize

ssl-id

クライアントのSSL/TLSセッションID。

Proxy-ssl-id

Proxy-ssl-id

auth-cert

クライアントのX.509形式のSSL/TLS証明書。

Wl-proxy-client-cert

Proxy-auth-cert

user-dn

クライアントのSSL/TLS証明書のサブジェクトの識別名。

Proxy-user-dn

Proxy-user-dn

issuer-dn

クライアントのSSL/TLS証明書の発行者の識別名。

Proxy-issuer-dn

Proxy-issuer-dn

構文

otd_forwardProxyInfo(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

param

ブロックするプロキシ・パラメータの名前。
値の範囲: jroute、via、ip、cipher、proxy-agent、keysize、secret-keysize、ssl-id、issuer-dn、user-dn、auth-cert、xforwarded-for、cache-info、ssl。

必須。

header

プロキシ・パラメータをオリジン・サーバーに送信するために使用されるHTTPヘッダーの名前。
デフォルト: 指定したプロキシ・パラメータに対応するデフォルトのHTTPヘッダー。

必須。

注意:
受信リクエストに指定したヘッダーが含まれる場合、オリジン・サーバーに転送されるリクエスト内のヘッダーが、生成されたヘッダーに置き換えられます。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['param'] = 'via'
otd_forwardProxyInfo(props)

関連項目

「help」、「otd_listProxyInfo」、「otd_blockProxyInfo」

otd_getAccessLogBufferProperties

説明

このコマンドを使用して、アクセス・ログ・バッファのプロパティを表示します。このコマンドによって返されるプロパティはotd_setAccessLogBufferPropertiesで説明されています。

構文

otd_getAccessLogBufferProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getAccessLogBufferProperties(props)

関連項目

「help」、「otd_setAccessLogBufferProperties」、「otd_enableVirtualServerAccessLog」、「otd_disableVirtualServerAccessLog」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

otd_getCacheProperties

説明

このコマンドを使用して、キャッシュ・プロパティを表示します。このコマンドによって返されるプロパティはotd_setCachePropertiesで説明されています。

構文

otd_getCacheProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getCacheProperties(props)

関連項目

「help」、「otd_setCacheProperties」

otd_getCacheRuleProperties

説明

このコマンドを使用して、キャッシュ・ルールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setCacheRulePropertiesで説明されています。

構文

otd_getCacheRuleProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

cache-rule

キャッシュ・ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['cache-rule'] = 'cache-rule-1'
otd_getCacheRuleProperties(props)

関連項目

「help」、「otd_setCacheProperties」、「otd_setCacheRuleProperties」

otd_getCompressionRuleProperties

説明

このコマンドを使用して、圧縮ルールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setCompressionRulePropertiesで説明されています。

構文

otd_getCompressionRuleProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

compression-rule

圧縮ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['compression-rule'] = 'compression-rule-1'
otd_getCompressionRuleProperties(props)

関連項目

「help」、「otd_createCompressionRule」、「otd_deleteCompressionRule」、「otd_listCompressionRules」、「otd_setCompressionRuleProperties」

otd_getConfigFile

説明

このコマンドを使用して、構成ファイルのコンテンツを表示します。

構文

otd_getConfigFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

config-file

フェッチする必要がある構成ファイルの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['config-file'] = 'foo-obj.conf'
otd_getConfigFile(props)

関連項目

「help」、「otd_createConfiguration」、「otd_listConfigurations」、「activate」、「otd_copyConfiguration」、「otd_saveConfigFile」、「otd_deleteConfiguration」

otd_getConfigurationAccessLogProperties

説明

このコマンドを使用して、構成の次のアクセス・ログのプロパティを表示します。

プロパティ

説明

file

この構成のアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log

format

形式は、アクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

default-access-log-format

アクセス・ログ・エントリのデフォルトの形式:
%Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

構文

otd_getConfigurationAccessLogProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getConfigurationAccessLogProperties(props)

関連項目

「help」、「otd_setConfigurationAccessLogProperties」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

otd_getConfigurationCrlProperties

説明

このコマンドを使用して、証明書失効リスト(CRL)のプロパティを表示します。このコマンドによって返されるプロパティはotd_setConfigurationCrlPropertiesで説明されています。

構文

otd_getConfigurationCrlProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getConfigurationCrlProperties(props)

関連項目

「help」、「otd_setConfigurationCrlProperties」

otd_getConfigurationProperties

説明

このコマンドを使用して、構成プロパティを表示します。このコマンドによって返されるプロパティはotd_setConfigurationPropertiesで説明されています。

構文

otd_getConfigurationProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getConfigurationProperties(props)

関連項目

「help」、「otd_setConfigurationProperties」

otd_getContentRuleProperties

説明

このコマンドを使用して、コンテンツ・ルールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setContentRulePropertiesで説明されています。

構文

otd_getContentRuleProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

content-rule

コンテンツ・ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['content-rule'] = 'content-rule-1'
otd_getContentRuleProperties(props)

関連項目

「help」、「otd_setContentRuleProperties」、「otd_listContentRules」

otd_getDnsCacheProperties

説明

このコマンドを使用して、ドメイン・ネーム・サーバー(DNS)のキャッシュ・プロパティを表示します。このコマンドによって返されるプロパティはotd_setDnsCachePropertiesで説明されています。

構文

otd_getDnsCacheProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getDnsCacheProperties(props)

関連項目

「help」、「otd_setDnsCacheProperties」

otd_getDnsProperties

説明

このコマンドを使用して、ドメイン・ネーム・サーバー(DNS)のプロパティを表示します。DNSは、192.0.3.11などの標準IPアドレスを、www.example.comなどのホスト名に関連付けます。このコマンドによって返されるプロパティはotd_setDnsPropertiesで説明されています。

構文

otd_getDnsProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getDnsProperties(props)

関連項目

「help」、「otd_setDnsProperties」

otd_getEventProperties

説明

このコマンドを使用して、イベント・プロパティを取得します。このコマンドによって返されるプロパティはotd_setEventPropertiesで説明されています。

構文

otd_getEventProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event

イベントの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event'] = 'bar'
otd_getEventProperties(props)

関連項目

「help」、「otd_deleteEvent」、「otd_listEvents」、「otd_setEventProperties」

otd_getEventSubscriptionProperties

説明

このコマンドを使用して、イベント・サブスクリプション・プロパティを取得します。

構文

otd_getEventSubscriptionProperties

引数propsは、次のキーを含める必要があるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event-subscription

イベント・サブスクリプションのユーザー定義名。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event-subscription'] = 'bar'
otd_getEventSubscriptionProperties(props)

関連項目

「help」、「otd_createEventSubscription」、「otd_deleteEventSubscription」、「otd_setEventSubscriptionProperties」、「otd_listEventSubscriptions」

otd_getFileCacheProperties

説明

このコマンドを使用して、ファイル・キャッシュ・プロパティを表示します。このコマンドによって返されるプロパティはotd_setFileCachePropertiesで説明されています。

構文

otd_getFileCacheProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getFileCacheProperties(props)

関連項目

「help」、「otd_setFileCacheProperties」

otd_getFailoverGroupProperties

説明

このコマンドを使用して、フェイルオーバー・グループの次のプロパティを表示します。

プロパティ

説明

コメント

virtual-ip

フェイルオーバーの作成対象のVIP。VIPは、フェイルオーバー・グループのノードと同じサブネットに属している必要があり、クライアントからアクセスできる必要があります。
値の範囲: ホスト名またはIPv4/IPv6アドレス。

必須。

primary-instance

プライマリとして指定されている既存のインスタンス。
このプロパティは、フェイルオーバー・タイプがアクティブ-パッシブの場合のみ有効であることに注意してください。

必須。

backup-instance

バックアップとして指定されている既存のインスタンス。
このプロパティは、フェイルオーバー・タイプがアクティブ-パッシブの場合のみ有効であることに注意してください。

必須。

primary-nic

VIPを管理する必要のある、プライマリ・インスタンスが実行されているノード上のネットワーク・インタフェース。
このプロパティは、フェイルオーバー・タイプがアクティブ-パッシブの場合のみ有効であることに注意してください。

必須。

backup-nic

VIPを管理する必要のある、バックアップ・インスタンスが実行されているノード上のネットワーク・インタフェース。
このプロパティは、フェイルオーバー・タイプがアクティブ-パッシブの場合のみ有効であることに注意してください。

必須。

router-id

VRRPの必要性は、VIPのフェイルオーバーに参加しているVRRPルーター・グループを識別します。値は、フェイルオーバー・グループ全体で一意にする必要があります。
値の範囲: 正の整数。有効な範囲は1 - 255です。

デフォルト: 1 - 255のランダムな数値

failover-type

フェイルオーバー・グループ・タイプ。
値: 「アクティブ-パッシブ」、「アクティブ-アクティブ」。

デフォルト値: 「アクティブ-パッシブ」。

注意: このプロパティはLinuxプラットフォームでのみ有効です。

instances

カンマ区切りの、フェイルオーバー・インスタンスの降順優先度のリスト。
注意: このプロパティはLinuxプラットフォームでのみ有効です。

構文

otd_getFailoverGroupProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

フェイルオーバー・グループを一意に識別する仮想IP。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-ip'] = '192.0.2.1'
otd_getFailoverGroupProperties(props)

関連項目

「help」、「otd_deleteFailoverGroup」、「otd_createFailoverGroup」、「otd_toggleFailoverGroupPrimary」

otd_getHealthCheckProperties

説明

このコマンドを使用して、ヘルス・チェックのプロパティを表示します。このコマンドによって返されるプロパティはotd_setHealthCheckPropertiesで説明されています。

構文

otd_getHealthCheckProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_getHealthCheckProperties(props)

関連項目

「help」、「otd_setHealthCheckProperties」

otd_getHttpListenerProperties

説明

このコマンドを使用して、HTTPリスナーのプロパティを表示します。このコマンドによって返されるプロパティはotd_setHttpListenerPropertiesで説明されています。

構文

otd_getHttpListenerProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

http-listener

HTTPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
otd_getHttpListenerProperties(props)

関連項目

「help」、「otd_createHttpListener」、「otd_setHttpListenerProperties」、「otd_listHttpListeners」、「otd_deleteHttpListener」

otd_getHttpListenerSslProperties

説明

このコマンドを使用して、HTTPリスナーのSecure Sockets Layer (SSL)のプロパティを表示します。SSLは、クライアントとサーバー間にセキュアな接続を確立するソフトウェア・ライブラリです。SSLは、HTTPのセキュア・バージョンであるHTTPSを実装するために使用されます。

このコマンドによって返されるプロパティはotd_setHttpListenerSslPropertiesで説明されています。

構文

otd_getHttpListenerSslProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

http-listener

HTTPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
otd_getHttpListenerSslProperties(props)

関連項目

「help」、「otd_setHttpListenerSslProperties」

otd_getHttpProperties

説明

このコマンドを使用して、HTTPプロパティを表示します。このコマンドによって返されるプロパティはotd_setHttpPropertiesで説明されています。

構文

otd_getHttpProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getHttpProperties(props)

関連項目

「help」、「otd_setHttpProperties」

otd_getHttpThreadPoolProperties

説明

このコマンドを使用して、スレッド・プールのプロパティを表示します。スレッド・プールを使用して、一定数のスレッドを特定のサービスに割り当てることができます。スレッドの最大数を1とするプールを定義することで、指定したサービス機能に対して1つのリクエストのみを許可できます。このコマンドによって返されるプロパティはotd_setHttpThreadPoolPropertiesで説明されています。

構文

otd_getHttpThreadPoolProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getHttpThreadPoolProperties(props)

関連項目

「help」、「otd_setHttpThreadPoolProperties」

otd_getKeepaliveProperties

説明

このコマンドを使用して、キープ・アライブのプロパティを表示します。Oracle Traffic Directorのキープ・アライブまたはHTTP/1.1の永続接続処理サブシステムは、スケーラブルに設計されています。構成が必要度に一致していないと、ワークロードが永続的ではない場合(つまり、KeepAliveヘッダーのないHTTP/1.0である場合)、またはキープ・アライブ接続を主に提供する負荷の軽いシステムの場合、パフォーマンスが最適な状態に至らない可能性があります。このコマンドによって返されるプロパティはotd_setKeepalivePropertiesで説明されています。

構文

otd_getKeepAliveProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getKeepaliveProperties(props)

関連項目

「help」、「otd_setKeepaliveProperties」

otd_getLogProperties

説明

このコマンドを使用して、ログ・プロパティを表示します。このコマンドによって返されるプロパティはotd_setLogPropertiesで説明されています。

構文

otd_getLogProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getLogProperties(props)

関連項目

「help」、「otd_setLogProperties」

otd_getOriginServerPoolMaintenanceProperties

説明

このコマンドを使用して、オリジン・サーバー・プールのメンテナンスのプロパティを表示します。このコマンドによって返されるプロパティはotd_enableOriginServerPoolMaintenanceで説明されています。

構文

otd_getOriginServerPoolMaintenanceProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_getOriginServerPoolMaintenanceProperties(props)

関連項目

「help」、「otd_disableOriginServerPoolMaintenance」、「otd_enableOriginServerPoolMaintenance」

otd_getOriginServerPoolProperties

説明

このコマンドを使用して、オリジン・サーバー・プールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setOriginServerPoolPropertiesで説明されています。

構文

otd_getOriginServerPoolProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_getOriginServerPoolProperties(props)

関連項目

「help」、「otd_createOriginServerPool」、「otd_deleteOriginServerPool」、「otd_listOriginServerPools」、「otd_setOriginServerPoolProperties」

otd_getOriginServerProperties

説明

このコマンドを使用して、オリジン・サーバーのプロパティを表示します。このコマンドによって返されるプロパティはotd_setOriginServerPoolPropertiesで説明されています。

構文

otd_getOriginServerProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

host

オリジン・サーバーのIPアドレス/ホスト名。

必須。

port

オリジン・サーバーのポート番号。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['host'] = 'www.example.com'
props['port'] = '12345'
otd_getOriginServerProperties(props)

関連項目

「help」、「otd_createOriginServer」、「otd_deleteOriginServer」、「otd_listOriginServers」、「otd_setOriginServerProperties」

otd_getOriginServerPoolSslProperties

説明

このコマンドを使用して、オリジン・サーバーのSSLのプロパティを表示します。このコマンドによって返されるプロパティはotd_setOriginServerPoolSslPropertiesで説明されています。

構文

otd_getOriginServerPoolSslProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_getOriginServerPoolSslProperties(props)

関連項目

「help」、「otd_setOriginServerPoolSslProperties」

otd_getPartitionAccessLogProperties

説明

このコマンドを使用して、パーティションの次のアクセス・ログのプロパティを表示します。

プロパティ

説明

log-file

パーティションのアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/$PARTITION_NAME.log

format

形式は、パーティションのアクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

default-access-log-format

パーティションのアクセス・ログ・エントリのデフォルトの形式:
%Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

構文

otd_getPartitionAccessLogProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。これは、Oracle Traffic Directorランタイムをライフサイクル・マネージャに登録する際に指定する構成の名前である必要があります。

必須。

partition

パーティションの名前。

必須。

例

props = {}
props['configuration'] = 'mt'
props['partition'] = 'WLSPartition'
otd_getPartitionAccessLogProperties(props)

関連項目

「help」、「otd_listPartitions」、「otd_setPartitionAccessLogProperties」

otd_getPerfDump

説明

このコマンドを使用して、ブラウザ上で様々なサブシステムのランタイム統計をテキスト・レポートとして表示します。

構文

otd_getPerfDump(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

instance-name

インスタンスの名前。

必須。

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス

オフラインの場合は必須で、オンラインの場合は無効です。

例

# Online
props = {}
props['instance-name'] = 'otd_abc123.example.com'
otd_getPerfDump(props)

# Offline
props = {}
props['domain-home'] = '/export/domains/otd_domain'
props['instance-name'] = 'otd_abc123.example.com'
otd_getPerfDump(props)

関連項目

「help」、「otd_getPerfDumpProperties」、「otd_enablePerfDump」、「otd_disablePerfDump」

otd_getPerfDumpProperties

説明

このコマンドを使用して、次のperfdumpプロパティを取得します。

プロパティ

説明

コメント

enabled

perfdumpが有効かどうか。
デフォルトはfalseです。

必須。

uri

perfdumpレポートを使用可能にするURI。
デフォルト: /.perf。

必須。

構文

otd_getPerfDumpProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getPerfDumpProperties(props)

関連項目

「help」、「otd_getPerfDump」、「otd_enablePerfDump」、「otd_disablePerfDump」

otd_getRequestLimitProperties

説明

このコマンドを使用して、リクエスト制限のプロパティを表示します。このコマンドによって返されるプロパティはotd_setRequestLimitPropertiesで説明されています。

構文

otd_getRequestLimitProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

リクエスト制限ルールの名前。

必須。

event-notification-interval

時間間隔(秒)。通知メッセージは、間隔ごとにサブスクライバに送信され、構成されたリクエスト制限を超えたすべての監視に関する情報が含まれます。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['request-limit'] = 'request-limit-1'
otd_getRequestLimitProperties(props)

関連項目

「help」、「otd_listRequestLimits」、「otd_deleteRequestLimit」、「otd_createRequestLimit」、「otd_setRequestLimitProperties」、「otd_enableRequestLimitEvents」、「otd_disableRequestLimitEvents」

otd_getRouteAuthProperties

説明

このコマンドを使用して、次のルート認証のプロパティを表示します。

プロパティ

説明

コメント

auth-user

認証ユーザーを指定します。

必須。

auth-header

認証ヘッダーの名前を指定します。
デフォルトはAuthorizationです。

構文

otd_getRouteAuthProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
otd_getRouteAuthProperties(props)

関連項目

「help」、「otd_disableRouteAuth」、「otd_enableRouteAuth」、「otd_disableRouteAuth」

otd_getRouteBandwidthLimitProperties

説明

このコマンドを使用して、ルート・レベルで帯域幅制限のプロパティを取得します。

構文

otd_getRouteBandwidthLimitProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

type

帯域幅制限のタイプ。
値の範囲: requestまたはresponse。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['type'] = 'request'
otd_getRouteBandwidthLimitProperties(props)

関連項目

「help」、「otd_enableRouteBandwidthLimit」、「otd_disableRouteBandwidthLimit」

otd_getRouteProperties

説明

このコマンドを使用して、ルート・プロパティを表示します。このコマンドによって返されるプロパティはotd_setRoutePropertiesで説明されています。

構文

otd_getRouteProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
otd_getRouteProperties(props)

関連項目

「help」、「otd_createRoute」、「otd_listRoutes」、「otd_setRouteProperties」、「otd_deleteRoute」

otd_getSnmpProperties

説明

このコマンドを使用して、Simple Network Management Protocol (SNMP)のプロパティを表示します。このコマンドによって返されるプロパティはotd_setSnmpPropertiesで説明されています。

構文

otd_getSnmpProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getSnmpProperties(props)

関連項目

「help」、「otd_stopSnmpSubAgent」、「otd_startSnmpSubAgent」、「otd_setSnmpProperties」

otd_getSslSessionCacheProperties

説明

このコマンドを使用して、SSLセッション・データのキャッシング用に現在定義されているプロパティを表示します。このコマンドによって返されるプロパティはotd_setSslSessionCachePropertiesで説明されています。

構文

otd_getSslSessionCacheProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getSslSessionCacheProperties(props)

関連項目

「help」、「otd_setSslSessionCacheProperties」

otd_getStatsProperties

説明

このコマンドを使用して、統計収集サブシステムのプロパティを表示します。このコマンドによって返されるプロパティはotd_setStatsPropertiesで説明されています。

構文

otd_getStatsProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getStatsProperties(props)

関連項目

「help」、「otd_setStatsProperties」

otd_getStatsXml

説明

このコマンドを使用して、XML形式の様々なサブシステムのランタイム統計を表示します。

構文

otd_getStatsXml(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

instance

インスタンスの名前。

必須。

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

オフラインの場合は必須で、オンラインの場合は無効です。

例

オンライン構文:

props = {}
props['instance'] = 'otd_foo_machine1'
otd_getStatsXml(props)

オフライン構文:

props = {}
props['domain-home'] = '/export/domains/otd_domain'
props['instance'] = 'otd_foo_machine1'
otd_getStatsXml(props)

関連項目

「help」、「otd_getStatsXmlProperties」、「otd_enableStatsXml」、「otd_disableStatsXml」

otd_getStatsXmlProperties

説明

このコマンドを使用して、XML形式で統計データを収集およびレポートするために定義された次のプロパティを表示します。

プロパティ

説明

デフォルト

enabled

URIを通じたXML形式の仮想サーバー統計へのアクセスが有効かどうか。

false

uri

XML形式の統計レポートを使用可能にするURI。

/stats-xml

構文

otd_getStatsXmlProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getStatsXmlProperties(props)

関連項目

「help」、「otd_enableStatsXml」、「otd_disableStatsXml」

otd_getStatusListenerProperties

説明

このコマンドを使用して、ステータス・リスナーのプロパティを表示します。

構文

otd_getStatusListenerProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

デフォルト

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getStatusListenerProperties(props)

関連項目

「otd_enableStatusListener」、「otd_disableStatusListener」、「otd_getStatusListenerSslProperties」、「otd_setStatusListenerSslProperties」

otd_getStatusListenerSslProperties

説明

このコマンドを使用して、ステータス・リスナーのSSLプロパティを表示します。

構文

otd_getStatusListenerSslProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getStatusListenerSslProperties(props)

関連項目

「otd_enableStatusListener」、「otd_disableStatusListener」、「otd_getStatusListenerProperties」、「otd_setStatusListenerSslProperties」

otd_getTcpAccessLogProperties

説明

このコマンドを使用して、TCPアクセス・ログの次のプロパティを表示します。このコマンドによって返されるプロパティはotd_setTcpAccessLogPropertiesで説明されています。

プロパティ

説明

file

この構成のアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/tcp-access.log

構文

otd_getTcpAccessLogProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getTcpAccessLogProperties(props)

関連項目

「help」、「otd_setTcpAccessLogProperties」

otd_getTcpListenerProperties

説明

このコマンドを使用して、TCPリスナーのプロパティを表示します。このコマンドによって返されるプロパティはotd_setTcpListenerPropertiesで説明されています。

構文

otd_getTcpListenerProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

TCPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
otd_getTcpListenerProperties(props)

関連項目

「help」、「otd_createTcpListener」、「otd_deleteTcpListener」、「otd_listTcpListeners」、「otd_setTcpListenerProperties」

otd_getTcpListenerSslProperties

説明

このコマンドを使用して、TCPリスナーのSecure Sockets Layer (SSL)のプロパティを表示します。SSLは、クライアントとサーバー間にセキュアな接続を確立するソフトウェア・ライブラリです。SSLは、HTTPのセキュア・バージョンであるHTTPSを実装するために使用されます。

このコマンドによって返されるプロパティはotd_setTcpListenerSslPropertiesで説明されています。

構文

otd_getTcpListenerSslProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

TCPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
otd_getTcpListenerSslProperties(props)

関連項目

「help」、「otd_setTcpListenerSslProperties」

otd_getTcpProxyProperties

説明

このコマンドを使用して、TCPプロキシのプロパティを表示します。

TCPプロキシがprotocolにftpを指定して作成された場合、このコマンドを使用して、TCPプロキシのFTP接続プロパティを取得することもできます。

構文

otd_getTcpProxyProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-proxy

公開されたTCPサービスを一意に識別する名前。

必須。

このコマンドによって返されるプロパティはotd_setTcpProxyPropertiesで説明されています。

例

props = {}
props['configuration'] = 'foo'
props['tcp-proxy'] = 'bar'
otd_getTcpProxyProperties(props)

関連項目

「help」、「otd_createTcpProxy」、「otd_deleteTcpProxy」、「otd_listTcpProxies」、「otd_setTcpProxyProperties」

otd_getTcpThreadPoolProperties

説明

このコマンドを使用して、TCPスレッド・プールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setTcpThreadPoolPropertiesで説明されています。

構文

otd_getTcpThreadPoolProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_getTcpThreadPoolProperties(props)

関連項目

「help」、「otd_setTcpThreadPoolProperties」

otd_getVirtualServerAccessLogProperties

説明

このコマンドを使用して、次のアクセス・ログのプロパティを表示します。

プロパティ

説明

enabled

サーバーでこのアクセス・ログに書き込むかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

file

この構成のアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log

format

形式は、アクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

log-ip

クライアントのIPアドレスをアクセス・ログに記録するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

default-access-log-format

アクセス・ログ・エントリのデフォルトの形式:
%Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

構文

otd_getVirtualServerAccessLogProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getVirtualServerAccessLogProperties(props

関連項目

「help」、「otd_enableVirtualServerAccessLog」、「otd_disableVirtualServerAccessLog」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

otd_getVirtualServerRequestBandwidthLimitProperties

説明

このコマンドを使用して、仮想サーバー・レベルでリクエスト帯域幅制限のプロパティを取得します。

構文

otd_getVirtualServerRequestBandwidthLimitProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getVirtualServerRequestBandwidthLimitProperties(props)

関連項目

「help」、「otd_enableVirtualServerRequestBandwidthLimit」、「otd_disableVirtualServerRequestBandwidthLimit」

otd_getVirtualServerResponseBandwidthLimitProperties

説明

このコマンドを使用して、仮想サーバー・レベルでレスポンス帯域幅制限のプロパティを取得します。

構文

otd_getVirtualServerResponseBandwidthLimitProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getVirtualServerBandwidthLimitProperties(props)

関連項目

「help」、「otd_enableVirtualServerResponseBandwidthLimit」、「otd_disableVirtualServerResponseBandwidthLimit」

otd_getVirtualServerProperties

説明

このコマンドを使用して、仮想サーバーのプロパティを表示します。このコマンドによって返されるプロパティはotd_setVirtualServerPropertiesで説明されています。

構文

otd_getVirtualServerProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getVirtualServerProperties(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」、「otd_deleteVirtualServer」

otd_getVirtualServerSslProperties

説明

このコマンドを使用して、仮想サーバーのSSLプロパティを取得します。このコマンドによって返されるプロパティはotd_setVirtualServerSslPropertiesで説明されています。

構文

otd_getVirtualServerSslProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getVirtualServerSslProperties(props)

関連項目

「help」、「otd_setVirtualServerSslProperties」

otd_getWebappFirewallProperties

説明

このコマンドを使用して、Webアプリケーション・ファイアウォールのプロパティを表示します。このコマンドによって返されるプロパティはotd_setWebappFirewallPropertiesで説明されています。

構文

otd_getWebappFirewallProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_getWebappFirewallProperties(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」、「otd_deleteVirtualServer」、「otd_getVirtualServerProperties」

otd_installConfigurationWebappFirewallRulesetFile

説明

このコマンドを使用して、Webアプリケーション・ファイアウォール(WAF)ルールが含まれるファイルをサーバー構成ディレクトリにアップロードします。これらのルールは、すべての仮想サーバー全体に適用されます。

構文

otd_installConfigurationWebappFirewallRulesetFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

file-path

インストールするルールセット・ファイルのフルパス。

必須。

file-on-server

インストールするファイルが管理サーバー・ホストで使用可能かどうか。
デフォルトはfalseです。

例

props = {}
props['configuration'] = 'foo'
props['file-path'] = '/export/bar.conf'
otd_installConfigurationWebappFirewallRulesetFile(props)

関連項目

「help」、「otd_deleteVirtualServerWebappFirewallRulesetFile」、「otd_listVirtualServerWebappFirewallRulesetFiles」

otd_installCrl

説明

このコマンドを使用して、認証局(CA)によって発行された証明書失効リスト(CRL)をサーバー構成ディレクトリにインストールします。CRLには、クライアントまたはサーバーのユーザーが信頼することのできないすべての証明書がリストされます。

構文

otd_installCrl(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

file-path

インストールするCRLファイルのフルパスを指定します。

必須。

file-on-server

このオプションを指定すると、管理サーバー・コンピュータでCRLファイルを使用できます。このオプションを指定しない場合、CRLファイルはクライアント・マシンで使用されると想定され、サーバーにアップロードされます。

例

props = {}
props['configuration'] = 'foo'
props['file-path'] = '/export/ServerSign.crl'
otd_installCrl(props)

関連項目

「help」、「otd_listCrls」、「otd_deleteCrl」

otd_installVirtualServerWebappFirewallRulesetFile

説明

このコマンドを使用して、Webアプリケーション・ファイアウォールのルールセット・ファイルをサーバー構成ディレクトリにアップロードします。これらのルールは、指定した仮想サーバーによって処理されるリクエストに対してのみ適用されます。

構文

otd_installVirtualServerWebappFirewallRulesetFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

file-path

インストールするルールセット・ファイルのフルパス。このファイルは、管理サーバー・ホストで使用できる必要があります。

必須。

file-on-server

インストールするファイルが管理サーバー・ホストで使用可能かどうか。
デフォルトはfalseです。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['file-path'] = '/export/rulesets/baz.conf'
otd_installVirtualServerWebappFirewallRulesetFile(props)

関連項目

「help」、「otd_deleteVirtualServerWebappFirewallRulesetFile」、「otd_listVirtualServerWebappFirewallRulesetFiles」

otd_listCacheRules

説明

このコマンドを使用して、指定した仮想サーバーに定義されているキャッシュ・ルールのリストを表示します。

構文

otd_listCacheRules(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

このコマンドは、各文字列がキャッシュ・ルールの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listCacheRules(props)

関連項目

「help」、「otd_createCacheRule」、「otd_deleteCacheRule」、「otd_setCacheRuleProperties」

otd_listCertificates

説明

このコマンドを使用して、キーストア内に存在するタイプCertificateの証明書をすべてリストします。

構文

otd_listCertificates(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、マップのリストを返します。各マップは、プロパティalias、subject、issuer、serial-numberおよびkey-typeを持つ1つの証明書を表します。

例

props = {}
props['configuration'] = 'foo'
otd_listCertificates(props)

関連項目

「help」、「exportKeyStoreCertificateRequest」、「deleteKeyStoreEntry」、「importKeyStoreCertificate」、「getKeyStoreCertificates」、「generateKeyPair」

otd_listCompressionRules

説明

このコマンドを使用して、指定した仮想サーバーに定義されている圧縮ルールをリストします。

構文

otd_listCompressionRules(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

このコマンドは、各文字列が圧縮ルールの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listCompressionRules(props)

関連項目

「help」、「otd_createCompressionRule」、「otd_deleteCompressionRule」、「otd_setCompressionRuleProperties」、「otd_getCompressionRuleProperties」

otd_listConfigFiles

説明

このコマンドを使用して、指定した構成に関連する構成ファイルをリストします。

構文

otd_listConfigFiles(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列が構成ファイルの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listConfigFiles(props)

関連項目

「help」、「otd_createConfiguration」、「activate」、「otd_copyConfiguration」、「otd_saveConfigFile」、「otd_deleteConfiguration」、「otd_getConfigFile」、「otd_listConfigurations」

otd_listConfigurations

説明

このコマンドを使用して、各文字列が既存の構成の名前を表す文字列のリストを返します。

構文

otd_listConfigurations()

例

# Online
otd_listConfigurations()

# Offline
readDomain('/export/domains/otd_domain')
otd_listConfigurations()
closeDomain()

関連項目

「help」、「otd_createConfiguration」、「activate」、「otd_copyConfiguration」、「otd_saveConfigFile」、「otd_deleteConfiguration」、「otd_getConfigFile」、「otd_listConfigFiles」

otd_listConfigurationWebappFirewallRulesetFiles

説明

このコマンドを使用して、構成に対して定義されたすべてのWebアプリケーション・ファイアウォール・ルールセットをリストします。

構文

otd_listConfigurationWebappFirewallRulesetFiles(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がWebアプリケーション・ファイアウォール・ルールセット・ファイルの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listConfigurationWebappFirewallRulesetFiles(props)

関連項目

「help」、「otd_installVirtualServerWebappFirewallRulesetFile」、「otd_listVirtualServerWebappFirewallRulesetFiles」、「otd_deleteVirtualServerWebappFirewallRulesetFile」

otd_listContentRules

説明

このコマンドを使用して、コンテンツ・ルールをリストします。

構文

otd_listContentRules(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listContentRules(props)

関連項目

「help」、「otd_getContentRuleProperties」、「otd_setContentRuleProperties」、「otd_createContentRule」、「otd_deleteContentRule」

otd_listCrls

説明

このコマンドを使用して、インストールされている証明書失効リスト(CRL)をすべてリストします。

構文

otd_listCrls(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listCrls(props)

関連項目

「help」、「otd_installCrl」、「otd_deleteCrl」

otd_listErrorPages

説明

このコマンドを使用して、エラー・ページおよび対応するエラー・コードをすべてリストします。

構文

otd_listErrorPages(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listErrorPages(props)

関連項目

「help」、「otd_createErrorPage」、「otd_deleteErrorPage」

otd_listEvents

説明

このコマンドを使用して、構成のすべてのスケジュール済イベントをリストします。

構文

otd_listEvents(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listEvents(props)

関連項目

「help」、「otd_createEvent」、「otd_deleteEvent」、「otd_getEventProperties」、「otd_setEventProperties」

otd_listEventSubscriptions

説明

このコマンドを使用して、サブスクライブ済イベント・サブスクリプションのリストを表示します。

構文

otd_listEventSubscriptions(props)

引数propsは、次のキーを含める必要があるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listEventSubscriptions(props)

関連項目

「help」、「otd_createEventSubscription」、「otd_deleteEventSubscription」、「otd_getEventSubscriptionProperties」、「otd_setEventSubscriptionProperties」

otd_listFailoverGroups

説明

このコマンドを使用して、各文字列が既存のフェイルオーバー・グループのvirtual-ipを表す文字列のリストを返します。

構文

otd_listFailoverGroups(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listFailoverGroups(props)

関連項目

「help」、「otd_createFailoverGroup」、「otd_deleteFailoverGroup」、「otd_getFailoverGroupProperties」、「otd_toggleFailoverGroupPrimary」

otd_listFailoverInstances

説明

このコマンドを使用して、アクティブ-アクティブ・フェイルオーバー・グループ・タイプに存在するすべてのインスタンスをリストします。このコマンドはマップのリストを返し、各マップは、プロパティ・インスタンスおよびNICを持つ1つのインスタンスを表します。

構文

otd_listFailoverInstances(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

障害グループを一意に識別する仮想IP。

必須。

例

フェイルオーバー・グループをリストするには、次の例をその下の詳細とともに参照してください。

- 構成: ha

- インスタンス: 1.example.com

- 仮想IPアドレス: 10.128.67.44

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '10.128.67.44'
props['instance'] = '1.example.com'
otd_listFailoverInstances(props)

関連項目

「otd_addFailoverInstance」、「otd_removeFailoverInstance」、「otd_setFailoverInstanceOrder」

otd_listHttpListeners

説明

このコマンドを使用して、構成に定義されているHTTPリスナーの名前をリストします。

構文

otd_listHttpListeners(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がHTTPリスナーの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listHttpListeners(props)

関連項目

「help」、「otd_createHttpListener」、「otd_setHttpListenerProperties」、「otd_setHttpListenerProperties」、「otd_deleteHttpListener」

otd_listInstances

説明

このコマンドを使用して、この構成のすべてのインスタンスをリストします。

構文

otd_listInstances(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がインスタンスの名前を表す文字列のリストを返します。

例

#Online
props = {}
props['configuration'] = 'foo'
otd_listInstances(props)

#Offline
readDomain('/export/domains/otd_domain')
props = {}
props['configuration'] = 'foo'
otd_listInstances(props)
closeDomain()

関連項目

「help」、「otd_createInstance」、「otd_deleteInstance」、「start」、「stop」、「softRestart」

otd_listMimeTypes

説明

このコマンドを使用して、MIMEタイプをリストします。

構文

otd_listMimeTypes(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listMimeTypes(props)

関連項目

「help」、「otd_createMimeType」、「otd_deleteMimeType」

otd_listOriginServers

説明

このコマンドを使用して、プールに定義されているオリジン・サーバーのリストを表示します。

構文

otd_listOriginServers(props)

引数propsは、otd_createOriginServerで説明されているプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
otd_listOriginServers(props)

関連項目

「help」、「otd_createOriginServer」、「otd_deleteOriginServer」、「otd_getOriginServerProperties」、「otd_setOriginServerProperties」

otd_listOriginServerPools

説明

このコマンドを使用して、構成に定義されているオリジン・サーバー・プールをリストします。

構文

otd_listOriginServerPools(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がオリジン・サーバー・プールの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listOriginServerPools(props)

関連項目

「help」、「otd_getOriginServerPoolProperties」、「otd_setOriginServerPoolProperties」、「otd_deleteOriginServerPool」、「otd_createOriginServerPool」

otd_listPartitions

説明

このコマンドを使用して、指定した構成内のOracle Traffic Directorパーティションをすべてリストします。Oracle Traffic Directorパーティション名は、このパーティションがフロント・エンドとなるWLSパーティション名と同じである必要があります。この場合、Oracle Traffic Directorがフロント・エンドとなるWLSパーティションがすべてリストされます。

構文

otd_listPartitions(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。これは、Oracle Traffic Directorランタイムをライフサイクル・マネージャに登録する際に指定する構成の名前である必要があります。

必須。

例

props = {}
props['configuration'] = 'mt'
otd_listPartitions(props)

関連項目

「help」、「otd_listResourceGroups」、「otd_getPartitionAccessLogProperties」、「otd_setPartitionAccessLogProperties」

otd_listProxyInfo

説明

このコマンドを使用して、ルートに構成されているプロキシ・パラメータの情報をリストします。

構文

otd_listProxyInfo(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
otd_listProxyInfo(props)

関連項目

「help」、「otd_blockProxyInfo」、「otd_forwardProxyInfo」

otd_listRequestLimits

説明

このコマンドを使用して、仮想サーバーに定義されているリクエスト制限の条件をリストします。

構文

otd_listRequestLimits(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

このコマンドは、各文字列がリクエスト制限の名前を表す文字列のリストを返します

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listRequestLimits(props)

関連項目

「help」、「otd_getRequestLimitProperties」、「otd_setRequestLimitProperties」、「otd_deleteRequestLimit」、「otd_createRequestLimit」

otd_listResourceGroups

説明

指定したパーティション内に存在するすべてのresource-groupsに関する情報を提供します。resource-group情報には、resource-groupのターゲットであるすべてのvirtual-targetsに関する情報が含まれます。一方、virtual-target情報には、virtual-target名および対応するOracle Traffic Directorアーティファクト情報(route名、virtual-server名およびorigin-server-pool名など)が含まれます。

構文

otd_listResourceGroups(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。これは、Oracle Traffic Directorランタイムをライフサイクル・マネージャに登録する際に指定する構成の名前である必要があります。

必須。

partition

パーティションの名前。

必須。

例

props = {}
props['configuration'] = 'mt'
props['partition'] = 'WLSPartition'
otd_listResourceGroups(props)

関連項目

「help」、「otd_listPartitions」、「otd_getPartitionAccessLogProperties」、「otd_setPartitionAccessLogProperties」

otd_listRoutes

説明

このコマンドを使用して、仮想サーバーに定義されているルールをリストします。

構文

otd_listRoutes(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

このコマンドは、各文字列がルートの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listRoutes(props)

関連項目

「help」、「otd_createRoute」、「otd_deleteRoute」、「otd_getRouteProperties」、「otd_setRouteProperties」

otd_listTcpListeners

説明

このコマンドを使用して、すべてのTCPリスナーをリストします。

構文

otd_listTcpListeners(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がTCPリスナーの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listTcpListeners(props)

関連項目

「help」、「otd_createTcpListener」、「otd_deleteTcpListener」、「otd_getTcpListenerProperties」、「otd_setTcpListenerProperties」

otd_listTcpProxies

説明

このコマンドを使用して、すべてのTCPプロキシをリストします。

構文

otd_listTcpProxies(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列がTCPプロキシの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listTcpProxies(props)

関連項目

「help」、「otd_createTcpProxy」、「otd_deleteTcpProxy」、「otd_getTcpProxyProperties」、「otd_setTcpProxyProperties」

otd_listConfigurationVariables

説明

このコマンドを使用して、構成レベルで定義されている変数をすべてリストします。

構文

otd_listConfigurationVariables(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
otd_listConfigurationVariables(props)

関連項目

「help」、「otd_createConfigurationVariable」、「otd_deleteConfigurationVariable」

otd_listVirtualServers

説明

このコマンドを使用して、構成に定義されているすべての仮想サーバーをリストします。

構文

otd_listVirtualServers(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

このコマンドは、各文字列が仮想サーバーの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
otd_listVirtualServers(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_getVirtualServerProperties」、「otd_deleteVirtualServer」、「otd_copyVirtualServer」

otd_listVirtualServerVariables

説明

このコマンドを使用して、構成レベルで定義されている変数をすべてリストします。

構文

otd_listVirtualServerVariables(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listVirtualServerVariables(props)

関連項目

「help」、「otd_createVirtualServerVariable」、「otd_deleteVirtualServerVariable」

otd_listVirtualServerWebappFirewallRulesetFiles

説明

このコマンドを使用して、仮想サーバーに対して定義されたすべてのWebアプリケーション・ファイアウォール・ルールセットをリストします。

構文

otd_listVirtualServerWebappFirewallRulesetFiles(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

このコマンドは、各文字列がWebアプリケーション・ファイアウォール・ルールセット・ファイルの名前を表す文字列のリストを返します。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
otd_listVirtualServerWebappFirewallRulesetFiles(props)

関連項目

「help」、「otd_installVirtualServerWebappFirewallRulesetFile」、「otd_deleteVirtualServerWebappFirewallRulesetFile」

otd_removeFailoverInstance

説明

このコマンドを使用して、フェイルオーバー・インスタンスを削除します。このコマンドは、アクティブ-アクティブ・フェイルオーバー・タイプに対してのみ有効です。

構文

otd_removeFailoverInstance(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

障害グループを一意に識別する仮想IP。

必須。

instance

このフェイルオーバー・グループの一部であるインスタンス。

必須。

例

- 構成: ha

- インスタンス: 1.example.com

- 仮想IPアドレス: 10.128.67.44

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '10.128.67.44'
props['instance'] = '1.example.com'
otd_removeFailoverInstance(props)

関連項目

「otd_addFailoverInstance」、「otd_setFailoverInstanceOrder」

otd_rotateLog

説明

このコマンドを使用して、サーバー・ログ・ファイルおよびアクセス・ログ・ファイルをローテーションします。古いログ・ファイルはサーバーに保存され、保存済ファイルは保存時の日時を含む名前を使用してマークされます。

構文

otd_rotateLog(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

instance-name

ログをローテーションするノードの名前。

必須。

例

props = {}
props['instance-name'] = 'otd_foo_machine1'
otd_rotateLog(props)

関連項目

「help」

otd_saveConfigFile

説明

このコマンドを使用して、既存の構成ファイルへの変更をアップロードするか、新しい構成ファイルを作成します。

構文

otd_saveConfigFile(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

file-path

構成ディレクトリにアップロードするローカル・ファイルへの絶対パス。

必須。

config-file

構成ファイルの名前。

例

props = {}
props['configuration'] = 'foo'
props['file-path'] = '/export/config_files/foo-obj.conf'
otd_saveConfigFile(props)

関連項目

「help」、「otd_createConfiguration」、「otd_listConfigurations」、「otd_deleteConfiguration」、「otd_copyConfiguration」、「otd_listConfigFiles」、「otd_getConfigFile」、「activate」

otd_setAccessLogBufferProperties

説明

このコマンドを使用して、アクセス・ログ・バッファの次のプロパティを設定します。

プロパティ

説明

enabled

システム・バッファ・アクセス・ログを更新するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

buffer-size

個々のアクセス・ログ・バッファのサイズ(バイト数)。
値の範囲 : 4096 - 1048576。

デフォルト: 8192。

direct-io

ファイル・システムでアクセス・ログの書込みをキャッシュするかどうかを示します。
値の範囲: trueまたはfalse。

デフォルト値のfalseは、ファイル・システムでアクセス・ログの書込みをキャッシュすることを示します。trueの設定値は、ファイル・システムでアクセス・ログの書込みをキャッシュしないことを示します。設定は単なる推奨であり、サーバーまたはオペレーティング・システムは、この設定を無視することがあります。

max-buffers

サーバーごとのアクセス・ログ・バッファの最大数。
値の範囲: 1 - 65536。

デフォルト: 1000。

max-buffers-per-file

アクセス・ログ・ファイルごとのアクセス・ログ・バッファの最大数。
値の範囲: 1 - 128。

デフォルト: auto-tuned。

max-age

特定のアクセス・ログ・エントリをバッファする最大時間。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 1。

構文

otd_setAccessLogBufferProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['max-buffers'] = '2000'
otd_setAccessLogBufferProperties(props)

関連項目

「help」、「otd_getAccessLogBufferProperties」、「otd_enableVirtualServerAccessLog」、「otd_disableVirtualServerAccessLog」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

otd_setCacheProperties

説明

このコマンドを使用して、構成の次のキャッシュ・プロパティを定義または変更します。

プロパティ

説明

enabled

キャッシュが有効かどうかを定義します。
値の範囲: trueまたはfalse。

デフォルト: true。

max-entries

コンテンツをキャッシュするオブジェクトの最大数。
値の範囲: 1 - 1073741824。

デフォルト: 1024。

replacement

キャッシュ・エントリ置換アルゴリズム。
値の範囲: lru、lfuまたはfalse。

デフォルト: lru。

max-heap-object-size

ヒープ上でキャッシュするレスポンス(単一のエントリ)の最大サイズ(バイト単位)。HTTPレスポンス・オブジェクトがmax-heap-object-sizeより大きい場合はキャッシュされません。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。-1は、最大サイズがないことを示します。

デフォルト: 524288。

max-heap-size

レスポンス・オブジェクトのキャッシュに使用するヒープの最大量(バイト単位)。使用可能メモリーまたはプロセス・アドレス空間より大きくはできません。
値の範囲: 0から1099511627776の両端の値を含むアドレス空間の最大量(バイト単位)。

デフォルト: 10485760。

構文

otd_setCacheProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['max-heap-space'] = '20971520'
otd_setCacheProperties(props)

関連項目

「help」、「otd_getCacheProperties」

otd_setCacheRuleProperties

説明

このコマンドを使用して、キャッシュ・ルールの次のプロパティを設定します。

プロパティ

説明

コメント

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

enabled

キャッシュ・ルールが有効かどうかを指定します。

max-reload-interval

最新であることを連続的にチェックする間隔として許容される最大時間(秒単位)を指定します。
値の範囲: 任意の正の整数。

デフォルト: 3600。

min-reload-time

キャッシュされたドキュメントが最新であることを連続的にチェックする間隔として許容される最小時間(秒単位)を指定します。
値の範囲: 任意の正の整数。

デフォルト: 0。

last-modified-factor

失効時間の見積りに使用されるファクタを表します。これにより、最終変更時刻に基づいてドキュメントが最新状態である期間が定義されます。このプロパティは、ドキュメントの明示的な経過期間を使用できない場合にのみ使用します。
値の範囲: 任意の正の整数。

デフォルト: 0。

min-object-size

キャッシュされるドキュメントの最大サイズ(バイト単位)。この設定によって、キャッシュされるドキュメントの最大サイズを制限できるため、1つのドキュメントが領域を過剰に占有することがなくなります。この値は、max-heap-object-sizeの値を超えることはできません。
値の範囲: 任意の正の整数。

デフォルト: 0。

max-object-size

キャッシュされるドキュメントの最小サイズ(バイト単位)を指定します。
値の範囲: 任意の正の整数。

query-maxlen

問合せ文字列の文字数を指定します。このプロパティを0に設定すると、問合せ文字列を含むURIはキャッシュされません。
値の範囲: 任意の正の整数。

デフォルト: 0。

compression

このプロパティ値をtrueに設定すると、ドキュメントはキャッシュに格納される前に圧縮されます
値の範囲: trueまたはfalse。

デフォルト: false。

cache-https-response

このプロパティ値をtrueに設定すると、HTTPSサーバーからのレスポンスもキャッシュされます。
値の範囲: trueまたはfalse。

デフォルト: false。

構文

otd_setCacheRuleProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

cache-rule

キャッシュ・ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['cache-rule'] = 'cache-rule-1'
props['min-object-size'] = '512'
otd_setCacheRuleProperties(props)

関連項目

「help」、「otd_setCacheProperties」、「otd_getCacheRuleProperties」

otd_setCompressionRuleProperties

説明

このコマンドを使用して、仮想サーバーの圧縮ルールの次のプロパティを設定または変更します。

プロパティ

説明

コメント

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

insert-vary-header

vary:Accept-encodingヘッダーを挿入する場合に選択します。
値の範囲: trueまたはfalse。

デフォルト: true。

compression-level

仮想サーバーの圧縮レベルを指定します。1を指定すると速度が向上し、9を指定すると圧縮率が最高になります。
値の範囲: 1 - 9。

デフォルト: auto-tuned。

fragment-size

圧縮率を制御するために圧縮ライブラリが使用するメモリー・フラグメント・サイズ(バイト単位)を指定します。
値の範囲: 任意の正の整数。

デフォルト: 8192。

構文

otd_setCompressionRuleProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

compression-rule

圧縮ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['compression-rule'] = 'compression-rule-1'
props['compression-level'] = '8'
otd_setCompressionRuleProperties(props)

関連項目

「help」、「otd_createCompressionRule」、「otd_deleteCompressionRule」、「otd_listCompressionRules」、「otd_getCompressionRuleProperties」

otd_setConfigurationAccessLogProperties

説明

このコマンドを使用して、構成のアクセス・ログのプロパティを設定します。

構文

otd_setConfigurationAccessLogProperties

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

log-file

この構成のアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log。

format

形式は、アクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

例

props = {}
props['configuration'] = 'foo'
props['log-file'] = 'logs/access.log'
otd_setConfigurationAccessLogProperties(props)

関連項目

「help」、「otd_enableVirtualServerAccessLog」、「otd_disableVirtualServerAccessLog」、「displayLogs」、「otd_getLogProperties」、「otd_setLogProperties」、「otd_rotateLog」

otd_setConfigurationCrlProperties

説明

このコマンドを使用して、構成の次の証明書失効リスト(CRL)のプロパティを定義または変更します。

プロパティ

説明

enabled

プロパティが有効かどうかを指定します。
値の範囲: trueまたはfalse。

デフォルト: true。

crl-cache-size

CRLキャッシュのサイズ。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 52428800。

crl-path

動的に更新されるCRLファイルを含むディレクトリ。
値の範囲: pathname。

デフォルト: crl。

構文

otd_setConfigurationCrlProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['crl-cache-size'] = '104857600'
otd_setConfigurationCrlProperties(props)

関連項目

「help」、「otd_getConfigurationCrlProperties」

otd_setConfigurationProperties

説明

このコマンドを使用して、次の構成プロパティを設定します。

プロパティ

説明

コメント

temp-path

サーバーが一時ファイルを格納する任意の有効なディレクトリ。

Windowsではサポートされない

webapp-firewall-ruleset

Webアプリケーション・ファイアウォール(WAF)ルール/構成が含まれるファイルへのパスまたは1つ以上のパス名と一致するワイルドカード・パターン。複数の値(カンマ区切り)を指定することもできます。

複数値。

default-language

管理者に表示されるメッセージおよびクライアントに提供されるコンテンツのデフォルト言語を指定するIANA言語タグ。

negotiate-client-language

サーバーがAccept-language HTTPヘッダーを使用して、クライアントとコンテンツ言語のネゴシエートを行うかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

fips

セキュリティ・ライブラリの操作のFIPS-140モードを有効にします。
値の範囲: trueまたはfalse。

デフォルト: false。

max-fd

ファイル記述子の可用性の最大値を設定します。
デフォルト: 2097152。

構文

otd_setConfigurationProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['webapp-firewall-ruleset'] = 'rulesets'
otd_setConfigurationProperties(props)

関連項目

「help」、「otd_getConfigurationProperties」

otd_setContentRuleProperties

説明

このコマンドを使用して、コンテンツ・ルールのプロパティを設定します。

構文

otd_setContentRuleProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

content-rule

コンテンツ・ルールの名前。

必須。

uri-prefix

ディレクトリにマップする必要があるURI接頭辞。

directory-path

ドキュメントを格納する絶対サーバー・パスおよび有効なディレクトリ。

index-files

索引ファイルは、「ようこそ」ファイルまたは起動ページのリストです。
デフォルト: index.html、index.htm。

default-content-type

編集するデフォルトのコンテンツのタイプ。
デフォルト: text/plain。

allow-directory-listing

「ようこそ」ページを持たないディレクトリに対してディレクトリ・リストを有効にします。
値の範囲: trueまたはfalse。

デフォルト: true。

例

props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['content-rule'] = 'content-rule-1'
props['index-files'] = 'home.htm'
otd_setContentRuleProperties(props)

関連項目

「help」、「otd_getContentRuleProperties」、「otd_listContentRules」、「otd_createContentRule」、「otd_deleteContentRule」

otd_setDnsCacheProperties

説明

このコマンドを使用して、ドメイン・ネーム・サーバー(DNS)の次のキャッシュ・プロパティを設定します。

プロパティ

説明

enabled

サーバーでDNS参照結果をキャッシュするかどうかを定義します。
値の範囲: trueまたはfalse。

デフォルト: true。

max-age

DNS参照結果をキャッシュする最大時間(秒単位)。
値の範囲: 0.001 (1ミリ秒)から604800 (1週間)の両端の値を含む秒単位の間隔。

デフォルト: 120。

max-entries

キャッシュするDNS参照結果の最大数。
値の範囲: 1 - 1048576。

デフォルト: 1024。

構文

otd_setDnsCacheProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['max-age'] = '240'
otd_setDnsCacheProperties(props)

関連項目

「help」、「otd_getDnsCacheProperties」

otd_setDnsProperties

説明

このコマンドを使用して、構成のドメイン・ネーム・サーバー(DNS)の次の参照プロパティを設定します。

プロパティ

説明

enabled

サーバーでDNS参照を実行するかどうかを定義します。
値の範囲: trueまたはfalse。

デフォルト: true。

async

オペレーティング・システムの同期リゾルバではなくサーバー独自の非同期DNSリゾルバを使用するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

timeout

非同期DNS参照のタイムアウト(秒数)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 12。

構文

otd_setDnsProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['async'] = 'true'
props['timeout'] = '24'
otd_setDnsProperties(props)

関連項目

「help」、「otd_getDnsProperties」、「otd_setDnsCacheProperties」、「otd_getDnsCacheProperties」

otd_setEventProperties

説明

このコマンドを使用して、イベント・プロパティを設定します。

プロパティ

説明

コメント

command

イベントで実行するコマンド。
値の範囲: 値として、restart、reconfig、rotate-log、rotate-access-logおよびupdate-crlまたは実行可能な任意のコマンドを指定できます。

day-of-month

このイベントを実行する日。
値の範囲: 1-31。

day-of-week

このイベントを実行する曜日。
値の範囲: Sun、Mon、Tue、Wed、Thu、FriまたはSat。

enabled

イベントが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

interval

このイベントを実行する間隔。
値の範囲: 60 (1分)から86400 (1日)の両端の値を含む秒単位の間隔。

month

このイベントを実行する月。
値の範囲: 1-12。

time

このイベントを起動する時刻(12:30など)。
値の範囲: 時刻の形式はhh:mmです。

構文

otd_setEventProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event

イベントの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['event'] = 'bar'
props['time'] = '10:24'
otd_setEventProperties(props)

関連項目

「help」、「otd_deleteEvent」、「otd_listEvents」、「otd_getEventProperties」

otd_setEventSubscriptionProperties

説明

このコマンドを使用して、イベント・サブスクリプション・プロパティを設定します。

構文

otd_setEventSubscriptionProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

event-subscription

イベント・サブスクリプションのユーザー定義名。

必須。

enabled

イベント・サブスクリプションが有効か無効かを示します。
値の範囲: trueまたはfalse

URL

サブスクリプションURLを指定します。これが構成されている場合、Oracle Traffic DirectorによってこのURLに通知がパブリッシュされます。
値: 有効なHTTP URL。

例

props = {}
props['configuration'] = 'foo'
props['event-subscription'] = 'bar'
props['enabled'] = 'false'
otd_setEventSubscriptionProperties(props)

関連項目

「help」、「otd_createEventSubscription」、「otd_deleteEventSubscription」、「otd_getEventSubscriptionProperties」、「otd_listEventSubscriptions」

otd_setFailoverInstanceOrder

説明

このコマンドを使用して、フェイルオーバー・インスタンスの順序を変更します。このコマンドは、アクティブ-アクティブ・フェイルオーバー・タイプに対してのみ有効です。

構文

otd_setFailoverInstanceOrder(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

障害グループを一意に識別する仮想IP。

必須。

instances

フェイルオーバーが発生する必要がある順序でのインスタンスのリスト。

必須。

例

props = {}
props['configuration'] = 'ha'
props['virtual-ip'] = '10.128.67.44'
props['instances'] = '1.example.com,2.example.com'
otd_setFailoverInstanceOrder(props)

関連項目

「otd_addFailoverInstance」、「otd_removeFailoverInstance」、「otd_listFailoverInstances」

otd_setFileCacheProperties

説明

ファイル・キャッシュ・プロパティを設定します。

構文

otd_setFileCacheProperties(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

configuration

構成の名前。

enabled

サーバーでファイル・コンテンツおよびメタ情報をキャッシュするかどうかを示します。
デフォルト: true

max-age

ファイル・コンテンツまたはメタ情報(あるいはその両方)をキャッシュする最大時間(秒単位)。
値の範囲: 値の範囲は0.001 - 3600です。

デフォルト: 30。

max-entries

ファイル・コンテンツまたはメタ情報(あるいはその両方)をキャッシュするパスの最大数。
値の範囲: 1 - 1073741824

デフォルト: 1024。

max-open-files

ファイル・キャッシュで開いたままにするファイル記述子の最大数。
値の範囲: 1 - 1073741824。

sendfile

サーバーでオペレーティング・システムのsendfile、sendfilev、send_fileまたはTransmitFileシステム・コールの使用を試みるかどうかを示します。
デフォルト値は、Windowsではtrue、他のプラットフォームではfalseです。

copy-files

サーバーでキャッシュしたファイルを一時ディレクトリにコピーするかどうかを示します。
デフォルト値は、Windowsではtrue、他のプラットフォームではfalseです。

copy-path

copy-filesがtrueであるときにサーバーで使用する一時ディレクトリの名前。

replacement

キャッシュ・エントリ置換アルゴリズム。
値には、false、lruまたはlfuを使用できます。

デフォルト: lru。

cache-content

サーバーでファイル・コンテンツをキャッシュするかどうかを示します。
デフォルト: true

max-heap-file-size

ヒープにキャッシュするファイルの最大サイズ(バイト単位)。
値の範囲: 0-2147483647。

デフォルト: 524288。

max-heap-space

ファイルのキャッシュに使用するヒープの最大量(バイト単位)。
値の範囲: 0-9223372036854775807。

デフォルト: 10485760。

max-mmap-file-size

mmapするファイルの最大サイズ(バイト単位)。
値の範囲: 0-2147483647。

デフォルト: 0。

max-mmap-space

ファイルのキャッシュに使用するmmapアドレス空間の最大量(バイト単位)。
値の範囲: 0-9223372036854775807。

デフォルト: 0。

buffer-size

ミスをキャッシュするために使用する入力/出力バッファのサイズ。
値の範囲: 512-1048576。

デフォルト: 8192。

sendfile-size

最大でこの値のチャンクでファイルを送信するためのヒント
値の範囲: 0-2147483647。

デフォルト: 0。

例

props = {}
props['configuration'] = 'foo'
props['max-age'] = '1200'
otd_setFileCacheProperties(props)

関連項目

「help」、「otd_getFileCacheProperties」

otd_setHealthCheckProperties

説明

このコマンドを使用して、オリジン・サーバー・プールの次のヘルス・チェックのプロパティを設定します。

プロパティ

説明

protocol

ヘルス・チェック・メカニズム。
値の範囲: http、tcpまたはcommand

デフォルト: オリジン・サーバー・プール・タイプ

interval

2つのヘルス・チェックping間の時間間隔(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 30

timeout

pingリクエストまたは接続のタイムアウト値(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 5

failover-threshold

サーバーの停止としてマークする連続障害の数。
値の範囲: 1 - 256

デフォルト: 3

request-method

HTTP pingリクエストで使用されるメソッド。
値の範囲: OPTIONSまたはGET

デフォルト: OPTIONS

request-uri

HTTPのヘルス・チェック・リクエストに使用するURI。
値の範囲: /から始まるURI (仮想ディレクトリ)。

デフォルト: /

response-code-match

正常なオリジン・サーバーに対して受入れ可能なレスポンス・コードを指定する、変更された正規表現。この表現は、数字または'x'のみを含む3文字のパターンの結合で、'x'は任意の数字を表します。たとえば、次の3つの表現が有効です: 200、2xxまたは304、1xxまたは2xxまたは3xxまたは4xx。パラメータが指定されていない場合、5xxサーバー・エラーを除くすべてのコードが受入れ可能とみなされます

response-body-match

サーバーが正常かどうかを判別するために、HTTPレスポンス本文との一致に使用される正規表現。pingレスポンスが正規表現と一致する場合(このパラメータが指定されている場合)、およびレスポンス・ステータス・コードが5xxサーバー・エラーでない場合(このパラメータが指定されていない場合)、オリジン・サーバーはUPとマークされます。レスポンス本文一致が有効になっている場合、リクエスト・メソッドはGETに設定する必要があります

response-body-match-size

一致させるレスポンス本文の最大長。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 2048。

dynamic-server-discovery

サーバーでファイル・コンテンツをキャッシュするかどうかを示します。
値の範囲: trueまたはfalse。

デフォルト: false。

command

外部のヘルス・チェック実行可能ファイルへのフルパス。

use-object-file

ヘルス・チェック・リクエストのobj.confファイル処理が有効かどうかを指定します。
デフォルト値: True

構文

otd_setHealthCheckProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['response-body-match-size'] = '4096'
otd_setHealthCheckProperties(props)

関連項目

「help」、「otd_getHealthCheckProperties」

otd_setHttpListenerProperties

説明

このコマンドを使用して、HTTPリスナーの次のプロパティを設定します。

プロパティ

説明

コメント

enabled

リスナーが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ip

リスニングするIPアドレス。
値の範囲: *、ホスト名またはIPアドレス。

port

リスニングするポート。
値の範囲: 1から65535の両端の値を含むポート番号。

acceptor-threads

このリスナーが受信する接続の受け入れに特化されたスレッドの数。
値の範囲: 1 - 128。

デフォルト: auto-tuned。

server-name

デフォルトのサーバー名。スキーム接頭辞(http://など)とポート接尾辞(:80など)を含めることができます。ホスト名、完全修飾ドメイン名、IPアドレスまたはURL接頭辞を指定できます。URL接頭辞でパスを指定することはできません。

blocking-io

サーバーでブロッキングIOを使用するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

blocking-accept

クライアントのエンド・ポイントを非ブロッキングのままにしながら、サーバー・リスニング・ソケットのブロッキングを有効/無効にします(MaxProcsが1を上回る場合に役立ちます)。
値の範囲: trueまたはfalse。

デフォルト: false。

handle-protocol-mismatch

値の範囲: trueまたはfalse。
デフォルト: true。

family

オリジン・サーバーに接続するために使用するソケット・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp

デフォルト: auto-tuned。

listen-queue-size

オペレーティング・システムのリスニング・キュー・バックログの最大サイズ。
値の範囲: 1 - 1048576。

デフォルト: 128。

receive-buffer-size

オペレーティング・システムのソケット受信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

send-buffer-size

オペレーティング・システムのソケット送信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

max-requests-per-connection

キープ・アライブ接続が閉じられるまでにHTTP接続ごとに処理されるキープアライブ・リクエストの最大数。-1は、制限がないことを示します。
値の範囲: 1-、任意の正の整数

デフォルト: -1。

default-virtual-server-name

ホストが一致しなかったリクエストを処理する仮想サーバーの名前。

description

管理者の参照用のHTTPリスナーの説明。

構文

otd_setHttpListenerProperties(props)

引数propsは、(上記のように設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

http-listener

HTTPリスナーを一意に識別する名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
props['max-requests-per-connection'] = '1024'
otd_setHttpListenerProperties(props)

関連項目

「help」、「otd_createHttpListener」、「otd_getHttpListenerProperties」、「otd_listHttpListeners」、「otd_deleteHttpListener」

otd_setHttpProperties

説明

このコマンドを使用して、構成の次のHTTPプロパティを設定します。

プロパティ

説明

server-header

サーバーのソフトウェアやバージョンなどのサーバー・ヘッダー情報を指定します。
デフォルト: Oracle-Traffic-Director/<version>

etag

サーバーのレスポンスにEtagヘッダー・フィールドを含めるかどうかを示します。
値の範囲: trueまたはfalse。

デフォルト: true。

request-header-buffer-size

HTTPリクエスト・ヘッダーを読み取るために使用するバッファのサイズ(バイト単位)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 8192。

strict-request-headers

サーバーで一定の不正なHTTPリクエスト・ヘッダーを拒否するかどうか
値の範囲: trueまたはfalse。

デフォルト: false。

websocket-strict-upgrade

WebSocketアップグレード・リクエスト時の厳密なRFC 6455準拠を有効/無効にします。
値の範囲: trueまたはfalse。

デフォルト: false。

discard-misquoted-cookies

不適切に引用されたCookieを破棄するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

max-request-headers

HTTPリクエスト・ヘッダーに許可されるヘッダー・フィールドの最大数。
値の範囲: 1 - 512。

デフォルト: 64。

body-buffer-size

OTDがobj.confの$body変数を使用して公開するリクエスト本文コンテンツの最大サイズ(バイト単位)を定義します。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ

デフォルト: 1024。

output-buffer-size

HTTPレスポンスをバッファするために使用するバッファのサイズ(バイト単位)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ

デフォルト: 8192。

max-unchunk-size

サーバーがチャンクを解除する、チャンク済HTTPリクエスト本文の最大サイズ(バイト単位)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ

デフォルト: 8192。

unchunk-timeout

サーバーがチャンク済HTTPリクエスト本文の着信を待機するために要する最大時間(秒数)。
値の範囲: 0から3600 (1時間)の両端の値を含む秒単位の間隔。-1は、タイムアウトがないことを示します。

デフォルト: 60。

io-timeout

個々のパケットをサーバーが待機する最大時間(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 30。

request-body-timeout

完全なHTTPリクエスト本文をサーバーが待機する最大時間(秒単位)。
値の範囲: 0から604800 (1週間)の両端の値を含む秒単位の間隔。-1は、タイムアウトがないことを示します。

デフォルト: -1。

request-header-timeout

完全なHTTPリクエスト・ヘッダーをサーバーが待機する最大時間(秒単位)。
値の範囲: 0から3600 (1時間)の両端の値を含む秒単位の間隔。-1は、タイムアウトがないことを示します。

デフォルト: 30。

favicon

サーバーが独自の組込みアイコン・ファイルを使用してfavicon.icoに対するリクエストに応答するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ecid

サーバーが実行コンテキストを生成/伝播し、エラー・ログとともにログに記録するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

構文

otd_setHttpProperties(props)

引数propsは、(上記のように設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

例

props = {}
props['configuration'] = 'foo'
props['unchunk-timeout'] = '120'
otd_setHttpProperties(props)

関連項目

「help」、「otd_getHttpProperties」

otd_setHttpListenerSslProperties

説明

このコマンドを使用して、リスナーのSSLプロパティを設定します。SSLは、クライアントとサーバー間にセキュアな接続を確立するソフトウェア・ライブラリです。SSLは、HTTPのセキュア・バージョンであるHTTPSを実装するために使用されます。次のプロパティを設定できます。

プロパティ

説明

enabled

SSL/TLSが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

client-auth

クライアント証明書認証方式。
値の範囲: required、optionalまたはfalseのいずれか。

デフォルト: false。

client-auth-timeout

クライアント認証ハンドシェイクが失敗するまでのタイムアウト(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 60。

max-client-auth-data

クライアント認証ハンドシェイク時にバッファするアプリケーション・レベルのデータの最大量。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 1048576。

ssl3

SSL3接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

tls10

TLS 1.0接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls11

TLS 1.1接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls12

TLS 1.2接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ciphers

有効にする必要がある暗号のカンマ区切りリスト。
値の範囲: サポートされている1つ以上の暗号。サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: サポートされている暗号はデフォルトではすべて有効です。

override-cipher-order

暗号順をオーバーライドするかどうか。このフラグをtrueに設定すると、OTDでは、クライアントのClientHelloメッセージに指定されている順序ではなく、server.xmlに指定されている順序で暗号スイートが選択されます。
値の範囲: trueまたはfalse。

デフォルト: false。

supported-ciphers

サポートされている暗号のリスト。これは読取り専用プロパティです。
値の範囲: サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: N.A。

server-cert-alias

キーストア内に存在するサーバー証明書の別名のカンマ区切りリスト。
最大1つRSAサーバー証明書の別名および1つのECサーバー証明書の別名。

注意:
コマンドotd_setHttpListenerSslPropertiesを使用すると、server-cert-aliasを初めて設定するときにSSLが暗黙的に有効になります。ssl=enabledが明示的に設定されていなくてもSSLが有効になります。

構文

otd_setHttpListenerSslProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

http-listener

HTTPリスナーの名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['http-listener'] = 'http-listener-1'
props['tls10'] = 'false'
otd_setHttpListenerSslProperties(props)

関連項目

「help」、「otd_getTcpListenerSslProperties」

otd_setHttpThreadPoolProperties

説明

このコマンドを使用して、構成のスレッド・プールのプロパティを設定します。min-threadsおよびmax-threadsプロパティは、HTTPリクエストを処理するために使用するスレッドを構成します。スレッド・プールを使用して、一定数のスレッドを特定のサービスに割り当てることができます。スレッドの最大数を1とするプールを定義することで、指定したサービス機能に対して1つのリクエストのみを許可できます。

次のプロパティを設定できます。

プロパティ

説明

enabled

スレッド・プールが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

queue-size

処理を待機するためにキューに入れることのできる最大同時HTTP接続数。
値の範囲: 1 - 1048576。

デフォルト: auto-tuned。

min-threads

HTTPリクエスト処理スレッドの最大数。
値の範囲: 1 - 20480。

デフォルト: auto-tuned。

max-threads

HTTPリクエスト処理スレッドの最大数。
値の範囲: 1 - 20480。

デフォルト: auto-tuned。

stack-size

HTTPリクエスト処理スレッドのスタック・サイズ(バイト単位)。
値の範囲: 8192から268435456の両端の値を含むバイト単位のスタック・サイズ。値0は、プラットフォーム固有のデフォルトのスタック・サイズを使用する必要があることを示します。

デフォルト: 262144。

構文

otd_setHttpThreadPoolProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['stack-size'] = '8192'
otd_setHttpThreadPoolProperties(props)

関連項目

「help」、「otd_getHttpThreadPoolProperties」

otd_setKeepaliveProperties

説明

キープ・アライブ・サブシステムの次のプロパティを設定します。

プロパティ

説明

enabled

サーバーでキープ・アライブ接続がサポートされるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

threads

キープ・アライブ・サブシステム・スレッドの数。
値の範囲: 1 - 256。

デフォルト: auto-tuned。

max-connections

サーバーでサポートされる最大同時キープ・アライブ接続数。
値の範囲: 1 - 1048576。

デフォルト: auto-tuned。

timeout

超過するとアクティブでないキープ・アライブ接続が閉じられる場合があるタイムアウト(秒単位)。
値の範囲: 0.001 (1ミリ秒)から3600 (1時間)の両端の値を含む秒単位の間隔。-1は、タイムアウトがないことを示します。

デフォルト: 30。

poll-interval

ポーリングの間隔(秒単位)。
値の範囲: 0.001から1の両端の値を含む秒単位の間隔。

デフォルト: 0.001。

構文

otd_setKeepaliveProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['threads'] = '128'
otd_setKeepaliveProperties(props)

関連項目

「help」、「otd_getKeepaliveProperties」

otd_setLogProperties

説明

このコマンドを使用して、次のログ・プロパティを設定します。

プロパティ

説明

log-stdout

アプリケーションがstdoutに書き込むデータをサーバーで記録するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

log-stderr

アプリケーションがstderrに書き込むデータをサーバーで記録するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

log-virtual-server-name

サーバーでログ・メッセージに仮想サーバー名を含めるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

create-console

(Windowsのみ)サーバーでコンソール・ウィンドウを作成するかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

log-to-console

サーバーでコンソールにログ・メッセージを書き込むかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

log-to-syslog

サーバーでログ・メッセージをsyslog (UNIX)またはイベント・ビューア(Windows)に書き込むかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

archive-command

サーバーがログ・ファイルをローテーションした後に実行されるコマンド。ローテーションの後、ログ・ファイルのファイル名が引数としてアーカイブ・コマンドに渡されます。

log-level

サーバー全体のログの冗長度。
値の範囲: 有効なログ・レベルは、INCIDENT_ERROR:1、ERROR:1、ERROR:16、ERROR:32、WARNING:1、NOTIFICATION:1、TRACE:1、TRACE:16およびTRACE:32です。TRACE:32 (最も詳細)は冗長度が最大で、INCIDENT_ERROR:1 (致命的)は冗長度が最小です。

デフォルト: NOTIFICATION:1。

log-file

サーバー全体のログ・ファイル。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/server.log。

構文

otd_setLogProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['log-level'] = 'TRACE:32'
otd_setLogProperties(props)

関連項目

「help」、「otd_getLogProperties」、「displayLogs」

otd_setOriginServerPoolSslProperties

説明

このコマンドを使用して、オリジン・サーバー・プールのSSLのプロパティを設定します。

プロパティ

説明

enabled

SSL/TLSが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ssl3

SSL3接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

tls10

TLS 1.0接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls11

TLS 1.1接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls12

TLS 1.2接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

validate-server-cert

送信接続にのみ適用されます。SSL証明書のホスト名のオン/オフ・フラグを検証します。
値の範囲: trueまたはfalse。

デフォルト: true。

ciphers

有効にする必要がある暗号のカンマ区切りリスト。
値の範囲: サポートされている1つ以上の暗号。サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: サポートされている暗号はデフォルトではすべて有効です。

supported-ciphers

サポートされている暗号のリスト。これは読取り専用プロパティです。
値の範囲: サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: n/a

client-cert-alias

キーストア内に存在する有効なクライアント証明書の別名。
最大1つRSAサーバー証明書の別名および1つのECサーバー証明書の別名。

構文

otd_setOriginServerPoolSslProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

origin-server-pool

オリジン・サーバー・プールの名前。

必須

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['tls10'] = 'false'
otd_setOriginServerPoolSslProperties(props)

関連項目

「help」

otd_setOriginServerPoolProperties

説明

このコマンドを使用して、オリジン・サーバー・プールの次のプロパティを設定します。

プロパティ

説明

コメント

family

このプールのサーバーに接続するために使用されるソケット・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp。

デフォルト: auto-tuned。

load-distribution

このサーバー・プールの負荷分散に使用されるアルゴリズム。
値の範囲: round-robin、least-connection-countまたはleast-response-time。

デフォルト: least-connection-count。

queue-timeout

リクエストがキュー内でオリジン・サーバーへの接続を待機する際のタイムアウト(秒単位)。タイムアウト後、リクエストは拒否されます。
値の範囲: 0.001 - 3600。

デフォルト: 30。

proxy-server

host:port形式でのプロキシ・サーバーの名前。

構文

otd_setOriginServerPoolProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

origin-server-pool

オリジン・サーバー・プールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['load-distribution'] = 'least-connection-count'
otd_setOriginServerPoolProperties(props)

関連項目

「help」、「otd_getOriginServerPoolProperties」、「otd_listOriginServerPools」、「otd_deleteOriginServerPool」、「otd_createOriginServerPool」

otd_setOriginServerProperties

説明

このコマンドを使用して、オリジン・サーバーの次のプロパティを設定します。

プロパティ

説明

mode

このオリジン・サーバーのモード。
値の範囲: enabled、disabled、draining。

デフォルト: enabled。

weight

このオリジン・サーバーの負荷分散の重み。
値の範囲: 1 - 1000。

デフォルト: 1。

backup

このパラメータは、オリジン・サーバーがバックアップ・サーバーであるかどうかを指定します。
値の範囲: trueまたはfalse。

デフォルト: false。

max-connections

サーバーに対する同時接続の最大数。-1は、最大値がないことを示します。
値の範囲: -1, 1 - 1048576。

デフォルト: -1。

ramp-up-time

新しく起動したオリジン・サーバーの容量まで送信レートをランプアップする時間(秒単位)。このパラメータが指定されていない場合、このサーバーに対してリクエスト率の加速がアクティブ化されません。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 0.001。

max-requests-per-connection

オリジン・サーバーへの接続を異なるリクエストに対して再使用できる最大制限回数。-1は、制限がないことを示します。
値の範囲: -1, 1 - 2147483647。

デフォルト: -1。

max-request-bps

リクエストに対して課される合計帯域幅制限(バイト/秒単位)。
値の範囲: 0 - 1099511627776。

デフォルト: 0。

max-response-bps

レスポンスに対して課される合計帯域幅制限(バイト/秒単位)。
値の範囲: 0 - 1099511627776。

デフォルト: 0。

bandwidth-queue-timeout

リクエストがキュー内で帯域幅を待機した時間(秒単位)がこの長さに達すると、リクエストは中断されます。
値の範囲: 0 - 86400。

デフォルト: 60。

構文

otd_setOriginServerProperties(props)

引数propsは、(設定可能なプロパティに加えて)次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須

origin-server-pool

オリジン・サーバー・プールの名前。

必須

host

オリジン・サーバーのIPアドレス/ホスト名。

必須

port

オリジン・サーバーのポート番号。

必須

例

props = {}
props['configuration'] = 'foo'
props['origin-server-pool'] = 'origin-server-pool-1'
props['host'] = 'www.example.com'
props['port'] = '12345'
props['ramp-up-time'] = '1200'
otd_setOriginServerProperties(props)

関連項目

「help」、「otd_getOriginServerProperties」、「otd_listOriginServers」、「otd_deleteOriginServer」、「otd_createOriginServer」

otd_setPartitionAccessLogProperties

説明

このコマンドを使用して、パーティションのアクセス・ログのプロパティを設定します。

プロパティ

説明

log-file

このパーティションのアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/$PARTITION_NAME.log

format

形式は、パーティションのアクセス・ログに記録されるフィールドおよび形式をカスタマイズするために使用される文字列です。
デフォルト: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server%

構文

otd_setPartitionAccessLogProperties (props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。これは、Oracle Traffic Directorランタイムをライフサイクル・マネージャに登録する際に指定する構成の名前である必要があります。

必須。

partition

パーティションの名前。

必須。

例

props = {}
props['configuration'] = 'mt'
props['partition'] = 'WLSPartition'
props['log-file'] = 'logs/WLSPartition.log'
otd_setPartitionAccessLogProperties(props)

関連項目

「help」、「otd_listPartitions」、「otd_getPartitionAccessLogProperties」

otd_setRequestLimitProperties

説明

このコマンドを使用して、仮想サーバーの次のリクエスト制限プロパティを設定します。

プロパティ

説明

コメント

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

max-rps

仮想サーバーで1秒当たりに受信できるリクエストの最大数。
値の範囲: 任意の正の整数。

max-connections

一致する同時接続の最大数。
値の範囲: 任意の正の整数。

queue-size

バケットにキューイングされるリクエストの最大数。
値の範囲: 任意の正の整数。

デフォルト: 0。

timeout

リクエストがキュー内で待機した時間(秒単位)がこの長さに達すると、リクエストは中断されます。
値の範囲 : 1 - 86400。

デフォルト: 60。

error-code

ブロックされたリクエストに対して返すHTTPステータス・コード。
値の範囲: 400 - 599。

デフォルト: 503。

monitor-attribute

監視するリクエスト属性。

構文

otd_setRequestLimitProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

request-limit

リクエスト制限ルールの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['request-limit'] = 'request-limit-1'
props['max-connections'] = '1024'
otd_setRequestLimitProperties(props)

関連項目

「help」、「otd_getRequestLimitProperties」、「otd_listRequestLimits」、「otd_deleteRequestLimit」、「otd_createRequestLimit」

otd_setRouteProperties

説明

このコマンドを使用して、仮想サーバーの次のルート・プロパティを設定します。

プロパティ

説明

コメント

condition

条件は、trueに評価されるとルールが実行される式です。条件はリテラル、変数、関数および演算子から作成されます。

conditionは、uri-prefixベースのルートに対して設定できません。

uri-prefix

uri-prefixは、ワイルドカード・パターンを持つURIパスです。リクエストURIがuri-prefixと一致する場合、ルールが実行されます。

uri-prefixは、conditionベースのルートに対して設定できません。

origin-server-pool

このルートのオリジン・サーバー・プールの名前。

offline-check-interval

オフライン確認の間隔を指定します。

server

サーバー名を指定します。

sticky-cookie

後続のリクエストを特定のオリジン・サーバーに固定するCookieの名前。
デフォルト: JSESSIONID。

sticky-param

ルート情報を調べるURIパラメータの名前。リクエストURIにURIパラメータがあり、その値の中にコロン:,に続くルートIDが含まれている場合、そのルートIDで識別されるオリジン・サーバーに対して、そのリクエストはスティッキになります。
デフォルト: jsessionid。

route-header

ルートIDをオリジン・サーバーに伝えるために使用されるHTTPリクエスト・ヘッダーの名前。
デフォルト: Proxy-jroute。

route-cookie

レスポンスにsticky-cookie Cookieが発生した場合に、サーバーによって生成されるCookieの名前。route-cookieパラメータは、サーバーが後続のリクエストを同じオリジン・サーバーに戻すことができるルートIDを格納します。
デフォルト: ORA_OTD_JROUTE。

rewrite-headers

カンマで区切られたHTTPリクエスト・ヘッダーのリスト。

use-keep-alive

すべてのタイプのリクエストに対してHTTPクライアントで既存の永続接続を使用できるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

keep-alive-timeout

永続接続を保持する最大秒数。
値の範囲: 任意の正の整数。

デフォルト: 29。

timeout

接続をアイドル状態にできる最大秒数。
値の範囲: 任意の正の整数。

デフォルト: 300。

always-use-keep-alive

すべてのタイプのリクエストに対してHTTPクライアントで既存の永続接続を再使用できるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

protocol

HTTPプロトコルのバージョンを指定します。

proxy-agent

オリジン・サーバーにプロキシ・サーバーの製品名およびバージョンを転送する必要があるかどうか。

from

マップするURI接頭辞。接頭辞の末尾にはスラッシュを含めないでください。

to

リクエストのマップ先となるURL接頭辞。接頭辞の末尾にはスラッシュを含めないでください。

log-headers

trueの場合は、オリジン・サーバーとのすべての接続のHTTPリクエストおよびレスポンス・ヘッダーがサーバー・ログ・ファイルにログされます。
値の範囲: trueまたはfalse。

デフォルト: false。

websocket-upgrade-enabled

標準HTTP (S)接続を双方向の全二重Webソケット接続にアップグレードするかどうかを指定します。
値の範囲: trueまたはfalse。

デフォルト: true。

websocket-idle-timeout

接続をアイドルにできる最大秒数。値を指定しない場合、TCP接続スレッド・プールからのタイムアウト(300秒)が使用されます。
値の範囲: -1または0 - 3600。

buffer-size

データをクライアントに送信する前に格納するためにサーバーで使用するバッファのサイズ。
値の範囲: 任意の正の整数。

デフォルト: 16384。

priority

リクエストの優先度。
値の範囲: high、normal、low。

デフォルト: normal。

構文

otd_setRouteProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

route

ルートの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['route'] = 'route-1'
props['websocket-idle-timeout'] = '1200'
otd_setRouteProperties(props)

関連項目

「help」、「otd_getRouteProperties」、「otd_listProxyInfo」、「otd_forwardProxyInfo」、「otd_blockProxyInfo」、「otd_listRoutes」、「otd_deleteRoute」、「otd_createRoute」

otd_setSnmpProperties

説明

このコマンドを使用して、SNMPサブエージェントの次の設定を有効化および定義します。

プロパティ

説明

enabled

SNMPが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

description

サーバーの説明またはunknown。

organization

サーバーに責任を持つ組織またはunknown。

location

サーバーの場所またはunknown。

contact

サーバーの責任者の連絡先またはunknown。

構文

otd_setSnmpProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['organization'] = 'bar'
otd_setSnmpProperties(props)

関連項目

「help」、「otd_getSnmpProperties」、「otd_startSnmpSubAgent」、「otd_stopSnmpSubAgent」

otd_setSslSessionCacheProperties

説明

このコマンドを使用して、SSLセッション・キャッシュのプロパティを設定します。

プロパティ

説明

enabled

サーバーがSSL/TLSセッションをキャッシュするかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

max-entries

サーバーがキャッシュするSSL/TLSセッションの最大数。
値の範囲: 1 - 524288。

デフォルト: 10000。

max-ssl3-tls-session-age

SSL3/TLSセッションをキャッシュする最大時間。
値の範囲 : 1 - 86400。

デフォルト: 86400。

構文

otd_setSslSessionCacheProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['max-entries'] = '20000'
otd_setSslSessionCacheProperties(props)

関連項目

「help」、「otd_getSslSessionCacheProperties」

otd_setStatsProperties

説明

このコマンドを使用して、統計収集サブシステムの次のプロパティを設定します。

プロパティ

説明

enabled

サーバーが実行時に統計を収集するかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

interval

統計を更新する間隔(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 5。

profiling

NSAPI機能の実行時間を追跡するために使用するパフォーマンス・バケットが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

構文

otd_setStatsProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['interval'] = '10'
otd_setStatsProperties(props)

関連項目

「help」、「otd_getStatsProperties」

otd_setStatusListenerSslProperties

説明

このコマンドを使用して、ステータス・リスナーのSSLプロパティを変更します。

構文

otd_setStatusListenerSslProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

enabled

SSLがステータス・リスナーに対して有効かどうかを指定します。
値: Trueまたはfalse。

デフォルト: True

例

props = {}
props['configuration'] = 'foo'
props['enabled'] = 'false'
otd_setStatusListenerSslProperties(props)

関連項目

「otd_enableStatusListener」、「otd_disableStatusListener」、「otd_getStatusListenerProperties」、「otd_getStatusListenerSslProperties」

otd_setTcpAccessLogProperties

説明

このコマンドを使用して、TCPアクセス・ログのプロパティを設定します。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

log-file

この構成のTCPアクセス・ログが保存されるファイルへのパス。
デフォルト: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/tcp-access.log

構文

otd_setTcpAccessLogProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['log-file'] = 'logs/tcp-access.log'
otd_setTcpAccessLogProperties(props)

関連項目

「help」、「otd_getTcpAccessLogProperties」

otd_setTcpListenerProperties

説明

このコマンドを使用して、TCPリスナーのプロパティを設定します。

プロパティ

説明

port

リスニングするポート。
値の範囲: 1から65535の両端の値を含むポート番号。

ip

リスニングするIPアドレス。
値の範囲: *、ホスト名またはIPアドレス。

デフォルト: *。

acceptor-threads

このリスニング・エンド・ポイントのアクセプタ・スレッド。
値の範囲: 1 - 128。

デフォルト: auto-tuned。

enabled

インスタンスが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

description

管理者の参照用のTCPリスナーの説明。

family

プロトコル・ファミリ。
値の範囲: default、inet、inet6またはinet-sdp。

デフォルト: auto-tuned。

listen-queue-size

オペレーティング・システムのリスニング・キュー・バックログの最大サイズ。
値の範囲: 1 - 1048576。

デフォルト: 128。

receive-buffer-size

オペレーティング・システムのソケット受信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

send-buffer-size

オペレーティング・システムのソケット送信バッファのサイズ(バイト数)。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

blocking-accept

クライアントのエンド・ポイントを非ブロッキングのままにしながら、サーバー・リスニング・ソケットのブロッキングを有効/無効にします(MaxProcsが1を上回る場合に役立ちます)。
値の範囲: trueまたはfalse。

デフォルト: false。

tcp-proxy

公開されたTCPサービスを識別する名前。名前は1つ以上の文字で構成できますが、空白は許可されません。

構文

otd_setTcpListenerProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

TCPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
props['listen-queue-size'] = '256'
otd_setTcpListenerProperties(props)

関連項目

「help」、「otd_createTcpListener」、「otd_deleteTcpListener」、「otd_listTcpListeners」、「otd_getTcpListenerProperties」

otd_setTcpListenerSslProperties

説明

このコマンドを使用して、TCPリスナーのSecure Sockets Layer (SSL)のプロパティを設定します。

プロパティ

説明

enabled

SSL/TLSが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

client-auth

クライアント証明書認証方式。
値の範囲: required、optionalまたはfalseのいずれか。

デフォルト: false。

client-auth-timeout

クライアント認証ハンドシェイクが失敗するまでのタイムアウト(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 60。

max-client-auth-data

クライアント認証ハンドシェイク時にバッファするアプリケーション・レベルのデータの最大量。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 1048576。

ssl3

SSL3接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

tls10

TLS 1.0接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls11

TLS 1.1接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls12

TLS 1.2接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ciphers

有効にする必要がある暗号のカンマ区切りリスト。
値の範囲: サポートされている1つ以上の暗号。サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: サポートされている暗号はデフォルトではすべて有効です。

override-cipher-order

暗号順をオーバーライドするかどうか。このフラグをtrueに設定すると、OTDでは、クライアントのClientHelloメッセージに指定されている順序ではなく、server.xmlに指定されている順序で暗号スイートが選択されます。
値の範囲: trueまたはfalse。

デフォルト: false。

supported-ciphers

サポートされている暗号のリスト。これは読取り専用プロパティです。
値の範囲: サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: N.A。

server-cert-alias

キーストア内に存在するサーバー証明書の別名のカンマ区切りリスト。
最大1つRSAサーバー証明書の別名および1つのECサーバー証明書の別名。

構文

otd_setTcpListenerProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-listener

TCPリスナーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['tcp-listener'] = 'tcp-listener-1'
props['tls10'] = 'false'
otd_setTcpListenerSslProperties(props)

関連項目

「help」、「otd_getTcpListenerSslProperties」

otd_setTcpProxyProperties

説明

このコマンドを使用して、構成のTCPプロキシの次のプロパティを設定します。

さらに、TCPプロキシがプロパティprotocolにftpを指定して作成される場合は、このコマンドを使用して、既存のTCPプロパティに加えてTCPプロキシ上のFTP構成プロパティを設定します。

構文

otd_setTcpProxyProperties(props)

引数propsは、設定可能なプロパティ(上記を参照)に加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

tcp-proxy

公開されたTCPサービスを一意に識別する名前。

必須。

enabled

TCPサービスが有効かどうか。
値の範囲: trueまたはfalse。

session-idle-timeout

セッションでロード・バランサがデータの送受信を待機する最大時間(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

origin-server-pool

TCPサービスを提供する既存のサーバー・プールの名前。

protocol

プロトコルがftpの場合、TCPプロキシでFTP構成プロパティを設定または取得できます。
デフォルト値: *

これは読取り専用プロパティです。

client-explicit-ftps

クライアント側SSLを明示的に有効にする必要があるかどうかを指定します。
デフォルト値: true

protocolがftpの場合のみ有効です。

origin-explicit-ftps

サーバー側SSLを明示的に有効にする必要があるかどうかを指定します。
デフォルト値 : true

protocolがftpの場合のみ有効です。

ssl-termination

Oracle® Fusion Middlewareでsslを終了する必要があるかどうかを指定します。
デフォルト値: false

protocolがftpの場合のみ有効です。

passive-port-min

ftpパッシブ接続のポート範囲の下限を指定します。
デフォルト値: 1025

protocolがftpの場合のみ有効です。

passive-port-max

ftpパッシブ接続のポート範囲の上限を指定します。
デフォルト値: 65535

protocolがftpの場合のみ有効です。

active-port-min

ftpアクティブ接続のポート範囲の下限を指定します。
デフォルト値: 1025

protocolがftpの場合のみ有効です。

active-port-max

ftpアクティブ接続のポート範囲の上限を指定します。
デフォルト値: 65535

protocolがftpの場合のみ有効です。

例

- protocolプロパティがftp有効ではない場合。

props = {}
props['configuration'] = 'foo'
props['tcp-proxy'] = 'bar'
props['session-idle-timeout'] = '1200'
otd_setTcpProxyProperties(props)

- TCPプロキシのprotocolプロパティがftpであり、client-side sslが明示的に有効化されている場合。

props = {}
props['configuration'] = 'foo'
props['tcp-proxy'] = 'bar'
props['client-explicit-ftps'] = 'true'
otd_setTcpProxyProperties(props)

関連項目

「help」、「otd_createTcpProxy」、「otd_deleteTcpProxy」、「otd_listTcpProxies」、「otd_getTcpProxyProperties」

otd_setTcpThreadPoolProperties

説明

このコマンドを使用して、構成のスレッド・プールのプロパティを設定します。このプロパティは、アップグレードしたWebソケット接続および汎用TCP接続のデータのプロキシに使用されるスレッドを構成します。TCPスレッド・プールを使用して、一定数のスレッドを特定のサービスに割り当てることができます。

次のプロパティを設定できます。

プロパティ

説明

enabled

プールが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

threads

プロキシ・スレッド・プール内のスレッド数。
値の範囲: 1 - 512。

デフォルト: auto-tuned。

max-connections

サーバーでサポートされる最大接続ペア数。
値の範囲: 1 - 1048576。

デフォルト: auto-tuned。

timeout

接続ペアがクローズされるまでのアイドル・タイムアウト(秒単位)。値は、TCPまたはWebSocketサブシステムによってオーバーライドされます。
値の範囲: 0.001 (1ミリ秒)から3600 (1時間)の両端の値を含む秒単位の間隔。-1は、タイムアウトがないことを示します。

デフォルト: 300。

poll-interval

ポーリングの間隔(秒単位)。
値の範囲: 0.001から1の両端の値を含む秒単位の間隔。

デフォルト: 0.01。

buffer-size

データの転送で使用されるバッファのサイズ(バイト単位)。
値の範囲: 512 - 1048576。

デフォルト: 16384。

stack-size

各スレッドのスタック・サイズ(バイト単位)。
値の範囲: 8192から268435456の両端の値を含むバイト単位のスタック・サイズ。値0は、プラットフォーム固有のデフォルトのスタック・サイズを使用する必要があることを示します。

デフォルト: 32768。

構文

otd_setTcpThreadPoolProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['stack-size'] = '8192'
otd_setTcpThreadPoolProperties(props)

関連項目

「help」、「otd_getTcpThreadPoolProperties」

otd_setVirtualServerProperties

説明

このコマンドを使用して、仮想サーバーのプロパティを設定します。

プロパティ

説明

enabled

実行時に仮想サーバーが有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

canonical-server-name

仮想サーバーの正規ホスト名(別のホスト名を使用してリクエストすると、このホスト名にリダイレクトされます)。ホスト名、完全修飾ドメイン名、IPアドレスまたはURL接頭辞を指定できます。URL接頭辞にはパスを指定できません。

log-file

仮想サーバーのログ・ファイル。

http-listener-name

1つ以上の仮想サーバーのホスト名に関連付けられたHTTPリスナーの名前。複数のカンマ区切り値を指定できます。

host

仮想サーバー・サービスのホスト名。複数のカンマ区切り値を指定できます。この場合、各値は、1つ以上のホスト名と一致するワイルドカード・パターンにすることができます。

default-language

管理者に表示されるメッセージおよびクライアントに提供されるコンテンツのデフォルト言語を指定するIANA言語タグ。

negotiate-client-language

サーバーがAccept-language HTTPヘッダーを使用して、クライアントとコンテンツ言語のネゴシエートを行うかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

構文

otd_setVirtualServerProperties(props)

引数propsは、設定可能なプロパティに加えて、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['http-listener-name'] = 'http-listener-1'
otd_setVirtualServerProperties(props)

関連項目

「help」、「otd_deleteVirtualServer」、「otd_getVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」

otd_setVirtualServerSslProperties

説明

このコマンドを使用して、仮想サーバーのSSLプロパティを設定します。

プロパティ

説明

enabled

SSL/TLSが実行時に有効かどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

client-auth

クライアント証明書認証方式。
値の範囲: required、optionalまたはfalseのいずれか。

デフォルト: false。

client-auth-timeout

クライアント認証ハンドシェイクが失敗するまでのタイムアウト(秒単位)。
値の範囲: 0.001から3600 (1時間)の両端の値を含む秒単位の間隔。

デフォルト: 60。

max-client-auth-data

クライアント認証ハンドシェイク時にバッファするアプリケーション・レベルのデータの最大量。
値の範囲: 0から2147483647の両端の値を含むバイト単位のサイズ。

デフォルト: 1048576。

ssl3

SSL3接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: false。

tls10

TLS 1.0接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls11

TLS 1.1接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

tls12

TLS 1.2接続を受け入れるかどうか。
値の範囲: trueまたはfalse。

デフォルト: true。

ciphers

有効にする必要がある暗号のカンマ区切りリスト。
値の範囲: サポートされている1つ以上の暗号。サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: サポートされている暗号はデフォルトではすべて有効です。

override-cipher-order

暗号順をオーバーライドするかどうか。このフラグをtrueに設定すると、OTDでは、クライアントのClientHelloメッセージに指定されている順序ではなく、server.xmlに指定されている順序で暗号スイートが選択されます。
値の範囲: trueまたはfalse。

デフォルト: false。

supported-ciphers

サポートされている暗号のリスト。これは読取り専用プロパティです。
値の範囲: サポートされている暗号のリストは、「暗号」を参照してください。

デフォルト: N.A。

server-cert-alias

キーストア内に存在するサーバー証明書の別名のカンマ区切りリスト。
最大1つRSAサーバー証明書の別名および1つのECサーバー証明書の別名。

構文

otd_setVirtualServerSslProperties(props)

引数propsは、設定可能なプロパティに加え、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['tls10'] = 'false'
otd_setVirtualServerSslProperties(props)

関連項目

「help」、「otd_getVirtualServerSslProperties」

otd_setWalletPassword

説明

ウォレットにパスワードを設定します。

構文

otd_setWalletPassword(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

password

8文字以上で構成されるパスワードで、アルファベットと、数字または特殊文字の組合せを含みます。

必須。

例

props = {}
props['configuration'] = 'foo'
props['password'] = 'barBazqux#'
otd_setWalletPassword(props)

関連項目

「help」、「exportKeyStoreCertificateRequest」、「otd_listCertificates」、「importKeyStoreCertificate」、「getKeyStoreCertificates」、「generateKeyPair」

otd_setWebappFirewallProperties

説明

このコマンドを使用して、Webアプリケーション・ファイアウォールの次のプロパティを設定します。

プロパティ

説明

コメント

ruleset

Webアプリケーション・ファイアウォール(WAF)ルール/構成が含まれるファイルへのパス

複数値。

構文

otd_setWebappFirewallProperties(props)

引数propsは、設定可能なプロパティに加えて、次のキーを含める必要があるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-server

仮想サーバーの名前。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-server'] = 'bar'
props['ruleset'] = 'rulesets'
otd_setWebappFirewallProperties(props)

関連項目

「help」、「otd_createVirtualServer」、「otd_setVirtualServerProperties」、「otd_listVirtualServers」、「otd_copyVirtualServer」、「otd_deleteVirtualServer」、「otd_getVirtualServerProperties」

otd_startFailover

説明

このコマンドを使用して、ローカル・マシン上でフェイルオーバー・デーモンを起動します。フェイルオーバー・デーモンはルートとして実行する必要があるため、フェイルオーバー・グループのプライマリ/バックアップ・インスタンスが実行されているホスト上でsudo権限を使用してこのコマンドを実行し、インスタンスに対するフェイルオーバーを開始する必要があります。

このコマンドは、オフライン・モードでのみ実行できます。

構文

otd_startFailover(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

必須。

instance-name

フェイルオーバー・グループの一部であるプライマリ/バックアップOracle Traffic Directorインスタンスの名前。

必須。

log-verbose

keepalivedを詳細ログ・レベル・モードで起動するかどうか。
デフォルト: false。

例

props = {}
props['domain-home'] = '/export/domains/otd_domain'
props['instance-name'] = 'otd_abc123.example.com'
otd_startFailover(props)

関連項目

「help」、「otd_createFailoverGroup」、「otd_deleteFailoverGroup」、「otd_toggleFailoverGroupPrimary」、「otd_stopFailover」

otd_startSnmpSubAgent

説明

このコマンドを使用して、指定したマシン上でOracle Traffic DirectorのSimple Network Management Protocol (SNMP)サブエージェントを起動します。

構文

otd_startSnmpSubAgent(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

machine-name

Oracle WebLogic Serverコンソール内でマシンの作成中に指定した名前で、Oracle Traffic Directorインスタンスが実行されているマシンのホスト名に対応しています。

オフラインの場合は必須で、オンラインの場合は無効です。

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

オフラインの場合は必須で、オンラインの場合は無効です。

例

# Online
props = {}
props['machine-name'] = 'abc123.example.com'
otd_startSnmpSubAgent(props)

# Offline
props = {}
props['domain-home'] = '/export/domains/otd_domain'
otd_startSnmpSubAgent(props)

関連項目

「help」、「otd_stopSnmpSubAgent」、「otd_setSnmpProperties」、「otd_getSnmpProperties」

otd_stopFailover

説明

このコマンドを使用して、ローカル・マシン上でフェイルオーバー・デーモンを停止します。フェイルオーバー・デーモンはルートとして実行する必要があるため、フェイルオーバー・グループのプライマリ/バックアップ・インスタンスが実行されているホスト上でsudo権限を使用してこのコマンドを実行し、インスタンスに対するフェイルオーバーを停止します。

このコマンドは、オフライン・モードでのみ実行できます。

構文

otd_stopFailover(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

必須。

instance

フェイルオーバー・グループの一部であるプライマリ/バックアップOracle Traffic Directorインスタンスの名前。

必須。

例

props = {}
props['domain-home'] = '/export/otd_domain'
props['instance'] = 'otd_abc123.example.com'
otd_stopFailover(props)

関連項目

「help」、「otd_createFailoverGroup」、「otd_deleteFailoverGroup」、「otd_toggleFailoverGroupPrimary」、「otd_startFailover」

otd_stopSnmpSubAgent

説明

このコマンドを使用して、指定したマシン上でSimple Network Management Protocol (SNMP)サブエージェントを停止します。

構文

otd_stopSnmpSubAgent(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

machine-name

Oracle WebLogic Serverコンソール内でマシンの作成中に指定した名前で、Oracle Traffic Directorインスタンスが実行されているマシンのホスト名に対応しています。

オフラインの場合は必須で、オンラインの場合は無効です。

domain-home

Oracle Traffic Directorドメインが含まれるディレクトリへのパス。

オフラインの場合は必須で、オンラインの場合は無効です。

例

# Online
props = {}
props['machine-name'] = 'host.example.com'
otd_stopSnmpSubAgent(props)

# Offline
props = {}
props['domain-home'] = '/export/domains/otd_domain'
otd_stopSnmpSubAgent(props)

関連項目

「help」、「otd_startSnmpSubAgent」、「otd_setSnmpProperties」、「otd_getSnmpProperties」

otd_toggleFailoverGroupPrimary

説明

このコマンドを使用して、アクティブ-パッシブ・フェイルオーバー・グループのプライマリ・インスタンスとバックアップ・インスタンスを切り替えます。フェイルオーバーがすでに実行されている場合、インスタンスが実行されているホスト上でstopFailoverおよびstartfailoverスクリプトを実行する必要があります。これはノードを手動で切り替えるためです。このコマンドを実行しないとインスタンスは切り替わりません。また、otd_getFailoverGroupPropertiesを実行する場合、結果には、構成したプライマリ・インスタンスおよびバックアップ・インスタンスが表示されますが、これらは実行時のプライマリ・インスタンスおよびバックアップ・インスタンスとは異なります。

注意:
このコマンドは、アクティブ-アクティブ・フェイルオーバー・タイプに対しては無効です。

構文

otd_toggleFailoverGroupPrimary(props)

引数propsは、次のプロパティを含めることができるディクショナリです。

プロパティ

説明

コメント

configuration

構成の名前。

必須。

virtual-ip

フェイルオーバー・グループを一意に識別する仮想IP。

必須。

例

props = {}
props['configuration'] = 'foo'
props['virtual-ip'] = '192.0.2.1'
otd_toggleFailoverGroupPrimary(props)

関連項目

「help」、「otd_deleteFailoverGroup」、「otd_createFailoverGroup」、「otd_getFailoverGroupProperties」、「otd_startFailover」、「otd_stopFailover」

pullComponentChanges

説明

構成の特定のインスタンスの構成ファイルを管理サーバー内の構成ストアにプルします。プルした構成ファイルにより、対応するサーバーのバージョンが上書きされ、管理サーバー上で保留中の変更(プルした構成ファイルと競合する変更)は失われます。

このコマンドを実行した後、activateの前にコマンドenableOverwriteComponentChangesを実行する必要があります。それ以外の場合、インスタンス上のローカル変更が原因でactivateが失敗します。

注意:
このコマンドは、オープンの編集セッションからのみ実行できます。プルした構成の変更が構成のすべてのインスタンスにわたってデプロイされるようにするには、コマンドactivateを実行する必要があります。

構文

pullComponentChanges(<instance_name>)

引数<instance_name>は、インスタンスの名前であり、必須です。

例

startEdit()

pullComponentChanges('otd_test.example.com')
pull component otd_test.example.com changes on machine example.com:
add OTD/test/config/foo.conf
edit OTD/test/config/server.xml
edit OTD/test/config/test-obj.conf
remove OTD/test/config/obj.conf

activate()

関連項目

「help」、「enableOverwriteComponentChanges」「resync/resyncAll」、「showComponentChanges」、「stopEdit」、「undo」

resync/resyncAll

説明

1つのインスタンスまたはすべてのインスタンス上の変更を、管理サーバー内の対応するサーバーのバージョンとともに上書きします。

構文

resync(<instance_name>) / resyncAll()

引数<instance_name>は、インスタンスの名前であり、必須です。

注意:
このコマンドは、オープンの編集セッションからは実行できません。オープンの編集セッション内でインスタンスの変更を上書きする方法の詳細は、enableOverwriteComponentChangesおよびactivateを参照してください。

例

# resync
showComponentChanges('otd_test.example.com')
add OTD/test/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:35:15
edit OTD/test/config/proxyvs.obj.conf 2014.11.07-17:36:49 1970.01.01-05:29:59
edit OTD/test/config/server.xml 2014.11.07-17:36:49 2014.11.07-17:37:22
remove OTD/test/config/test-obj.conf 2014.11.07-17:36:49 1970.01.01-05:30:00

resync('otd_test.example.com')

showComponentChanges('otd_test.example.com')
component otd_test.example.com changes on machine example.com: no change found.

# resyncAll
showComponentChanges()
component otd_test.example.com changes on machine example.com:
add OTD/test/config/baz.conf 1970.01.01-05:30:00 2014.11.07-17:42:57
component otd_origin-server-1.example.com changes on machine example.com:
add OTD/origin-server-1/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:43:34

resyncAll()

showComponentChanges()
component otd_test.example.com changes on machine example.com: no change found.
component otd_origin-server-1.example.com changes on machine example.com: no change found.

関連項目

「help」、「enableOverwriteComponentChanges」、「pullComponentChanges」、「showComponentChanges」、「stopEdit」、「undo」

showComponentChanges

説明

インスタンス上の構成ファイルの変更をすべてリストします。

構文

showComponentChanges(<instance_name>)

引数<instance_name>は、インスタンスの名前であり、オプションです。指定しない場合、すべてのインスタンスにわたる変更が表示されます。

注意:
Oracle Traffic Directorで構成を変更するには、server.xml、obj.confおよびmagnus.confなどの複数のファイルを変更する必要がある場合があります。したがって、不整合を回避するために、Oracle Traffic Directorでの構成の変更は、ユニットとして扱われるこれらのファイルとともに上書きまたはプルする必要があります。この結果、これらのファイルの1つを変更したとしても、これらはファイル・ユニットとして扱われるため、これらすべてが変更済として表示されます。

例

showComponentChanges()
component otd_test.example.com changes on machine example.com: no change found.
component otd_origin-server-1.example.com changes on machine example.com: no change found.
component otd_origin-server-2.example.com changes on machine example.com: no change found.
component otd_origin-server-3.example.com changes on machine example.com: no change found.

showComponentChanges('otd_test.example.com')
add OTD/test/config/foo.conf 1970.01.01-05:30:00 2014.11.07-17:06:30
edit OTD/test/config/server.xml 2014.11.06-19:48:15 2014.11.07-17:06:08
edit OTD/test/config/test-obj.conf 2014.11.06-16:59:32 1970.01.01-05:29:59
remove OTD/test/config/obj.conf 2014.11.06-19:48:15 1970.01.01-05:30:00

関連項目

「help」、「enableOverwriteComponentChanges」、「pullComponentChanges」、「resync/resyncAll」、「stopEdit」、「undo」

softRestart

説明

このWLSTコマンドを使用して、インスタンスを再起動または再構成します

動的に再構成すると、サーバーの再起動なしに構成変更がインスタンスに適用されます。動的に再構成可能な構成の変更のみが反映されます。user、temp-path、log、thread-pool、pkcs11、stats、dns、dns-cache、ssl-session-cacheおよびaccess-log-buffer設定の変更は、再構成手順が完了した後も同じままです。再構成の実行時に再起動を必要とする変更がある場合、「再起動が必要」例外がスローされます。

構文

softRestart(name, [block], [properties])

引数

定義

name

再起動するシステム・コンポーネントの名前。

block

オプション。サーバーが再起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。

properties

オプション。システム・コンポーネントに渡すプロパティを指定するプロパティ値。

例

インスタンスの再構成:

props = java.util.Properties()
props.setProperty("MODE", "RECONFIG")
cmo.softRestart(props)

インスタンスの再起動:

cmo.softRestart(java.util.Properties())

関連項目

「help」、「otd_deleteInstance」、「otd_listInstances」、「start」、「stop」、「otd_createInstance」

start

説明

インスタンスを起動します。

構文

start(name, [type])

引数

定義

name

起動するシステム・コンポーネントの名前。

type

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタを起動する場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

例

start('otd_foo_machine1')

関連項目

「help」、「otd_deleteInstance」、「otd_listInstances」、「otd_createInstance」、「stop」、「softRestart」

state

説明

インスタンスの状態を返します。

構文

state(name, [type])

引数

定義

name

現在の状態を取得するサーバー、クラスタまたはシステム・コンポーネントの名前。

type

オプション。タイプは、Server、ClusterまたはSystemComponentです。指定しない場合は、指定された名前のサーバー、クラスタまたはシステム・コンポーネントが検索されます。

例

state('otd_test.in.example.com')

関連項目

「help」

stop

説明

インスタンスを停止します。

構文

stop(name, [type])

例

stop('host.example.com', 'SystemComponent')

関連項目

「help」、「otd_deleteInstance」、「otd_listInstances」、「otd_createInstance」、「stop」、「softRestart」

stopEdit

説明

編集セッションを停止して、未保存の変更を破棄し、編集ロックを解放します。

構文

stopEdit([defaultAnswer])

引数

定義

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、現在の編集セッションを停止します。WLSTは取り消す前に確認を求めます。

wls:/mydomain/edit !> stopEdit()
Sure you would like to stop your edit session? (y/n)
y
Edit session has been stopped successfully.
wls:/mydomain/edit>

関連項目

「help」、「enableOverwriteComponentChanges」、「pullComponentChanges」、「resync/resyncAll」、「showComponentChanges」、「undo」

undo

説明

このコマンドは、保存されていない編集(undo())、またはアクティブ化されていない編集(undo('true'))をすべて元に戻します。このコマンドでは編集セッションは解放されません。このコマンドの効果はOracle Traffic Directorに限定されません。他の様々なコンポーネントおよび管理対象サーバーに対して編集セッションの開始後に実行された変更もすべて元に戻されます。

構文

undo([unactivatedChanges], [defaultAnswer])

引数

定義

unactivatedChanges

オプション。ディスクに保存された編集内容も含めて、アクティブ化されていないすべての変更を元に戻すかどうかを指定するブール値。この引数のデフォルトはfalseで、最後のsave操作以降に行われたすべての編集を元に戻すことを表します。

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、最後のsave操作以降に行われたすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo()
Sure you would like to undo your changes? (y/n)
y
Discarded your in-memory changes successfully.
wls:/mydomain/edit>

次の例では、アクティブ化されていないすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo('true')
Sure you would like to undo your changes? (y/n)
y
Discarded all your changes successfully.
wls:/mydomain/edit>

関連項目

「help」、「enableOverwriteComponentChanges」、「pullComponentChanges」、「resync/resyncAll」、「showComponentChanges」、「stopEdit」

オラクルの法律上の注意点について

コピーライトについて

Copyright © 1994-2017, Oracle and/or its affiliates. All rights reserved.

ライセンス制約の保証と結果的に生じる損害の免責

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

保証免責

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクルまでご連絡ください。

制限付権利について

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

危険な用途への使用について

このソフトウェアまたはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアまたはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、Oracle Corporationおよびその関連会社は一切の責任を負いかねます。

商標と登録商標について

OracleおよびJavaはオラクルおよびその関連会社の登録商標です。その他の社名、商品名等は各社の商標または登録商標である場合があります。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

第三者のコンテンツ、製品、サービスに対する免責事項

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

アルファ版およびベータ版ドラフト・ドキュメントについて

このドキュメントが試作版の場合:

このドキュメントは試作版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。Oracle Corporationおよびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。

非公開のアルファ版およびベータ版ドラフト・ドキュメントについて

このドキュメントが非公開の試作版の場合:

このドキュメントに含まれる情報は、情報の共有のみを目的としたものであって、顧客諮問委員会(Customer Advisory Board)のメンバーとしてのお客様の立場でのみ、またはお客様のベータ・トライアル契約のみに従って検討されるべきものとします。マテリアル、コード、または機能の提供をお約束するものではなく、購入決定を行う際の判断材料とすべきではありません。このドキュメントに記載されている特徴または機能の開発、リリースおよび時期については、オラクルの裁量により決定されます。

このドキュメントには、ソフトウェアまたは印刷物などの形式を問わず、オラクルが独占的な権利を有する財産的情報が含まれています。この機密資料へのアクセスと使用は、お客様とオラクルとの間で締結され、お客様が遵守に同意した、Oracle Master Agreement、Oracle License and Oracle Services Agreement (オラクル・ライセンスおよびサービスに関する契約書)、Oracle PartnerNetwork Agreement、Oracle Distribution Agreementまたはその他のライセンス契約の条件に従うものとします。このドキュメントとその内容の開示、コピー、複製および配布には、オラクルによる事前の承諾を必要とします。このドキュメントはライセンス契約の一部となるものではなく、オラクルおよびその子会社や関連会社との契約を構成するものではありません。

ドキュメントのアクセシビリティについて

オラクルのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイトhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc を参照してください。

Oracle Supportへのアクセス

サポートをご契約のお客様には、My Oracle Supportを通して電子支援サービスを提供しています。詳細情報はhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=infoか、聴覚に障害のあるお客様はhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=trsを参照してください。