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

12cリリース1 (12.1.1)

B65931-01(原本部品番号:E24490-01)

目次

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

はじめに

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

- 表記規則

1概要とロードマップ

- ドキュメントの内容と対象読者

- このドキュメントの手引き

- 関連ドキュメント

- このリリースでのWLSTの新機能と変更点

2 WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス

- WebLogic Server WLSTコマンドの概要(コマンドのアルファベット順)

- WebLogic Server WLSTオンライン・コマンドの概要

- WebLogic Server WLSTオフライン・コマンドの概要

3 WLSTコマンドおよび変数リファレンス

- WLSTコマンド・カテゴリの概要

- 参照コマンド

- cd

- currentTree

- prompt

- pwd

- 制御コマンド

- addTemplate

- closeDomain

- closeTemplate

- connect

- createDomain

- disconnect

- exit

- readDomain

- readTemplate

- updateDomain

- writeDomain

- writeTemplate

- カスタマイズ・コマンド

- addHelpCommandGroup

- addHelpCommand

- デプロイメント・コマンド

- deploy

- distributeApplication

- getWLDM

- listApplications

- loadApplication

- redeploy

- startApplication

- stopApplication

- undeploy

- updateApplication

- 診断コマンド

- exportDiagnosticData

- exportDiagnosticDataFromServer

- getAvailableCapturedImages

- saveDiagnosticImageCaptureFile

- saveDiagnosticImageCaptureEntryFile

- 編集コマンド

- activate

- assign

- cancelEdit

- create

- delete

- encrypt

- get

- getActivationTask

- invoke

- isRestartRequired

- loadDB

- loadProperties

- save

- set

- setOption

- showChanges

- startEdit

- stopEdit

- unassign

- undo

- validate

- 情報コマンド

- addListener

- configToScript

- dumpStack

- dumpVariables

- find

- getConfigManager

- getMBean

- getMBI

- getPath

- listChildTypes

- lookup

- ls

- man

- redirect

- removeListener

- showListeners

- startRecording

- state

- stopRecording

- stopRedirect

- storeUserConfig

- threadDump

- viewMBean

- writeIniFile

- ライフサイクル・コマンド

- migrate

- resume

- shutdown

- start

- startServer

- suspend

- ノード・マネージャ・コマンド

- nm

- nmConnect

- nmDisconnect

- nmEnroll

- nmGenBootStartupProps

- nmKill

- nmLog

- nmServerLog

- nmServerStatus

- nmStart

- nmVersion

- startNodeManager

- stopNodeManager

- ツリー・コマンド

- custom

- domainConfig

- domainCustom

- domainRuntime

- edit

- jndi

- serverConfig

- serverRuntime

- WLST変数リファレンス

Oracle® Fusion Middleware

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

12cリリース1 (12.1.1)

B65931-01(原本部品番号:E24490-01)

2011年12月

このドキュメントでは、WebLogic Scripting Tool (WLST)で利用できるすべてのコマンドについて説明します。このドキュメントでは、インストールされたOracle Fusion Middlewareコンポーネントの管理に使用できるWebLogic ServerでのWLSTコマンドおよびカスタムWLSTコマンドについて説明します。

Oracle Fusion Middleware WebLogic Scripting Toolコマンド・リファレンス12cリリース1 (12.1.1)

B65931-01

Copyright © 2007, 2011, Oracle and/or its affiliates.All rights reserved.

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

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

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

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション（人的傷害を発生させる可能性があるアプリケーションを含む）への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性（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の登録商標です。

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

はじめに

『WebLogic Scripting Toolコマンド・リファレンス』で使用しているドキュメント・アクセシビリティ新機能と会話を説明します。

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

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

Oracleサポートへのアクセス

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を参照してください。

表記規則

このドキュメントでは次の表記規則を使用します。

規則

意味

太字

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

斜体

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

固定幅フォント

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

1概要とロードマップ

この節では、『WebLogic Scripting Toolコマンド・リファレンス』ガイドの対象読者および内容と構成について説明します。

- ドキュメントの内容と対象読者

- このドキュメントの手引き

- 関連ドキュメント

- このリリースでのWLSTの新機能と変更点

ドキュメントの内容と対象読者

このドキュメントでは、WebLogic Scripting Tool (WLST)で利用できるすべてのコマンドについて説明します。このドキュメントでは、インストールされたOracle Fusion Middlewareコンポーネントの管理に使用できるWebLogic ServerでのWLSTコマンドおよびカスタムWLSTコマンドについて説明します。

注意:

コンポーネントは、ORACLE_HOMEディレクトリにインストールされている場合のみ、指定されたOracle Fusion MiddlewareコンポーネントのカスタムWLSTコマンドが使用できます。

このドキュメントは、OracleのJava Platform, Enterprise Edition (Java EE)を使用してJava EEアプリケーションをデプロイする、WebLogic Serverの管理者およびオペレータを対象としています。読者は、Webテクノロジ、およびWebLogic Serverがインストールされているオペレーティング・システムとプラットフォームに精通していることが前提となっています。

このドキュメントの手引き

このドキュメントの構成は次のとおりです。

- この章「概要とロードマップ」では、このガイドの構成および関連ドキュメントについて説明します。

- 「WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス」では、WebLogic Server WLSTコマンドをアルファベット順に、またオンラインで使用するものとオフラインで使用するものに分けて示します。

- 「WLSTコマンドおよび変数リファレンス」では、WLSTのコマンドおよび変数の各々について詳細に説明します。

関連ドキュメント

WebLogic Scripting Toolの使い方については、『Oracle WebLogic Scripting Tool』を参照してください。

WLSTは、WebLogic Serverを管理およびモニターするためのインタフェースの1つです。他の管理インタフェースについては、以下の場所を参照してください。

- 『Oracle WebLogic Serverアプリケーションの開発』の「Antタスクを使用したWebLogic Serverドメインの構成と使用」: WebLogic Serverインスタンスを起動および停止し、WebLogicドメインを構成するためのWebLogic Antタスクの使用について説明します。

- 『Oracle WebLogic Serverへのアプリケーションのデプロイ』の「デプロイメント・ツール」: アプリケーションやスタンドアロンのモジュールのデプロイ用にWebLogic Serverで用意されているいくつかのツールについて説明します。

- 『管理コンソール・オンライン・ヘルプ』は、WebLogicドメインを管理およびモニターするためのWebベースのグラフィカル・ユーザー・インタフェースについて説明します。

- 『構成ウィザードを使用したWebLogicドメインの作成』: グラフィカル・ユーザー・インタフェースを使用したWebLogicドメインの作成、または既存ドメインの拡張について説明します。

- 「PackおよびUnpackコマンドを使用したテンプレートとドメインの作成」: 既存のWebLogicドメインをすばやく簡単に再作成するコマンドについて説明します。

- 『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』: Java Management Extensions (JMX) APIを使用してWebLogic Serverリソースを監視および変更する方法について説明します。

- 『Oracle WebLogic Server SNMP管理ガイド』: Simple Network Management Protocol (SNMP)を使用してWebLogicドメインを監視する方法について説明します。

このリリースでのWLSTの新機能と変更点

このリリースで導入されたWebLogic Serverの新機能の一覧については、『Oracle WebLogic Serverの新機能』を参照してください。

2 WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス

この章では、オフライン・モード、オンライン・モードまたは両方で使用できるコマンドをアルファベット順で示しているWLSTコマンドについて説明します。

- WebLogic Server WLSTコマンドの概要(コマンドのアルファベット順)

- WebLogic Server WLSTオンライン・コマンドの概要

- WebLogic Server WLSTオフライン・コマンドの概要

注意:

それぞれ以下のコマンドを使用して、すべてのオンラインおよびオフライン・コマンドの概要をコマンド・ラインからリスト表示できます。

help("online")
help("offline")

WebLogic Server WLSTコマンドの概要(コマンドのアルファベット順)

次の表では、WebLogic Server WLSTの各コマンドについて、コマンドのアルファベット順で簡単に説明します。

表2-1 WebLogic Server WLSTコマンドの概要

コマンド

説明

WLSTの使用状況

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

オンライン

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

オンラインまたはオフライン

addHelpCommandGroup

WLST help()コマンドで表示されているコマンド・グループに新しいヘルプ・コマンド・グループを追加します。

オンラインまたはオフライン

addListener

指定されたMBeanにJMXリスナーを追加します。

オンライン

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。

オフライン

assign

リソースを1つまたは複数の宛先に割り当てます。

オフライン

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

オンライン

cd

構成Beanまたは実行時Beanの階層を移動します。

オンラインまたはオフライン

closeDomain

現在のWebLogicドメインを閉じます。

オフライン

closeTemplate

現在のドメイン・テンプレートを閉じます。

オフライン

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

オンラインまたはオフライン

connect

WLSTをWebLogic Serverインスタンスに接続します。

オンラインまたはオフライン

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

オンラインまたはオフライン

currentTree

階層内の現在の場所を返します。

オンライン

custom

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。

オンライン

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

オンラインまたはオフライン

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

オンライン

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

オンライン

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

オンライン

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのツリーに移動します。

オンライン

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

オンライン

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

オンラインまたはオフライン

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

オンラインまたはオフライン

edit

構成編集MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

encrypt

指定された文字列を暗号化します。

オンライン

exit

WLSTをユーザー・セッションから終了させて、スクリプト・シェルを閉じます。

オンラインまたはオフライン

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

オフライン

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

オンライン

find

現在の階層内でMBeanと属性を検索します。

オンライン

get

指定された属性の値を返します。

オンラインまたはオフライン

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

オンライン

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

オンライン

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

オンライン

getMBean

指定されたパスを参照してMBeanを返します。

オンライン

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

オンライン

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

オンライン

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

オンライン

invoke

現在の構成Beanの管理操作を呼び出します。

オンライン

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

オンライン

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

オンライン

listApplications

ドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

オンライン

listChildTypes

cmoで作成または削除できるすべての子MBeanを表示します。

オンライン

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

オンラインまたはオフライン

loadDB

SQLファイルをデータベースにロードします。

オフライン

loadProperties

プロパティ値をファイルからロードします。

オンラインおよびオフライン

lookup

指定されたMBeanをルックアップします。

オンライン

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

オンラインまたはオフライン

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

オンライン

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

オンライン

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

オンライン

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

オンラインまたはオフライン

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

オンラインまたはオフライン

nmEnroll

WLSTが現在動作しているマシンを登録します。

オンライン

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

オンライン

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

オンラインまたはオフライン

nmLog

ノード・マネージャ・ログを返します。

オンラインまたはオフライン

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

オンラインまたはオフライン

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

オンラインまたはオフライン

nmStart

ノード・マネージャを使用して、現在のドメイン内のサーバーを起動します。

オンラインまたはオフライン

nmVersion

ノード・マネージャのサーバーのバージョンを返します。

オンラインまたはオフライン

prompt

プロンプトでパス情報の表示を切り替えます。

オンラインまたはオフライン

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

オンラインまたはオフライン

readDomain

更新する既存のWebLogicドメインを開きます。

オフライン

readTemplate

WebLogicドメインを作成するために既存のドメイン・テンプレートを開きます。

オフライン

redeploy

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

オンライン

redirect

WLST出力を指定されたファイル名にリダイレクトします。

オンラインまたはオフライン

removeListener

以前に定義したリスナーを削除します。

オンライン

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

オンライン

save

編集されてまだ保存されていない編集内容を保存します。

オンライン

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

オンライン

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリiをダウンロードします。

オンライン

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

オンライン

set

現在の構成Beanの指定された属性値を設定します。

オンラインまたはオフライン

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します。

オフライン

showChanges

現在の編集セッション中に現在のユーザーが行った変更内容を表示します。

オンライン

showListeners

現在定義されているすべてのリスナーを表示します。

オンライン

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

オンライン

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

オンライン

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

オンライン

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

オンライン

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

オンラインまたはオフライン

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

オンラインまたはオフライン

startServer

管理サーバーを起動します。

オンラインまたはオフライン

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。

オンライン

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

オンライン

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

オンライン

stopNodeManager

ノード・マネージャを停止します。

オンラインまたはオフライン

stopRecording

WLSTコマンドの記録を停止します。

オンラインまたはオフライン

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

オンラインまたはオフライン

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

オンライン

suspend

実行中のサーバーを一時停止します。

オンライン

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

オンラインまたはオフライン

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

オンライン

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

オンライン

updateDomain

現在のドメインを更新して保存します。

オフライン

unassign

1つまたは複数の宛先からアプリケーションまたはサービスの割当てを解除します。

オフライン

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

オンライン

validate

変更されてまだ保存されていない変更内容を検証します。

オンライン

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

オンライン

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

オフライン

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

オンラインまたはオフライン

writeTemplate

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。

オフライン

WebLogic Server WLSTオンライン・コマンドの概要

次の表では、WebLogic Server WLSTオンライン・コマンドについて、コマンドのアルファベット順で簡単に説明します。

表2-2 WebLogic Server WLSTオンライン・コマンドの概要

コマンド

説明

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

addHelpCommandGroup

WLST help()コマンドで表示されているグループに新しいヘルプ・コマンド・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

addListener

指定されたMBeanにJMXリスナーを追加します。

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

cd

構成Beanまたは実行時Beanの階層を移動します。

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

connect

WLSTをWebLogic Serverインスタンスに接続します。

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

currentTree

現在のツリーの場所を返します。

custom

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのツリーに移動します。

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

dumpStack

最後に発生した実行のスタック・トレースを表示して、トレースをリセットします。

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

edit

構成編集MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

encrypt

指定された文字列を暗号化します。

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

find

現在の階層内でMBeanと属性を検索します。

get

指定された属性の値を返します。

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

getMBean

指定されたパスを参照してMBeanを返します。

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

invoke

現在の構成Beanの管理操作を呼び出します。

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

listApplications

ドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

listChildTypes

cmoで作成または削除できるすべての子MBeanを表示します。

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

loadProperties

プロパティ値をファイルからロードします。

lookup

指定されたMBeanをルックアップします。

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

nmEnroll

WLSTが現在動作しているマシンを登録します。

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

nmLog

ノード・マネージャ・ログを返します。

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

nmStart

ノード・マネージャを使用して、現在のドメイン内のサーバーを起動します。

nmVersion

ノード・マネージャのサーバーのバージョンを返します。

prompt

プロンプトでパス情報の表示を切り替えます。

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

redeploy

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

redirect

WLST出力を指定されたファイル名にリダイレクトします。

removeListener

以前に定義したリスナーを削除します。

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

save

編集されてまだ保存されていない編集内容を保存します。

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリiをダウンロードします。

serverConfig

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

set

現在の構成Beanの指定された属性値を設定します。

showChanges

現在の編集セッション中に現在のユーザーが行った変更内容を表示します。

showListeners

現在定義されているすべてのリスナーを表示します。

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

startServer

管理サーバーを起動します。

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

stopNodeManager

ノード・マネージャを停止します。

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

suspend

実行中のサーバーを一時停止します。

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

validate

変更されてまだ保存されていない変更内容を検証します。

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

WebLogic Server WLSTオフライン・コマンドの概要

次の表では、WebLogic Server WLSTオンライン・コマンドについて、コマンドのアルファベット順で簡単に説明します。

表2-3 Weblogic Server WLSTオフライン・コマンドの概要

コマンド

説明

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

addHelpCommandGroup

WLST help()コマンドで表示されているグループに新しいヘルプ・コマンド・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のドメインを拡張します。

assign

リソースを1つまたは複数の宛先に割り当てます。

cd

構成Beanまたは実行時Beanの階層を移動します。

closeDomain

現在のドメインを閉じます。

closeTemplate

現在のドメイン・テンプレートを閉じます。

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

connect

WLSTをWebLogic Serverインスタンスに接続します。

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

get

指定された属性の値を返します。

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

loadDB

SQLファイルをデータベースにロードします。

loadProperties

プロパティ値をファイルからロードします。

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

prompt

プロンプトでパス情報の表示を切り替えます。

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

readDomain

更新する既存のWebLogicドメインを開きます。

readTemplate

ドメインを作成するために既存のドメイン・テンプレートを開きます。

redirect

WLST出力を指定されたファイル名にリダイレクトします。

set

現在の構成Beanの指定された属性値を設定します。

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します。

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

startServer

管理サーバーを起動します。

stopNodeManager

ノード・マネージャを停止します。

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

unassign

1つまたは複数の宛先からアプリケーションまたはサービスの割当てを解除します。

updateDomain

現在のドメインを更新して保存します。

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

writeTemplate

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。

3 WLSTコマンドおよび変数リファレンス

この章では、WLSTコマンド・カテゴリの概要およびWLSTコマンドの詳細について説明します。WLST変数リファレンスも含まれます。内容は以下のとおりです。

- WLSTコマンド・カテゴリの概要

- 参照コマンド

- 制御コマンド

- カスタマイズ・コマンド

- デプロイメント・コマンド

- 診断コマンド

- 編集コマンド

- 情報コマンド

- ライフサイクル・コマンド

- ノード・マネージャ・コマンド

- ツリー・コマンド

- WLST変数リファレンス

WLSTコマンド・カテゴリの概要

注意:

コマンド構文要件は、『Oracle WebLogic Scripting Tool』のWLSTコマンドの構文に関する項を参照してください。

WLSTコマンドは以下のカテゴリに分かれています。

表3-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

参照コマンド

構成Beanまたは実行時Beanの階層を移動します。プロンプトの表示を制御します。

制御コマンド

- サーバーに接続したり、サーバーへの接続を切断したりします。

- WebLogicドメインまたはドメイン・テンプレートを作成および構成します。

- WLSTを終了します。

カスタマイズ・コマンド

WLST help()およびhelp('commandGroup')コマンドによって表示されるコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。

デプロイメント・コマンド

- アプリケーションとスタンドアロン・モジュールをWebLogic Serverインスタンスにデプロイ、アンデプロイ、および再デプロイします。

- 既存のデプロイメント・プランを更新します。

- WebLogicデプロイメント・マネージャ・オブジェクトに照会します。

- デプロイされたアプリケーションを起動および停止します。

診断コマンド

診断データをエクスポートします。

編集コマンド

構成Beanの照会や編集を行います。

情報コマンド

WebLogicドメイン、サーバー、変数に照会します。構成Bean、実行時Bean、WLSTに関連した情報を提供します。

ライフサイクル・コマンド

サーバー・インスタンスのライフサイクルを管理します。

ノード・マネージャ・コマンド

ノード・マネージャを使用して、WebLogic Serverインスタンスを起動、停止、再起動、およびモニターします。

ツリー・コマンド

MBean階層内を移動します。

参照コマンド

表3-2に示すWLST参照コマンドを使用して、構成Beanまたは実行時Beanの階層を移動したり、プロンプトの表示を制御したりします。

表3-2 WLST構成の参照コマンド

コマンド

説明

WLSTの使用状況

cd

構成Beanまたは実行時Beanの階層を移動します。

オンラインまたはオフライン

currentTree

階層内の現在の場所を返します。

オンライン

prompt

プロンプトでパス情報の表示を切り替えます。

オンラインまたはオフライン

pwd

階層内の現在の場所を表示します。

オンラインまたはオフライン

cd

コマンド・カテゴリ: 参照コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

構成Beanまたは実行時Beanの階層を移動します。このコマンドでは、WindowsまたはUNIXコマンド・シェルのファイル・システムを移動するときと同様のモデルを使用しています。たとえば、親の構成Beanまたは実行時Beanに戻るには、cd('..')と入力します。文字列.. (ドット、ドット)は、カレント・ディレクトリのすぐ上のディレクトリを表します。階層の深くにあるBeanに移動した後でルートのBeanに戻るには、cd('/')と入力します。

現在の階層内のBeanに移動できます。子やインスタンスに移動することができます。

cdコマンドは、構成Beanまたは実行時Beanのインスタンスがある場合は、そのスタブを返します。特定のタイプに移動する場合は、移動元になる構成Beanまたは実行時Beanインスタンスのスタブを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

cmo変数は、WLSTをサーバー・インスタンスに最初に接続するときに、すべてのドメイン構成Beanのルートに初期化されます。あるインスタンスに移動するまでは、この値が親構成Beanタイプとなります。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

cd(mbeanName)

引数

定義

mbeanName

ネーム・スペース内のBeanのパス。

例

以下の例では、構成Beanの階層を移動します。最初のコマンドではServers構成Beanタイプに、2番目のコマンドではmyserver構成Beanインスタンスに移動します。最後のコマンドで、2レベル上の元のディレクトリ位置に戻ります。

wls:/mydomain/serverConfig> cd('Servers')
wls:/mydomain/serverConfig/Servers> cd('myserver')
wls:/mydomain/serverConfig/Servers/myserver> cd('../..')
wls:/mydomain/serverConfig>

currentTree

コマンド・カテゴリ: 参照コマンド

WLSTの使用状況:オンライン

説明

階層内の現在の場所を返します。このコマンドを使用すると、階層内の現在の場所を格納しておいて、参照後に簡単にそこに戻ることができます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

currentTree()

例

以下の例では、階層内の現在の場所をmyTreeに格納して、管理サーバー・インスタンス上の実行時MBean階層から編集MBean階層に戻るときに使用します。

wls:/mydomain/edit> myTree=currentTree()
wls:/mydomain/edit> serverRuntime()
Location changed to serverRuntime tree. This is a read-only tree with
ServerRuntimeMBean as the root.
For more help, use help('serverRuntime')

wls:/mydomain/serverRuntime> myTree()
wls:/mydomain/edit>

prompt

コマンド・カテゴリ: 参照コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

引数なしで入力した場合は、プロンプトでパス情報の表示を切り替えます。このコマンドは、パスが長くてプロンプトが長くなり過ぎた場合に便利です。

このコマンドに、引数としてonまたはoffを明示的に指定することもできます。offを指定した場合、WLSTはWLSTプロンプトを非表示にして、デフォルトでJythonプロンプトを表示します。デフォルトでは、WLSTプロンプトは構成または実行時の移動パス情報を表示します。

プロンプトの詳細を表示しない場合に、階層内の現在の場所を調べるには、pwdコマンドを使用できます(「pwd」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

prompt(myPrompt)

引数

定義

myPrompt

オプション。WLSTプロンプトを非表示にしたり表示したりします。有効な値はoffまたはon。

- off引数の場合、WLSTプロンプトは非表示になります。
WLSTオンラインを使用してprompt('off')を実行した場合、プロンプトはデフォルトでJythonプロンプトになります。Jython構文を使用して新しいプロンプトを作成できます。Jythonを使用したプログラミングの詳細については、http://www.jython.orgを参照してください。その後に、引数なしでpromptコマンドを入力すると、WLSTはWLSTコマンド・プロンプトをパス情報なしで表示します。パス情報を再表示するには、prompt()と再度入力するか、prompt('on')と入力します。

- on引数の場合、パス情報を含むデフォルトのWLSTプロンプトが表示されます。

例

以下の例では、プロンプトでパス情報を非表示にしてから再表示します。

wls:/mydomain/serverConfig/Servers/myserver> prompt()
wls:/> prompt()
wls:/mydomain/serverConfig/Servers/myserver>

以下の例では、プロンプトを非表示にして、デフォルトでJythonプロンプトを表示し(WLSTオンラインを使用してコマンドを実行している場合)、Jythonプロンプトを変更してから、WLSTプロンプトを再表示します。この例では、pwdコマンドの使い方も示しています。

注意:

Jythonを使用したプログラミングの詳細については、http://www.jython.orgを参照してください。

wls:/mydomain/serverConfig/Servers/myserver> prompt('off')
>>>sys.ps1="myprompt>"
myprompt> prompt()
wls:> pwd()
'serverConfig:Servers/myserver'
wls:> prompt()
wls:/mydomain/serverConfig/Servers/myserver>

pwd

コマンド・カテゴリ: 参照コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

このコマンドは、promptコマンドを使用してプロンプトでパス情報の表示を無効にした場合に便利です(「prompt」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

pwd()

例

以下の例では、構成Bean階層内の現在の場所を表示します。

wls:/mydomain/serverConfig/Servers/myserver/Log/myserver> pwd()
'serverConfig:/Servers/myserver/Log/myserver'

制御コマンド

表3-3に示すWLST制御コマンドを使用して、以下のタスクを行います。

- サーバーに接続したり、サーバーへの接続を切断したりする(connectおよびdisconnectコマンド)

- 構成ウィザードと同様に、ドメイン・テンプレートから新しいWebLogicドメインを作成する(createDomain、readTemplate、writeDomainおよびcloseTemplateコマンド)

- 既存のWebLogicドメインをオフラインで更新する(readDomain、addTemplate,、updateDomainおよびcloseDomainコマンド)

- ドメイン・テンプレートを記述する(writeTemplateコマンド)

- WLSTを終了する

表3-3に、WLST構成の制御コマンドを示します。

表3-3 WLST構成の制御コマンド

コマンド

説明

WLSTの使用状況

connect

WLSTをWebLogic Serverインスタンスに接続します。

オンラインまたはオフライン

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

オンライン

createDomain

指定されたテンプレートを使用して新しいWebLogicドメインを作成します。

オフライン

readTemplate

ドメインを作成するために既存のドメイン・テンプレートを開きます。

オフライン

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

オフライン

closeTemplate

現在のドメイン・テンプレートを閉じます。

オフライン

readDomain

更新する既存のWebLogicドメインを開きます。

オフライン

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。

オフライン

updateDomain

現在のドメインを更新して保存します。

オフライン

closeDomain

現在のドメインを閉じます。

オフライン

writeTemplate

指定されたドメイン・テンプレート・ファイルに構成情報を書き込みます。

オフライン

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

オンラインまたはオフライン

addTemplate

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。テンプレート・ビルダーを使用してアプリケーション・テンプレートまたはサービスの拡張テンプレートを作成します。『Oracle WebLogic Serverドメイン・テンプレート・ビルダーを使用したテンプレートの作成』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

addTemplate(templateFileName)

引数

定義

templateFileName

アプリケーションまたはサービスの拡張テンプレートの名前。

例

以下の例では、WebLogicドメインを開いて、指定された拡張テンプレートDefaultWebApp.jarを使用してドメインを拡張します。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/wlw')
wls:/offline/wlw> addTemplate('c:/Oracle/Middleware/wlserver_12.1
/common/templates/applications/DefaultWebApp.jar')
wls:/offline/wlw>

closeDomain

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

現在のドメインを閉じます。一度閉じるとそのドメインは編集できなくなります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

closeDomain()

例

以下の例では、現在のドメインを閉じます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
...
wls:/offline/medrec> updateDomain()
wls:/offline/medrec> closeDomain()
wls:/offline>

closeTemplate

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

現在のドメイン・テンプレートを閉じます。一度閉じるとそのテンプレートは使用できなくなります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

closeTemplate()

例

以下の例では、既存のドメイン・テンプレートを開き、いくつかの操作を実行してから、現在のドメイン・テンプレートを閉じます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_12.1
/common/templates/domains/wls.jar')
...
wls:/offline/wls> closeTemplate()
wls:/offline>

connect

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTをWebLogic Serverインスタンスに接続します。

アクティブなWebLogicセキュリティ・レルムで定義されているユーザーの資格証明(ユーザー名およびパスワード)を提供する必要があります。接続後は、一群のセキュリティ・ポリシーによって、表示または変更できる構成属性が決まります。『WebLogic Server MBeanリファレンス』の「Default Security Policies for MBeans」を参照してください。

ユーザー資格証明は、次のいずれかの方法で提供できます。

- コマンド・ラインで資格証明を入力します。この方法は、WLSTを対話モードで使用している場合にのみお勧めします。

- 資格証明をコマンド・ラインで入力してから、storeUserConfigコマンドを使用して、暗号化された形式の資格証明が格納されたユーザー構成ファイル、およびその資格証明の復号化に使用されるキー・ファイルを作成します。以降のWLSTセッション(またはWLSTスクリプト)では、コマンド・ラインで資格証明を入力するかわりに、このユーザー構成ファイルおよびキー・ファイルの名前を指定します。この方法は、WLSTをスクリプト・モードで使用している場合にお薦めします。スクリプト・モードでは、暗号化されていないユーザー資格証明がスクリプトに格納されないためです。

- 管理サーバーのboot.propertiesファイルに格納されている資格証明を使用します。デフォルトでは、管理サーバーを開発モードで作成すると、WebLogic Serverはサーバーの作成に使用された資格証明を暗号化し、暗号化した資格をboot.propertiesファイルに格納します。管理サーバーを本番モードで作成すると、boot.propertiesファイルは作成されません。本番ドメインがboot.propertiesファイルを含まない場合、手動で作成できます。『Oracle WebLogic Serverサーバーの起動と停止の管理』の管理サーバーのブート識別ファイルの作成に関する項を参照してください。
connectコマンドの実行時にドメインの暗号化されたユーザー名とパスワードを含むboot.propertiesファイルが存在する場合、管理サーバーに接続するユーザー名とパスワードを入力する必要はありません。ただし、connectコマンドで管理サーバーの名前を指定する必要があります。

次の点に注意してください。

- ユーザー名とパスワード、またはユーザー構成ファイルとキー・ファイルを指定しないでスクリプトでconnectコマンドを実行すると、WSLTExceptionが発生します。対話モードでは、ユーザー名とパスワードの入力を求められます。

- WLSTのサーバーへの接続は、SSLポートまたは管理ポートを介して行うことが強く推奨されます。そうしなかった場合は、以下の警告メッセージが表示されます。

Warning: An insecure protocol was used to connect to the server. To ensure
on-the-wire security, the SSL port or Admin port should be used instead.

- デモ用のSSLキーおよび証明書を使用しているサーバーのSSLリスン・ポートからWebLogic Serverインスタンスに接続している場合は、次のコマンドでWLSTを呼び出します。

java -Dweblogic.security.SSL.ignoreHostnameVerification=true
-Dweblogic.security.TrustKeyStore=DemoTrust weblogic.WLST

WLSTの呼出しの詳細は、『Oracle WebLogic Scripting Tool』のWLSTの対話モードまたはスクリプト・モードでの使用の主な手順に関する項を参照してください。

- HTTPを介してWebLogic Serverインスタンスに接続している場合は、そのWebLogic ServerインスタンスのTunnelingEnabled属性がtrueに設定されていることを確認してください。詳細は、Oracle WebLogic Server MBeanリファレンスのTunnelingEnabledに関する項を参照してください。

- ホスト名にlocalhostを使用してWLSTからWebLogic Server管理サーバーに接続する場合、管理サーバーのlisten-address属性が特定のIPアドレスに制限されていると、次のメッセージが表示されることがあります。

javax.naming.CommunicationException [Root exception is
java.net.ConnectException : <t3://HOST:PORT> : Destination unreachable;
nested exception is: java.net.ConnectException: Connection refused; No
available router to destination

この問題には次のいずれかの回避策を使用できます。

- 管理サーバーのlisten-address属性が正しく設定されていることを確認します。次に、ドメイン構成ファイルの例を示します。

<server>
<name>AdminServer</name>
<ssl>
.
.
.
</ssl>
<machine>your_machine</machine>
<!-- listen-address><your_ip_address></listen-address -->
</server>

- WLST connectコマンドで、localhostのかわりに管理サーバーのホスト名を使用します。

WebLogic Serverインスタンスに正常に接続した後で、すべてのローカル変数が初期化されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

connect([username, password], [url], [timeout])
connect([userConfigFile, userKeyFile], [url], [timeout])
connect([url], [adminServerName], [timeout])

引数

定義

username

オプション。WLSTをサーバーに接続するオペレータのユーザー名。指定しない場合、WLSTはコマンドを上記のように処理します。

password

オプション。WLSTをサーバーに接続するオペレータのパスワード。指定しない場合、WLSTはコマンドを上記のように処理します。

url

オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。[protocol://]listen-address:listen-portという形式で指定します。指定しない場合、この引数はデフォルトでt3://localhost:7001になります。

timeout

オプション。オンライン・コマンドが完了する(返される)のをWLSTが待機するミリ秒数。
WLSTオンライン・コマンドを呼び出すと、WLSTはMBeanサーバーに接続してMBeanサーバー・メソッドを呼び出し、呼出しの結果を返します。MBeanサーバー・メソッドがタイムアウト期間内に返されない場合、WLSTは呼出しを破棄します。この引数には次の構文を使用します。

timeout='milliseconds'

値0は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

userConfigFile

オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。この引数には次の構文を使用します。
userConfigFile='file-system-path'

指定しない場合、WLSTはコマンドを上記のように処理します。

ユーザー構成ファイルの作成時に、storeUserConfigコマンドはキー・ファイルを使用してユーザー名とパスワードを暗号化します。ユーザー構成ファイルを暗号化するキー・ファイルのみが、そのユーザー名とパスワードを復号化できる(「storeUserConfig」を参照。)

userKeyFile

オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。この引数には次の構文を使用します。
userKeyFile='file-system-path'

指定しない場合、WLSTはコマンドを上記のように処理します。

「storeUserConfig」を参照してください。

adminServerName

オプション。ドメインの管理サーバーの名前。connectコマンドで、管理サーバーのboot.propertiesファイルに格納されている資格証明を使用するようにします。この引数には次の構文を使用します。
adminServerName='server-name'

この引数は、WLSTをドメイン・ディレクトリから起動した場合にのみ有効となります。管理サーバーのboot.propertiesファイルがドメイン・ディレクトリに格納されている場合は、この引数を指定する必要はありません。

指定しない場合、WLSTはコマンドを上記のように処理します。

例

以下の例では、WLSTをWebLogic Serverインスタンスに接続します。この例では、管理サーバー名はデフォルトのAdminServerになります。サーバーへの接続にSSLまたは管理ポートが使用されない場合は警告が表示されます。

wls:/offline> connect('weblogic','welcome1','t3://localhost:8001')
Connecting to weblogic server instance running at t3://localhost:8001 as
username weblogic...

Successfully connected to Admin Server 'AdminServer' that belongs to domain
'mydomain'.

Warning: An insecure protocol was used to connect to the server. To ensure
on-the-wire security, the SSL port or Admin port should be used instead.

wls:/mydomain/serverConfig>

以下の例では、WLSTを指定されたURLのWebLogic Serverインスタンスに接続します。この例では、ユーザー名とパスワードが引数として渡されます。この例ではセキュアなプロトコルを使用しています。

wls:/offline> username = 'weblogic'
wls:/offline> password = 'welcome1'
wls:/offline> connect(username,password,'t3s://myhost:8001')
Connecting to weblogic server instance running at t3://myhost:8001 as
username weblogic...

Successfully connected to Admin Server 'AdminServer' that belongs to domain
'mydomain'.
wls:/mydomain/serverConfig>

以下の例では、ユーザー資格証明を提供するユーザー構成ファイルとキー・ファイルを使用して、WLSTをWebLogic Serverインスタンスに接続します。

wls:/offline> connect(userConfigFile='c:/myfiles/myuserconfigfile.secure',
userKeyFile='c:/myfiles/myuserkeyfile.secure')
Connecting to t3://localhost:7001 with userid username ...

Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.
wls:/mydomain/serverConfig>

以下の例では、パラメータを使用しないでコマンドを実行する場合に対話モードで表示されるプロンプトを示します。

wls:/offline> connect()
Please enter your username :username
Please enter your password :
Please enter your server URL [t3://localhost:7001] :
Connecting to t3//localhost:7001 with userid username

createDomain

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

指定されたテンプレートを使用してWebLogicドメインを作成します。

注意:

WebLogicドメイン作成時にドメイン構成の設定を変更する場合は、『Oracle WebLogic Scripting Tool』のドメインの編集(オフライン)のオプション2に関する項を参照してください。
createDomainコマンドは、『packおよびunpackコマンドを使用したテンプレートとドメインの作成』で説明されているように、unpackコマンドに類似した機能を備えています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

createDomain(domainTemplate, domainDir, user, password)

引数

定義

domainTemplate

作成するドメインの基になるドメイン・テンプレートの名前および場所。

domainDir

ドメイン構成情報を書き込むディレクトリの名前。
使用する環境のすべてのドメインをミドルウェア・ホーム・ディレクトリ以外の場所に作成することをお薦めします。これによって、ドメインやアプリケーションを再作成せずに、既存のインストールの削除や新しいバージョンのWebLogic Serverのインストールが簡単にできるようになります。

user

デフォルト・ユーザーの名前。

password

デフォルト・ユーザーのパスワード。

例

次の例では、Avitek MedRecテンプレートを使用して新しいWebLogicドメインを作成し、デフォルトのユーザー名をweblogic、パスワードをwelome1に設定しています。ドメインがc:/Oracle/Middleware/wlserver_12.1/user_projects/domains/medrecディレクトリに保存されます。

wls:/offline> createDomain('c:/Oracle/Middleware/wlserver_12.1/common
/templates/domains/wls_medrec.jar','c:/Oracle/Middleware/user_projects/domains/medrec',
'weblogic', 'welcome1')

disconnect

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オンライン

説明

WLSTをWebLogic Serverインスタンスから接続解除します。disconnectコマンドを実行しても対話スクリプト・シェルは終了しません。対話シェルを開いたままで、現在のWebLogic Serverインスタンスの接続を閉じて、すべての変数をリセットします。

エラーが発生した場合は、WLSTExceptionが返されます。

connectコマンドを使用して別のWebLogic Serverインスタンスに接続できます(「connect」を参照)。

構文

disconnect(force)

引数

定義

force

オプション。アクティブなセッションの完了を待たずに接続を解除するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してから接続解除します。

例

以下の例では、実行中のサーバーから接続を解除します。

wls:/mydomain/serverConfig> disconnect()
Disconnected from weblogic server: myserver
wls:/offline>

exit

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTをユーザー・セッションから終了させて、スクリプト・シェルを閉じます。

進行中の編集セッションがある場合、WLSTはユーザーに確認を求めます。このプロンプトをスキップするには、defaultAnswer引数をyに設定します。

デフォルトでは、WLSTを終了するときに、現在のWLST JVMのSystem.exit(0)が呼び出されます。JVMに別の終了コードで終了させるには、exitCode引数を使用して値を指定できます。

注意:

Antスクリプトの中でWLST exitコマンドが発行されると、Antスクリプトの実行も終了する可能性があります。Antスクリプトの中でWLSTを呼び出す場合は、fork="true"を指定して新しいJVMを使用することをお勧めします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exit([defaultAnswer], [exitcode])

引数

定義

defaultAnswer

オプション。コマンド・ラインで入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

exitcode

オプション。WLSTを終了するときに設定する終了コード。

例

以下の例では、ユーザー・セッションから接続解除して、スクリプト・シェルを閉じます。

wls:/mydomain/serverConfig> exit()
Exiting WebLogic Scripting Tool ...
c:\>

以下の例では、ユーザー・セッションから接続解除して、スクリプト・シェルを閉じ、エラー・コードを101に設定します。

wls:/mydomain/serverConfig> exit(exitcode=101)
Exiting WebLogic Scripting Tool ...
c:\>

readDomain

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

更新するために既存のWebLogicドメインを開きます。

WLSTオフラインでは、テンプレート・ビルダーを使用して作成したドメイン・テンプレートJAR内、またはWebLogicドメインのconfigディレクトリ内に永続化されている構成データへの読み書きアクセスが可能です。このデータは、XMLドキュメントの集合であり、管理オブジェクトの階層構造を表します。

テンプレートまたはWebLogicドメインを開くと、WLSTはそのドメインの構成階層のルートに入り、プロンプトはその構成階層での現在の場所を示すように更新されます。次に例を示します。

wls:/offline/base_domain>

詳細は、『Oracle WebLogic Scripting Tool』のMBeanの移動と照会に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

readDomain(domainDirName)

引数

定義

domainDirName

開くWebLogicドメイン・ディレクトリの名前。

例

以下の例では、編集するためにmedrecドメインを開きます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
wls:/offline/medrec>

readTemplate

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

ドメインを作成するために既存のドメイン・テンプレートを開きます。

ドメイン・テンプレートを開くと、WLSTはそのドメイン・テンプレートの構成Bean階層に入り、プロンプトはその構成階層での現在の場所を示すように更新されます。次に例を示します。

wls:/offline/base_domain>

WebLogic Server構成Beanは階層構造の中に存在します。WLSTファイル・システムでは、階層はドライブに、タイプとインスタンスはディレクトリに、属性と操作はファイルに相当します。UNIXまたはWindowsコマンド・シェルでファイル・システムを移動するときと同じように、WLSTはcd、ls、およびpwdなどのコマンドを使用して、構成Beanの階層構造を移動します。構成Beanインスタンスに移動したら、WLSTコマンドを使用してBeanと対話します。詳細は、『Oracle WebLogic Scripting Tool』のMBeanの移動と照会に関する項を参照してください。

注意:

WLSTとドメイン・テンプレートを使用する場合、新しいWebLogicドメインを作成するときにのみセキュリティ情報を作成してアクセスできます。WebLogicドメインを更新するときは、WLSTからセキュリティ情報にアクセスすることはできません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

readTemplate(templateFileName)

引数

定義

templateFileName

ドメイン・テンプレートに相当するJARファイルの名前。

例

以下の例では、WebLogicドメインを作成するためにmedrec.jarドメイン・テンプレートを開きます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_12.1/common/templates
/domains/wls_medrec.jar')
wls:/offline/wls_medrec>

updateDomain

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

現在のWebLogicドメインを更新して保存します。更新して保存した後、ドメインは引続き編集可能になります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateDomain()

例

以下の例では、medrecドメインを開き、いくつかの操作を実行してから、現在のドメインを更新して保存します。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
...
wls:/offline/medrec> updateDomain()

writeDomain

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

指定されたディレクトリにドメインの構成情報を書き込みます。

WebLogicドメインをファイル・システムに書き込んだ後で、メモリー内に存在するドメイン・テンプレート・オブジェクトを引続き更新し、writeDomainコマンドを再発行して、ドメイン構成を新しいファイルまたは既存のファイルに格納できます。

デフォルトでは、WebLogicドメインを書き込むときに、関連するアプリケーションがWL_HOME/user_projects/applications/domainnameに書き込まれます。WL_HOMEはWebLogic Serverホーム・ディレクトリ、domainnameはWebLogicドメインの名前を表します。このディレクトリは空でなければなりません。空でない場合はエラーが表示されます。

メモリー内のドメイン・テンプレート・オブジェクトを使用し終えたら、closeTemplateコマンドを使用して閉じます。ディスクに保存されているWebLogicドメインを編集する場合は、readDomainコマンドを使用してドメインを開くことができます。

注意:

WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、ドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。

ドメインを書き込む前に、まだ定義されていない場合は、デフォルト・ユーザーのパスワードを定義する必要があります。次に例を示します。

cd('/Security/base_domain/User/weblogic')
cmo.setPassword('welcome1')

エラーが発生した場合は、WLSTExceptionが返されます。

構文

writeDomain(domainDir)

引数

定義

domainDir

ドメイン構成情報を書き込むディレクトリの名前。

例

以下の例では、medrec.jarドメイン・テンプレートを読み込み、いくつかの操作を実行してから、ドメイン構成情報をc:/Oracle/Middleware/user_projects/domains/medrecディレクトリに書き込みます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_12.1/common/templates
/domains/wls.jar')
...
wls:/offline/base_domain> writeDomain('c:/Oracle/Middleware/user_projects/domains/base_domain')

writeTemplate

コマンド・カテゴリ: 制御コマンド

WLSTの使用状況:オフライン

説明

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。ドメイン構成テンプレートを使用してWebLogicドメインを再作成できます。

構成情報をドメイン構成テンプレートに書き込んだ後で、メモリー内に存在するWebLogicドメインまたはドメイン・テンプレート・オブジェクトを引続き更新し、writeDomainまたはwriteTemplateコマンドを再発行して、ドメイン構成を新規あるいは既存のWebLogicドメインまたはドメイン・テンプレート・ファイルに格納できます。詳細については、「writeDomain」または「writeTemplate」をそれぞれ参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

writeTemplateコマンドは、packコマンドと類似した機能を備えています。『packおよびunpackコマンドを使用したテンプレートとドメインの作成』のpackコマンドに関する項を参照してください。ただし、writeTemplateは管理対象サーバー・テンプレートの作成をサポートしていません。

構文

writeTemplate(templateName)

引数

定義

templateName

ドメイン構成情報を格納するドメイン・テンプレートの名前。

例

以下の例では、現在のドメイン構成をc:/Oracle/Middleware/user_projects/templates/myTemplate.jarというドメイン・テンプレートに書き込みます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/mydomain')
...
wls:/offline/base_domain> writeTemplate('c:/Oracle/Middleware/user_projects
/templates/myTemplate.jar')

カスタマイズ・コマンド

表3-4に示すWLSTカスタマイズ・コマンドを使用して、WLST help()およびhelp('commandGroup')コマンドで示されるコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。WLSTへのコマンド・ヘルプの追加の詳細は、『Oracle WebLogic Scripting Tool』のカスタム・コマンドの統合型ヘルプの追加に関する項を参照してください。

表3-4 WLST構成のカスタマイズ・コマンド

コマンド

説明

WLSTの使用状況

addHelpCommandGroup

WLST help()コマンドで表示されているコマンド・グループに新しいヘルプ・コマンド・グループを追加します。

オンラインまたはオフライン

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

オンラインまたはオフライン

addHelpCommandGroup

コマンド・カテゴリ: カスタマイズ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLST help()コマンドで表示されているグループに新しいコマンド・ヘルプ・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

構文

addHelpCommandGroup(commandGroup, resourceBundleName)

引数

定義

commandGroup

コマンド・グループの一意の名前を使用します。WLST help()コマンドですでに示されているコマンド・グループ名を使用しないでください。

resourceBundleName

クラス名またはプロパティ・リソース・ファイル名を表します。リソース・バンドルには、標準パターンを使用したコマンド・グループのエントリのヘルプ・テキストが格納されます。リソース・バンドル名がResourceBundle.getBundle(...)に渡されます。複数のコマンド・グループで同じリソース・バンドルを使用できます。
リソース・バンドルは、クラスパスに指定されている必要があります。

各コマンド・グループおよびコマンドのヘルプ・テキストの定義方法の詳細は、『Oracle WebLogic Scripting Tool』のカスタム・コマンドの統合型ヘルプの追加に関する項を参照してください。

ResourceBundleおよびローカライゼーションについては、http://java.sun.com/javase/6/docs/api/java/util/ResourceBundle.htmlを参照してください。

例

以下の例では、bootコマンド・グループをhelp()コマンドで示されるグループのリストに追加し、ヘルプ・テキストをプロパティ・リソース・ファイル'myhelp'に格納します。

wls:/offline> addHelpCommandGroup('boot','myhelp')

以下の例では、bootコマンド・グループをhelp()コマンドで示されるグループのリストに追加し、ヘルプ・テキストをクラスfoo.bar.MyResourceBundleClassに格納します。

wls:/offline> addHelpCommandGroup('boot','foo.bar.MyResourceBundleClass')

addHelpCommand

コマンド・カテゴリ: カスタマイズ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。help('online')およびhelp('offline')コマンドで示すコマンドかどうかを指定することもできます。

構文

addHelpCommand(commandName,commandGroup,[offline=false, online=false])

引数

定義

commandName

commandGroupで指定されたコマンド・グループで定義されるコマンドの名前。

commandGroup

コマンドが属するcommandGroup。

online

オプション。コマンドをhelp('online')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。

offline

オプション。コマンドをhelp('offline')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。

例

以下の例では、オンライン・コマンドbootDBをhelp('boot')およびhelp('online')コマンドで示される出力に追加する方法を示します。

wls:/offline> addHelpCommand('bootDB','boot',online='true',offline='false')

デプロイメント・コマンド

表3-5に示すWLSTデプロイメント・コマンドを使用して、以下のことを行います。

- アプリケーションとスタンドアロン・モジュールをWebLogic Serverインスタンスにデプロイ、アンデプロイ、および再デプロイします。

- 既存のデプロイメント・プランを更新します。

- WebLogicデプロイメント・マネージャ・オブジェクトに照会します。

- デプロイされたアプリケーションを起動および停止します。

アプリケーションのデプロイの詳細については、『WebLogic Serverアプリケーションのデプロイメント』を参照してください。

表3-5 WLST構成のデプロイメント・コマンド

コマンド

説明

WLSTの使用状況

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

オンライン

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

オンライン

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

オンライン

listApplications

WebLogicドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

オンライン

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

オンラインおよびオフライン

redeploy

以前にデプロイされたアプリケーションを再デプロイします。

オンライン

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

オンライン

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

オンライン

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

オンライン

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

オンライン

deploy

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

WebLogic Serverインスタンスにアプリケーションをデプロイします。

deployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

進行中の編集セッションがある場合、deployコマンドはユーザーの対話をブロックしません。

構文

deploy(appName, path, [targets], [stageMode], [planPath], [options])

引数

定義

appName

デプロイするスタンドアロンJava EEモジュールまたはアプリケーションの名前。

path

デプロイするアプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

targets

オプション。対象のカンマ区切りのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

stageMode

オプション。デプロイするアプリケーションのステージング・モード。有効な値はstage、nostage、およびexternal_stageです。ステージング・モードについては、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のステージング・モードによるデプロイメント・ファイルのコピーの制御に関する項を参照してください。ステージ・モードを指定しない場合、デフォルトのステージ・モードが使用されます。デフォルトのステージ・モードは、管理サーバーではnostageで、管理対象サーバーではstageです。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。

- altDD - 管理サーバーにある、代替アプリケーション・デプロイメント記述子の場所。

- altWlsDD - 管理サーバーにある、代替WebLogicアプリケーション・デプロイメント記述子の場所。

- archiveVersion - アーカイブのバージョン番号。

- block - コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。このオプションのデフォルトはtrueです。falseに設定した場合、WLSTはコマンドの発行後に制御をユーザーに返します。WLSTProgressオブジェクトに問い合わせて、コマンドのステータスを調べることができます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

- clusterDeploymentTimeout - このアプリケーションでクラスタのデプロイメント・タスクに認められた時間(ミリ秒単位)。

- createPlan - ユーザーがデフォルト・プランを作成するかどうかを示すブール値。このオプションのデフォルトはfalseです。

- defaultSubmoduleTargets - 適格JMSサブモジュールの対象指定がシステムによって行われるかどうかを示すブール値。『Oracle WebLogic Serverへのアプリケーションのデプロイ』のJMSアプリケーション・モジュールにおけるサブモジュールの対象指定の使用に関する項を参照してください。デフォルト値はtrueです。

- depldoymentPrincipalName - 起動および停止時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。静的デプロイメントであるため、現在のデプロイメント・タスクには影響を与えません。ユーザーの存在を確認してください。このオプションによって、config.xmlファイルの要素<app-deployment>に<deployment-principal-name>が追加されます。

- forceUndeployTimeout - アンデプロイメントのタイムアウト値を強制します。

- gracefulIgnoreSessions - 本番モードから管理モードへの正常な移行の際に保留中のHTTPセッションを無視するかどうかを指定するブール値。このオプションのデフォルトはfalseで、gracefulProductionToAdminがtrueに設定されている場合にのみ適用されます。

- gracefulProductionToAdmin - 本番モードから管理モードへの移行を正常に行う必要があるかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- libImplVersion - ライブラリの実装バージョン(マニフェストにない場合)。

- libraryModule - モジュールがライブラリ・モジュールかどうかを示すブール値。このオプションのデフォルトはfalseです。

options

(続き)

- libSpecVersion - ライブラリの仕様バージョン(マニフェストにない場合)。

- planVersion - プランのバージョン番号。

- remote - ソースを格納するファイル・システムに対して操作がリモートになるかどうかを指定するブール値。この引数は、管理サーバーとは別のマシンで作業していて、管理サーバーのある指定された場所にすでにデプロイメント・ファイルがある場合に使用します。デフォルトはfalseです。

- retireGracefully - すべての処理中の作業が完了した後にのみ、アプリケーションを正常に廃止するための廃止ポリシー。このポリシーは停止および再デプロイ操作でのみ意味があり、廃止タイムアウト・ポリシーと相互に排他的になります。

- retireTimeout - 新しいバージョンで置き換えられたアプリケーションを廃止する前にWLSTが待機する時間(秒単位)。このオプションのデフォルトは-1で、正常なタイムアウトを指定します。

- securityModel - セキュリティ・モデル。有効な値はDDOnly、CustomRoles、CustomRolesAndPolicies、およびAdvanced。

- securityValidationEnabled - セキュリティ検証を有効にするかどうかを指定するブール値。

- subModuleTargets - JMSモジュールのサブモジュール・レベルの対象。submod@mod-jms.xml@target | submoduleName@targetなど。

- testMode - アクセスを制限してWebアプリケーションを起動するかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- timeout - 操作を取り消す前にWLSTがデプロイメント・プロセスの完了を待機する時間(ミリ秒単位)。値0は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

- upload - アプリケーション・ファイルが、デプロイメントの前にWebLogic Server管理サーバーのアップロード・ディレクトリにアップロードされるかどうかを指定するブール値。このオプションは、管理サーバーがファイル・システムでアプリケーション・ファイルにアクセスできない場合に使用します。デフォルトはfalseです。

- versionIdentifier - バージョン識別子。

例

以下の例では、c:/myapps/businessにあるbusinessAppアプリケーションをデプロイします。デフォルトのデプロイメント・プランが作成されます。

deployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトはユーザー定義の変数(この場合はprogress)に格納されます。

wls:/mydomain/serverConfig/Servers> progress= deploy(appName='businessApp',
path='c:/myapps/business',createplan='true')

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してdeployコマンドのステータスを出力できます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.printStatus()
Current Status of your Deployment:
Deployment command type: deploy
Deployment State       : completed
Deployment Message     : null
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

以下の例では、c:/myapps/demos/app/demoApp.earにあるアーカイブ・ファイル内のdemoAppアプリケーションをデプロイして、そのアプリケーション・モジュールをmyserverに割り当てます。c:/myapps/demos/app/plan/plan.xmlにあるデプロイメント・プラン・ファイルを使用します。WLSTはプロセスが完了するまで120,000ミリ秒待機します。

wls:/mydomain/serverConfig/Servers> deploy('demoApp',
'c:/myapps/demos/app/demoApp.ear', targets='myserver',
planPath='c:/myapps/demos/app/plan/plan.xml', timeout=120000)

以下の例では、c:/myapps/demos/jmsApp/demo-jms.xmlにあるjmsAppアプリケーションをデプロイして、そのアプリケーション・モジュールを特定の対象に割り当てます。

wls:/mydomain/serverConfig/Servers> deploy('jmsApp',path=
'c:/myapps/demos/jmsApps/demo-jms.xml', subModuleTargets='jmsApp@managed1')

次の例では、プロダクションの(side-by-side)再デプロイメントをサポートするように、アプリケーションのバージョン(appVersion)をユニークな識別子に設定する方法を示します。この例では、c:/myapps/demos/app/demoApp.earにあるアーカイブ・ファイル内のdemoAppアプリケーションをデプロイし、アプリケーションとアーカイブのバージョン番号を、指定された値に設定します。

wls:/mydomain/serverConfig> deploy('demoApp', 'c:/myapps/demos/app/demoApp.ear',
archiveVersion='901-101', appVersion='901-102')

プロダクションの再デプロイメント方式の詳細については、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のプロダクション環境でのアプリケーションの再デプロイメントに関する項を参照してください。

distributeApplication

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

指定されたターゲットにデプロイメント・バンドルをコピーします。デプロイメント・バンドルにはモジュール、構成データ、その他の生成コードが含まれます。distributeApplicationコマンドではデプロイメントは開始されません。

distributeApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

distributeApplication(appPath, [planPath], [targets], [options])

引数

定義

appPath

デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

targets

オプション。対象のカンマ区切りのリスト。各ターゲットをJava EEモジュール名で修飾できる(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

以下の例では、c:/myappsディレクトリにあるBigAppアプリケーションをロードして、WLSTProgressオブジェクトを、ユーザー定義の変数(この場合はprogress)に格納します。

以下の例では、c:/deployment/BigApp/plan.xmlで定義されたデプロイメント・プランを使用して、c:/myapps/BigAppアプリケーションをmyserver、oamserver1、oamclusterの各サーバーに配布します。

wls:/offline> progress=distributeApplication('c:/myapps/BigApp',
'c:/deployment/BigApp/plan.xml', 'myserver,oamserver1,oamcluster')
Distributing Application and Plan ...
Successfully distributed the application.

前の例では、WLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用して、distributeApplicationコマンドが完了したかどうかを判断できます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.isCompleted()
1
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

getWLDM

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

WebLogic DeploymentManagerオブジェクトを返します。このオブジェクトのメソッドを使用して、アプリケーションを構成したりデプロイしたりできます。このコマンドを実行するには、WLSTが管理サーバーに接続している必要があります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getWLDM()

例

以下の例では、WebLogicDeploymentManagerオブジェクトを取得してwldm変数に格納します。

wls:/mydomain/serverConfig> wldm=getWLDM()
wls:/mydomain/serverConfig> wldm.isConnected()
1
wls:/mydomain/serverConfig>

listApplications

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

WebLogicドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

listApplications()

例

以下の例では、mydomain内に現在デプロイされているすべてのアプリケーションをリストします。

wls:/mydomain/serverConfig> listApplications()
SamplesSearchWebApp
asyncServletEar
jspSimpleTagEar
ejb30
webservicesJwsSimpleEar
ejb20BeanMgedEar
xmlBeanEar
extServletAnnotationsEar
examplesWebApp
apache_xbean.jar
mainWebApp
jdbcRowSetsEar

loadApplication

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンラインおよびオフライン

説明

アプリケーションとデプロイメント・プランをメモリーにロードします。オンライン・モードで使用する場合、管理サーバーにのみ接続できます。管理対象サーバーには接続できません。

loadApplicationコマンドは、デプロイメント・プランを変更するためにアクセスできるWLSTPlanオブジェクトを返します。WLSTPlanオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTPlanオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadApplication(appPath, [planPath], [createPlan])

引数

定義

appPath

ロードするアプリケーションが含まれている、最上位の親アプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

createPlan

オプション。指定されたプランが存在しない場合に、WLSTがアプリケーション・ディレクトリにプランを作成するかどうかを指定するブール値。この引数のデフォルトはtrueです。

例

以下の例では、c:/myplans/myejb/plan.xmlのプラン・ファイルを使用してc:/myapps/myejb.jarアプリケーションをロードします。

wls:/offline> myPlan=loadApplication('c:/myapps/myejb.jar', 'c:/myplans/myejb/plan.xml')
Loading application from c:/myapps/myejb.jar and deployment plan from c:/myplans/myejb/plan.xml ...
Successfully loaded the application.

前の例では、返されたWLSTPlanオブジェクトをmyPlan変数に格納しています。myPlan変数を使用して、プランに関する情報(変数など)を表示できます。次に例を示します。

wls:/offline> myPlan.showVariables()
MyEJB jndi.ejb
MyWAR app.foo

WLSTPlanオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTPlanオブジェクトに関する項を参照してください。

redeploy

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

redeployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

アプリケーションの再デプロイの詳細については、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。

構文

redeploy(appName, [planPath], [options])

引数

定義

appName

再デプロイするアプリケーションの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。
加えて、redeployコマンドに対しては次のデプロイメント・オプションを指定可能。

- appPath - 再デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

- deploymentPrincipalName - 起動および停止時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。このオプションを使用すると、config.xmlファイルの現在の<deployment-principal-name>を上書きできます。

例

以下の例では、c:/myappsディレクトリにあるplan.xmlファイルを使用してmyAppアプリケーションを再デプロイします。

wls:/mydomain/serverConfig> progress=redeploy('myApp' 'c:/myapps/plan.xml')
Redeploying application 'myApp' ...
Redeployment of 'myApp' is successful
wls:/mydomain/serverConfig>

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してredeployコマンドの状態にアクセスできます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

startApplication

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

アプリケーションを起動して、ユーザーが利用できるようにします。アプリケーションは完全に構成済みで、WebLogicドメインで利用できる状態でなければなりません。

startApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

startApplication(appName, [options])

引数

定義

appName

plan.xmlファイルに指定されている、起動するアプリケーションの名前。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

以下の例では、指定されたデプロイメント・オプションでBigAppアプリケーションを起動します。

wls:/mydomain/serverConfig/Servers> progress=startApplication('BigApp', stageMode='NOSTAGE', adminMode='false')
Starting the application...
Successfully started the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してstartApplicationコマンドの状態にアクセスできます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

stopApplication

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

アプリケーションを停止して、ユーザーが利用できないようにします。アプリケーションは完全に構成済みで、WebLogicドメインで利用できる状態でなければなりません。

stopApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopApplication(appName, [options])

引数

定義

appName

plan.xmlファイルに指定されている、停止するアプリケーションの名前。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

以下の例では、BigAppアプリケーションを停止します。

wls:/offline> progress=stopApplication('BigApp')
Stopping the application...
Successfully stopped the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用して、stopApplicationコマンドが実行中かどうかをチェックできます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.isRunning()
0
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

undeploy

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

指定されたサーバーからアプリケーションをアンデプロイします。

undeployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

アプリケーションのデプロイとアンデプロイの詳細については、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。

構文

undeploy(appName,[targets],[options])

引数

定義

appName

デプロイ済みのアプリケーションのデプロイメント名。

targets

オプション。アプリケーションを削除するターゲット・サーバーのリスト。指定しない場合は、デフォルトで現在のすべての対象に設定されます。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

以下の例では、すべてのターゲット・サーバーからbusinessAppアプリケーションを削除します。WLSTはプロセスが完了するまで60,000ミリ秒待機します。

wls:/mydomain/serverConfig> undeploy('businessApp', timeout=60000)
Undeploying application businessApp ...
<Jul 20, 2005 9:34:15 AM EDT> <Info> <J2EE Deployment SPI> <BEA-260121>
<Initiating undeploy operation for application, businessApp [archive: null],
to AdminServer .>
Completed the undeployment of Application with status
Current Status of your Deployment:
Deployment command type: undeploy
Deployment State       : completed
Deployment Message     : no message
wls:/mydomain/serverConfig>

updateApplication

コマンド・カテゴリ:デプロイメント・コマンド

WLSTの使用状況:オンライン

説明

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。アプリケーションは完全に構成済みで、WebLogicドメインで利用できる状態でなければなりません。

updateApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateApplication(appName, [planPath], [options])

引数

定義

appName

現在のplan.xmlファイルに指定されているアプリケーションの名前。

planPath

オプション。新しいデプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

以下の例では、c:/myapps/BigApp/newPlanにあるplan.xmlファイルを使用して、BigAppのアプリケーション構成を更新します。

wls:/offline> progress=updateApplication('BigApp',
'c:/myapps/BigApp/newPlan/plan.xml', stageMode='STAGE', adminMode='false')
Updating the application...
Successfully updated the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してupdateApplicationコマンドの状態にアクセスできます。次に例を示します。

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

診断コマンド

表3-6に示すWLST診断コマンドを使用し、WebLogic診断フレームワーク(WLDF)のデータ・ストアに対して問合せを実行することによって、診断データを取得できます。WLDFの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

表3-6 WLST構成の診断コマンド

コマンド

説明

WLSTの使用状況

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

オフライン

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

オンライン

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

オンライン

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

オンライン

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリiをダウンロードします。

オンライン

exportDiagnosticData

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オフライン

説明

指定されたログ・ファイルに対する問合せを実行します。結果はXMLファイルとして保存されます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exportDiagnosticData([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。

- beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。

- endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。

- exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。

- logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLog。このオプションのデフォルトはServerLogです。

- logName - エクスポートするログ・データが含まれている基本ログ・ファイル名。このオプションのデフォルトはmyserver.logです。

- logRotationDir - ローテーションされるログ・ファイルが含まれるディレクトリ。このオプションのデフォルトは「.」(ログ・ファイルが格納されているディレクトリと同じディレクトリ)です。

- query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』のWLDF問合せ言語に関する項を参照してください。

- storeDir - サーバーの診断ストアの場所。このオプションのデフォルトは../data/store/diagnosticsです。

例

以下の例では、myserver.logという名前のServerLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/offline/mydomain>exportDiagnosticData(logicalName='ServerLog',
logName='myserver.log', exportFileName='myExport.xml')
{'elfFields': '', 'logName': 'myserver.log', 'logRotationDir': '.',
'endTimestamp': 9223372036854775807L, 'exportFileName': 'export.xml',
'storeDir': '../data/store/diagnostics', 'logicalName': 'ServerLog',
'query': '', 'beginTimestamp': 0}

Exporting diagnostic data to export.xml
<Aug 2, 2005 6:58:21 PM EDT> <Info> <Store> <BEA-280050> <Persistent store
"WLS_DIAGNOSTICS" opened: directory="c:\Oracle\Middleware
\wlserver_12.1\server\data\store\diagnostics"
writePolicy="Disabled" blockSize=512 directIO=false driver="wlfileio2">

wls:/mydomain/serverRuntime>

exportDiagnosticDataFromServer

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。結果はXMLファイルとして保存されます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exportDiagnosticDataFromServer([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。

- beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。

- endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。

- exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。

- logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLogです。このオプションのデフォルトはServerLogです。

- query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。

例

以下の例では、HTTPAccessLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/mydomain/serverRuntime> exportDiagnosticDataFromServer(logicalName="HTTPAccessLog", exportFileName="myExport.xml")

getAvailableCapturedImages

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

サーバーで構成したイメージの宛先ディレクトリに格納される以前に捕捉した診断イメージのリストを文字列の配列で戻します。デフォルトのディレクトリはSERVER\logs\diagnostic_imagesです。

このコマンドは、ダウンロードする診断イメージ・キャプチャの識別または特定のエントリをダウンロードする診断イメージ・キャプチャの識別に役立ちます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

getAvailableCapturedImages()

例

以下の例では、イメージの宛先ディレクトリで使用できる診断イメージ・キャプチャ・ファイルのリストを含むimagesという文字列の配列を戻し、diagnostic_image_myserver_2009_06_15_14_58_36.zipという診断イメージに含まれるエントリを出力します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverRuntime>print images [ 'diagnostic_image_myserver_2009_06_15_14_58_36.zip' ]

saveDiagnosticImageCaptureFile

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

WLSTが現在接続されているサーバーから指定した診断イメージ・キャプチャをダウンロードします。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

saveDiagnosticImageCaptureFile(imageName, [outputFile])

引数

定義

imageName

ダウンロードする診断イメージ・キャプチャの名前。

outputFile

オプション。取得した診断イメージ・キャプチャを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageNameの値および現在の作業ディレクトリになります。

例

以下の例では、サーバーのイメージ宛先ディレクトリにある診断イメージ・キャプチャのリストを取得します。saveDiagnosticImageCaptureFileコマンドの2つの使用例を示します。最初の使用例では、リストの最初の診断イメージ・キャプチャがデフォルトの出力ファイル名でローカル・マシンにダウンロードされます。2番目の使用例では、リストの最初の診断イメージ・キャプチャがファイルmylocalimg.zipでローカル・マシンにダウンロードされます。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0])
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local
path diagnostic_image_myserver_2009_06_25_12_12_50.zip
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0], 'mylocalimg.zip')
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local
path mylocalimg.zip
Connecting to http://localhost:7001 with userid weblogic ...

saveDiagnosticImageCaptureEntryFile

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

WLSTが現在接続されているサーバーにある診断イメージ・キャプチャから特定のエントリをダウンロードします。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使い方』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

saveDiagnosticImageCaptureEntryFile(imageName, imageEntryName, [outputFile])

引数

定義

imageName

任意のエントリを含む診断イメージ・キャプチャの名前。

imageEntryName

診断イメージ・キャプチャから取得する特定のエントリの名前。これは、次のいずれかです。

image.summary
JTA.img
JRockitFlightRecorder.jfr
FlightRecording.jfr
WatchSource.img
configuration.img
WORK_MANAGER.img
JNDI_IMAGE_SOURCE.img
APPLICATION.img
InstrumentationImageSource.img
SAF.img
Logging.img
PERSISTENT_STORE.img
JDBC.img
PathService.img
JMS.img
Deployment.img
JVM.img
CONNECTOR.img

outputFile

オプション。診断イメージ・キャプチャから取得したエントリを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageEntryNameの値および現在の作業ディレクトリになります。

例

以下の例では、診断イメージ・キャプチャのリストを取得し、saveDiagnosticImageCaptureEntryFileを2回使用します。最初の使用例では、デフォルトの出力ファイル名でローカル・マシンにイメージの概要を取得します。2番目の使用例では、ファイルmyimage.summaryでローカル・マシンにイメージの概要を取得します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path image.summary
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary', 'myimage.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path myimage.summary
Connecting to http://localhost:7001 with userid weblogic ...

編集コマンド

表3-7に示すWLST編集コマンドを使用して、構成Beanの照会や編集を行います。

注意:

構成Beanを編集するには、管理サーバーに接続している必要があります。また、編集ツリーに移動して、編集セッションを開始する必要があります。「edit」および「startEdit」をそれぞれ参照してください。
管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお勧めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。

構成Beanの編集の詳細は、『Oracle WebLogic Scripting Tool』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

表3-7 WLST構成の編集コマンド

コマンド

説明

WLSTの使用状況

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

オンラインまたはオフライン

assign

リソースを1つまたは複数の宛先に割り当てます。

オフライン

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

オンライン

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

オンラインまたはオフライン

delete

現在の構成Beanの構成のインスタンスを削除します。

オンラインまたはオフライン

encrypt

指定された文字列を暗号化します。

オンライン

get

指定された属性の値を返します。

オンラインまたはオフライン

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

オンライン

invoke

現在の構成Beanの管理操作を呼び出します。

オンライン

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

オンライン

loadDB

SQLファイルをデータベースにロードします。

オフライン

loadProperties

プロパティ値をファイルからロードします。

オンラインまたはオフライン

save

編集されてまだ保存されていない編集内容を保存します。

オンライン

set

現在の構成Beanの指定された属性値を設定します。

オンラインまたはオフライン

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します。

オフライン

showChanges

現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。

オンライン

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

オンライン

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

オンライン

unassign

1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。

オフライン

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

オンライン

validate

変更されてまだ保存されていない変更内容を検証します。

オンライン

activate

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

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

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

構文

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>

assign

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オフライン

説明

リソースを1つまたは複数の宛先に割り当てます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

assign(sourceType, sourceName, destinationType, destinationName)

引数

定義

sourceType

割り当てる構成Beanのタイプ。この値は、次のいずれかの値に設定できます。

- AppDeployment

- Library

- securityType(Userなど)

- Server

- service(JDBCSystemResourceなど)

- service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定する(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できる(AppDeployment.SubDeployment.SubDeploymentなど)。

この値の設定のガイドラインについては以下を参照してください。

sourceName

割り当てるリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。
サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。myJMSResource.myQueueSubDeploymentなど。ネストされたサブデプロイメントも指定できる(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。

注意: assignコマンドがネストされたサブデプロイメントと解釈するため、指定されたサブデプロイメント名でドット(.)を使用できません。

destinationType

宛先のタイプ。この値の設定のガイドラインについては以下を参照してください。

destinationName

宛先の名前。複数の名前をカンマで区切って指定できます。

sourceTypeおよびdestinationTypeの設定では以下のガイドラインを使用してください。

- アプリケーション・デプロイメントを割り当てるときは、次のように値を設定します。

- sourceType: AppDeployment

- destinationType: Target

- ライブラリを割り当てるときは、次のように値を設定します。

- sourceType: Library

- destinationType: Target

- サービスを割り当てるときは、次のように値を設定します。

- sourceType:特定のサーバーの名前(JDBCSystemResourceなど)

- destinationType: Target

- サーバーをクラスタに割り当てるときは、次のように値を設定します。

- sourceType: Server

- destinationType: Cluster

- サブデプロイメントを割り当てるときは、次のように値を設定します。

- sourceType: service.SubDeployment。serviceにはSubDeploymentの親を指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

- destinationType: Target

- セキュリティ・タイプを割り当てるときは、次のように値を設定します。

- sourceType:特定のセキュリティ・タイプの名前(Userなど)

- destinationType:宛先のセキュリティ・タイプの名前(Groupなど)

例

次に例を示します。

- myServerとmyServer2をクラスタmyClusterに割り当てます。

wls:/offline/mydomain> assign("Server", "myServer,myServer2", "Cluster", "myCluster")

- すべてのサーバーをクラスタmyClusterに割り当てます。

wls:/offline/mydomain> assign("Server", "*", "Cluster", "myCluster")

- アプリケーション・デプロイメントmyAppDeploymentをターゲット・サーバーnewServerに割り当てます。

wls:/offline/mydomain> assign("AppDeployment", "myAppDeployment", "Target", "newServer")

- ユーザーnewUserをグループMonitorsに割り当てます。

wls:/offline/mydomain> assign("User", "newUser", "Group", "Monitors")

- サブデプロイメントmyQueueSubDeployment (JMSリソースmyJMSResourceの子)をターゲット・サーバーnewServerに割り当てます。

wls:/offline/mydomain> assign('JMSSystemResource.SubDeployment',
'myJMSResource.myQueueSubDeployment', 'Target', 'newServer')

- ネストされたサブデプロイメントMedRecAppScopedJMS.MedRecJMSServer (アプリケーション・デプロイメントAppDeploymentの子)をターゲット・サーバーAdminServerに割り当てます。

wls:/offline/mydomain>assign('AppDeployment.SubDeployment.SubDeployment
','MedRecEAR.MedRecAppScopedJMS.MedRecJMSServer','Target','AdminServer')

cancelEdit

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。

このコマンドを発行するユーザーは現在の編集者でなくてもかまいません。つまり、必要な場合は、他のユーザーが編集セッションを開始できるように、管理者が編集セッションを取り消すことができます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

cancelEdit([defaultAnswer])

引数

定義

defaultAnswer

オプション。コマンド・ラインで入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

以下の例では、現在の編集セッションを取り消します。WLSTは取り消す前に確認を求めます。

wls:/mydomain/edit !> cancelEdit()
Sure you would like to cancel the edit session? (y/n)y
Edit session is cancelled successfully
wls:/mydomain/edit>

create

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

createコマンドは新しく作成された構成Beanのスタブを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

子タイプは、その親タイプのインスタンスの下に作成される必要があります。現在の構成管理オブジェクト(cmo)タイプの子である構成Beanのみを作成できます。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

WLSTオンラインでcreateコマンドを使用する場合は、以下の点に注意してください。

- 管理サーバーに接続している必要があります。実行時MBeanに対して、またはWLSTが管理対象サーバー・インスタンスに接続しているときに、createコマンドを使用することはできません。

- このコマンドを発行する前に、editコマンドを使用して構成MBean階層に移動する必要があります。「edit」を参照してください。

- createコマンドを使用して、現在のMBeanタイプの子であるWebLogic Server構成MBeanを作成できます。

WLSTオフラインでcreateコマンドを使用する場合は、以下の点に注意してください。

- WLSTオフラインを使用している場合、オブジェクト名において、ピリオド(.)、フォワード・スラッシュ(/)またはバックスラッシュ(\)は無効です。

詳細については、以下を参照してください。

- MBeanの作成については、『JMXによるカスタム管理ユーティリティの開発』の「WebLogic Server MBeanについて」を参照してください。

- JMSまたはJDBCシステム・リソースなど、特定のタイプのMBeanリソースを作成する例については、製品と一緒にインストールされるWLSTサンプル・スクリプトを参照(『Oracle WebLogic Scripting Tool』のWLSTサンプル・スクリプトに関する項を参照)。

- MBeanとその子タイプ、属性、操作については、『Oracle WebLogic Server MBeanリファレンス』を参照してください。

構文

create(name, childMBeanType, [baseProviderType])

引数

定義

name

作成する構成Beanの名前。

childMBeanType

作成する構成Beanのタイプ。config.xmlファイルに定義されたタイプのインスタンスを作成できます(カスタム・セキュリティ・タイプは除く)。有効な構成Beanの詳細については、『Oracle WebLogic Server MBeanリファレンス』を参照してください。

baseProviderType

セキュリティ・プロバイダを作成する場合は、基本セキュリティ・プロバイダ・タイプ(AuthenticationProviderなど)を指定します。この引数のデフォルトはNoneです。

例

以下の例では、現在の構成Beanで、newServerという名前のServerタイプの子構成Beanを作成して、スタブをserver1に格納します。

wls:/mydomain/edit !> server1=create('newServer','Server')
Server with name 'newServer' has been created successfully.
wls:/mydomain/edit !> server1.getName()
'newServer'
wls:/mydomain/edit !>

以下の例では、myProviderという認証セキュリティ・プロバイダを作成します。

wls:/mydomain/edit !> cd('SecurityConfiguration/mydomain/Realms/myrealm')
wls:/mydomain/edit !> create('myProvider','weblogic.security.providers.authentication.SQLAuthenticator'
,'AuthenticationProvider')
wls:/mydomain/edit ! cd('AuthenticationProviders/myProvider')
wls:/mydomain/edit ! set('ControlFlag', 'REQUIRED')

以下の例では、highsec_nmというマシンを作成して、関連するノード・マネージャの属性を設定します。

wls:/mydomain/edit !> create('highsec_nm', 'Machine')
wls:/mydomain/edit !> cd('Machine/highsec_nm/NodeManager/highsec_nm')
wls:/mydomain/edit !> set('DebugEnabled', 'true')
wls:/mydomain/edit !> set('ListenAddress', 'innes')
wls:/mydomain/edit !> set('NMType', 'SSL')
wls:/mydomain/edit !> set('ShellCommand', '')

delete

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

現在の構成管理オブジェクト(cmo)タイプの子である構成Beanのみを削除できます。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

delete(name, childMBeanType)

引数

定義

name

削除する子構成Beanの名前。

childMBeanType

削除する構成Beanのタイプ。config.xmlファイルで定義されたタイプのインスタンスを削除できます。有効な構成Beanの詳細については、『Oracle WebLogic Server MBeanリファレンス』を参照してください。

例

以下の例では、newServerという名前のServerタイプの構成Beanを削除します。

wls:/mydomain/edit !> delete('newServer','Server')
Server with name 'newServer' has been deleted successfully.
wls:/mydomain/edit !>

encrypt

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

指定された文字列を暗号化します。暗号化した文字列は、構成ファイルやコマンドの引数として使用できます。

このコマンドは、暗号化された文字列を使用する必要のある各WebLogicドメインにつき1回呼び出す必要があります。暗号化された文字列は、その文字列が元々暗号化されたWebLogicドメインでのみ使用できます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

encrypt(obj, [domainDir])

引数

定義

obj

暗号化する文字列。

domainDir

オプション。WebLogicドメイン・ディレクトリの絶対パス名。暗号化された文字列は、指定したディレクトリ内にあるWebLogicドメインでのみ使用できます。
この引数を指定しない場合、WLSTが現在接続されているWebLogicドメインで使用されるために文字列が暗号化されます。

例

以下の例では、指定されたWebLogicドメイン・ディレクトリにあるsecurity/SerializedSystemIni.datファイルを使用して、指定された文字列を暗号化します。

wls:/mydomain/serverConfig> es=encrypt('myPassword','c:/Oracle/Middleware/domains/mydomain')

get

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

指定された属性の値を返します。表示できるMBean属性の詳細については、『Oracle WebLogic Server MBeanリファレンス』を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

ls('a')と入力すると、すべての属性とその現在の値を表示できます。詳細については、「ls」を参照してください。

代わりに、cmo変数を使用して、現在の構成Beanの任意のgetメソッドを実行できます。次に例を示します。

cmo.getListenPort()

cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

get(attrName)

引数

定義

attrName

表示する属性の名前。属性のフル・パス名を指定できます。パス名を指定しない場合は、現在の構成オブジェクトの属性が表示されます。

例

以下の例では、現在の構成BeanのAdministrationPortの値を返します。

wls:/mydomain/serverConfig> get('AdministrationPort')
9002

代わりに、cmo変数を使用できます。

cmo.getAdministrationPort()

getActivationTask

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

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

注意:

WLSTの外部の変更をアクティブ化している場合、ConfigurationManagerMBean getActivationTasks()メソッドを使用して他のツールで作成したアクティブ化タスクにアクセスします。

構文

getActivationTask()

例

以下の例では、ユーザーがステータスを取得できる最新のActivationTask MBeanを返して、task変数に格納します。

wls:/mydomain/edit> task=getActivationTask()
wls:/mydomain/edit> if task!=None:
...   task.getState()
...
4

invoke

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

現在の構成Beanの管理操作を呼び出します。通常、このコマンドを使用して、ほとんどのWebLogic Server構成Beanで提供されているgetおよびset以外の操作を呼び出します。クラス・オブジェクトは、このアクションが呼び出される構成Beanをロードする際に使用されたものと同じクラス・ローダーから、ロードされます。

WLSTが管理対象サーバー・インスタンスに接続しているときにinvokeコマンドを使用することはできません。

成功した場合、invokeコマンドは、呼び出された操作が返すオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

invoke(methodName, parameters, signatures)

引数

定義

methodName

呼び出すメソッドの名前。

parameters

メソッド呼出しに渡されるパラメータの配列。

signatures

アクションのシグネチャを含む配列。

例

以下の例では、現在の構成BeanのlookupServerメソッドを呼び出します。

wls:/mydomain/config> objs = jarray.array([java.lang.String("oamserver")],java.lang.Object)
wls:/mydomain/edit> strs = jarray.array(["java.lang.String"],java.lang.String)
wls:/mydomain/edit> invoke('lookupServer',objs,strs)
true
wls:/mydomain/edit>

isRestartRequired

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

サーバーの再起動が必要かどうかを判断します。

編集セッションの進行中にこのコマンドを呼び出すと、現在進行中の編集に基づいてレスポンスが行われます。属性の名前を指定した場合は、その属性に関してのみ、サーバーの再起動が必要かどうかが示されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

isRestartRequired([attributeName])

引数

定義

attributeName

オプション。サーバーの再起動が必要かどうかをチェックする特定の属性の名前。

例

以下の例では、現在のWLSTセッション中に行われるすべての変更について、サーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired()
Server re-start is REQUIRED for the set of changes in progress.

The following attribute(s) have been changed on MBeans that require server re-start.
MBean Changed : mydomain:Name=mydomain,Type=Domain
Attributes changed : AutoConfigurationSaveEnabled

以下の例では、ConsoleEnabled属性を編集する場合にサーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired("ConsoleEnabled")
Server re-start is REQUIRED if you change the attribute ConsoleEnabled wls:/mydomain/edit !>

loadDB

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オフライン

説明

SQLファイルをデータベースにロードします。

loadDBコマンドは、テンプレート・ファイルからSQLファイルをロードします。このコマンドは、ドメイン・テンプレートまたは拡張テンプレートがメモリーにロードされた後でのみ発行できます(「readDomain」および「readTemplate」を参照)。

このコマンドを実行する前に、以下の条件に該当することを確認してください。

- 適切なデータベースが実行されています。

- 指定されたデータベースとバージョンのSQLファイルが存在します。
適切なSQLファイルが存在することを確認するには、ドメイン・テンプレートを開いて、_jdbc_ディレクトリにある関連するSQLファイル・リストjdbc.indexを見つけます。たとえば、Oracle 9iの場合、SQLファイル・リストは_jdbc_\Oracle\9i\jdbc.indexにあります。

上記の条件が満たされていない場合、コマンドは失敗します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadDB(dbVersion, datasourceName, dbCategory)

引数

定義

dbVersion

SQLファイルが使用されるデータベースのバージョン。

datasourceName

SQLファイルのロードに使用するJDBCデータ・ソースの名前。

dbCategory

オプション。指定されたデータ・ソースに関連付けられるデータベース・カテゴリ。
jdbc.indexファイルおよびデータベース・カテゴリの詳細については、『Oracle WebLogic Serverドメイン・テンプレート・リファレンス』のテンプレートに含まれるファイルに関する項を参照してください。

例

以下の例では、p13nDataSource JDBCデータ・ソースを使用して、データベースのバージョン5.1用のDrop/Create P13N Database Objectsに関連するSQLファイルをロードします。

wls:/offline/mydomain> loadDB('5.1', 'p13nDataSource', 'Drop/Create P13N Database Objects')

loadProperties

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンラインおよびオフライン

説明

プロパティ値をファイルからロードして、WLSTセッションで使用できるようにします。

『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadProperties(fileName)

引数

定義

fileName

プロパティ・ファイルのパス名。

例

この例では、プロパティ・ファイルの値を取得して設定します。

wls:/mydomain/serverConfig> loadProperties('c:/temp/myLoad.properties')

save

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

編集されてまだ保存されていない編集内容を保存します。このコマンドは、編集セッションが進行中の場合にのみ有効です。編集セッションの開始方法については、「startEdit」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

save()

例

以下の例では、まだディスクに保存されていない編集内容を保存します。

wls:/mydomain/edit !> save()
Saving all your changes ...
Saved all your changes successfully.
wls:/mydomain/edit !>

set

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

現在の管理オブジェクトの指定された属性値を設定します。WLSTオフラインを使用する場合、このコマンドは、属性値をドメインの構成ファイルに書き込みます。WLSTオンラインでは、MBean属性の値が設定されます。オンラインでの変更は、編集をアクティブ化したときに、ドメインの構成ファイルに書き込まれます。

エラーが発生した場合は、WLSTExceptionが返されます。

暗号化された属性(名前の末尾がEncryptedとなっている属性)の設定については、『Oracle WebLogic Scripting Tool』の暗号化された構成値の読み書きに関する項を参照してください。

WLSTオンラインを使用する場合は以下の点に注意してください。

- このコマンドを使用するには、編集セッションに移動する必要があります。「startEdit」を参照してください。

- このコマンドは、WLSTが管理対象サーバーに接続しているときには使用できません。

- このコマンドのかわりとして、次の構文とともにcmo変数を使用できます。
cmo.setattrName(value)

たとえば、set('ListenPort', 7011)を使用する代わりに、次の構文を使用できます。

cmo.setListenPort(7011)

cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

set(attrName, value)

引数

定義

attrName

設定する属性の名前。

value

設定する属性の値。
注意: この値は一重または二重の引用符で囲む必要がありません。例を参照してください。

例

以下の例では、DomainMBeanのArchiveConfigurationCount属性を10に設定します。

wls:/mydomain/serverConfig> set('ArchiveConfigurationCount', 10)

次の例では、カスタムMbeanのT1TimerInterval属性のlong値を123に設定しています。

wls:/mydomain/serverConfig> set('T1TimerInterval', Long(123))

次の例では、カスタムMbeanのMyBooleanAttribute属性のブール値をtrueに設定しています。

wls:/mydomain/serverConfig> set('MyBooleanAttribute', Boolean(true))

setOption

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オフライン

説明

WebLogicドメインの作成または更新に関連するオプションを設定します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

setOption(optionName, optionValue)

引数

定義

optionName

設定するオプションの名前。
ドメインの作成で使用できるオプションは次のとおりです。

- CreateStartMenu - Windowsプラットフォームの[スタート]メニューにショートカットを作成するかどうかを指定するブール値。このオプションのデフォルトはtrueです。
注意: 管理者権限を持つユーザーがソフトウェアをインストールして、「All Users」フォルダに「スタート」メニューのエントリを作成した場合は、管理者権限を持つユーザーのみが、構成ウィザードまたはWLSTを使用してWebLogicドメインを作成するときに、同じフォルダに「スタート」メニューのエントリを作成できます。つまり、管理者権限を持たないユーザーが、このインストールから構成ウィザードまたはWLSTを使用してドメインを作成しても、そのドメインへの「スタート」メニューのショートカットは作成されません。この場合は、必要に応じて、ローカルの「スタート・メニュー」フォルダに手動でショートカットを作成できます。

- DomainName - WebLogicドメインの名前。デフォルトでは、WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、WebLogicドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。DomainNameを設定すると、作成されたドメインの名前がドメイン・ディレクトリ名に依存することはなくなります。

- JavaHome - サーバーの起動時に使用するJVMのホーム・ディレクトリ。このオプションのデフォルトは、WebLogic Serverをインストールしているプラットフォームによって異なります。

- OverwriteDomain - 既存のWebLogicドメインを上書き可能にするかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- ServerStartMode - 新規作成したWebLogicドメインでサーバーを起動するときに使用するモード。この値は、dev (開発)またはprod (プロダクション)に設定できます。このオプションのデフォルトはdevです。

ドメインの更新で使用できるオプションは次のとおりです。

- AllowCasualUpdate - 拡張テンプレートを追加せずに、WebLogicドメインの更新を許可するかどうかを指定するブール値。このオプションのデフォルトはtrueです。

- ReplaceDuplicates - 競合があった場合に、WebLogicドメインの元の構成の要素を保持するか、拡張テンプレートの対応する要素で置き換えるかを指定するブール値。このオプションのデフォルトはtrueです。

ドメインの作成とドメインの更新の両方で使用できるオプションは次のとおり。

- AppDir - 指定されたテンプレートに従って、アプリケーションに別のディレクトリが必要な場合に使用するアプリケーション・ディレクトリ。このオプションのデフォルトは、WL_HOME/user_projects/applications/domainnameになります。WL_HOMEはWebLogic Serverホーム・ディレクトリ、domainnameはWebLogicドメインの名前を表します。

- AutoAdjustSubDeploymentTarget - WLSTが、AppDeploymentsのサブデプロイメントの対象を自動的に調整するかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、オプションをfalseに設定して、WebLogicドメインまたはドメイン・テンプレートを書き込むか更新する前に、AppDeploymentのサブデプロイメントの対象を明示的に設定します。

- AutoDeploy - クラスタまたは複数の管理対象サーバーを作成するときに、自動デプロイメントをアクティブにするかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、スクリプトの最初の行でこのオプションをfalseに設定します。

optionValue

オプションの値。
注意: ブール値は、文字列(true、false)または整数(0、1)として指定できます。

例

以下の例では、CreateStartMenuオプションをfalseに設定します。

wls:/offline> setOption('CreateStartMenu', 'false')

showChanges

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

showChanges([onlyInMemory])

引数

定義

onlyInMemory

オプション。まだ保存されていない変更のみを表示するかどうかを指定するブール値。この引数のデフォルトはfalseで、セッションの最初から行われたすべての変更が表示されることを表します。

例

以下の例では、現在の編集セッションが開始されてから、現在のユーザーが構成に加えたすべての変更が表示されます。

wls:/mydomain/edit !> showChanges()
Changes that are in memory and saved to disc but not yet activated are:

MBean Changed           : com.bea:Name=basicWLSDomain,Type=Domain
Operation Invoked       : add
Attribute Modified      : Machines
Attributes Old Value    : null
Attributes New Value    : Mach1
Server Restart Required : false

MBean Changed           : com.bea:Name=basicWLSDomain,Type=Domain
Operation Invoked       : add
Attribute Modified      : Servers
Attributes Old Value    : null
Attributes New Value    : myserver
Server Restart Required : false

startEdit

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

現在接続しているユーザーのために構成編集セッションを開始します。このコマンドを発行する前に、editコマンドを使用して構成MBean階層に移動する必要があります。詳細については、「edit」を参照してください。

WebLogicドメイン構成を変更するコマンドを呼び出す前に、このコマンドを呼び出す必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

同じユーザーによる進行中の編集セッションがあることを検出した場合、WLSTは自動的に編集セッションを開始します。進行中のセッションは管理コンソールまたは別のWLSTセッションから開始された可能性があります。

構文

startEdit([waitTimeInMillis], [timeoutInMillis], [exclusive])

引数

定義

waitTimeInMillis

オプション。別のユーザーがロックを保持している場合に、WLSTがロックを取得するまでに待機する時間(ミリ秒単位)。この引数のデフォルトは0ミリ秒です。

timeOutInMillis

オプション。WLSTが編集ロックの解放を待機するタイムアウト(ミリ秒単位)。この引数のデフォルトは -1ミリ秒で、この編集セッションが期限切れにならないことを表します。

exclusive

オプション。編集セッションを排他的なセッションにするかどうかを指定します。trueに設定した場合、同じ所有者がstartEditコマンドを入力すると、WLSTは新しい編集セッションを開始する前に、現在の編集セッションのロックが解放されるまで待機します。排他的なロックはtimeoutInMillisで指定された時間に従ってタイムアウトします。この引数のデフォルトはfalseです。

例

以下の例では、まだディスクに保存されていない編集内容を保存します。

wls:/mydomain/edit> startEdit(60000, 120000)
Starting an edit session ...
Started edit session, please be sure to save and activate your changes once you are done.
wls:/mydomain/edit !>

stopEdit

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

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>

unassign

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オフライン

説明

1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

unassign(sourceType, sourceName, destinationType, destinationName)

引数

定義

sourceType

割当て解除する構成Beanのタイプ。この値は、次のいずれかの値に設定できます。

- AppDeployment

- Library

- securityType(Userなど)

- Server

- service(JDBCSystemResourceなど)

- service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

sourceName

割当てを解除するアプリケーションまたはリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。
サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。myJMSResource.myQueueSubDeploymentなど。ネストされたサブデプロイメントも指定できます(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。

destinationType

宛先のタイプ。この値の設定のガイドラインについては以下を参照してください。

destinationName

宛先の名前。複数の名前をカンマで区切って指定できます。

sourceTypeおよびdestinationTypeの設定では以下のガイドラインを使用してください。

- アプリケーション・デプロイメントを割当て解除するときは、次のように値を設定します。

- sourceType: AppDeployment

- destinationType: Target

- ライブラリを割当て解除するときは、次のように値を設定します。

- sourceType: Library

- destinationType: Target

- セキュリティ・タイプを割当て解除するときは、次のように値を設定します。

- sourceType:特定のセキュリティ・タイプの名前(Userなど)

- destinationType:宛先のセキュリティ・タイプの名前(Groupなど)

- クラスタからサーバーを割当て解除するときは、次のように値を設定します。

- sourceType: Server

- destinationType: Cluster

- サービスを割当て解除するときは、次のように値を設定します。

- sourceType:特定のサーバーの名前(JDBCSystemResourceなど)

- destinationType: Target

- サブデプロイメントを割当て解除するときは、次のように値を設定します。

- sourceType: service.SubDeployment。serviceにはSubDeploymentの親を指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

- destinationType: Target

例

次に例を示します。

- myServerとmyServer2をクラスタmyClusterから割当て解除します。

wls:/offline/medrec> unassign("Server", "myServer,myServer2", "Cluster", "myCluster")

- すべてのサーバーをクラスタmyClusterから割当て解除します。

wls:/offline/mydomain> unassign("Server", "*", "Cluster", "myCluster")

- ユーザーnewUserをグループMonitorsから割当て解除します。

wls:/offline/medrec> unassign("User", "newUser", "Group", "Monitors")

- アプリケーション・デプロイメントmyAppDeploymentをターゲット・サーバーnewServerから割当て解除します。

wls:/offline/mydomain> unassign("AppDeployment", "myAppDeployment", "Target", "newServer")

- ネストされたサブデプロイメントMedRecAppScopedJMS.MedRecJMSServer (アプリケーション・デプロイメントAppDeploymentの子)をターゲット・サーバーAdminServerから割当て解除します。

wls:/offline/mydomain> assign('AppDeployment.SubDeployment.SubDeployment',
'MedRecEAR.MedRecAppScopedJMS.MedRecJMSServer', 'Target','AdminServer')

undo

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

保存またはアクティブ化されていない編集をすべて元に戻します。

(ディスクに保存されたものも含めて)アクティブ化されていないすべての編集を元に戻すか、または、最後のsave操作以降に行われたすべての編集を元に戻すかを指定します。このコマンドでは編集セッションは解放されません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

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>

validate

コマンド・カテゴリ: 編集コマンド

WLSTの使用状況:オンライン

説明

変更されてまだ保存されていない変更内容を検証します。このコマンドを使用すると、保存する前に、すべての変更が有効かどうかを検証することができます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

validate()

例

以下の例では、変更されてまだ保存されていないすべての変更内容を検証します。

wls:/mydomain/edit !> validate()
Validating changes ...
Validated the changes successfully

情報コマンド

表3-8に示すWLST情報コマンドを使用して、ドメイン、サーバー、変数に照会したり、構成Bean、実行時Bean、WLSTに関連した情報を提供したりします。

表3-8 WLST構成の情報コマンド

コマンド

説明

WLSTの使用状況

addListener

指定されたMBeanにJMXリスナーを追加します。

オンライン

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

オンラインまたはオフライン

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

オンラインまたはオフライン

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

オンラインまたはオフライン

find

現在の階層内でMBeanと属性を検索します。

オンライン

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

オンライン

getMBean

指定されたパスを参照してMBeanを返します。

オンライン

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

オンライン

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

オンライン

listChildTypes

cmoタイプで作成または削除できるすべての子MBeanを表示します。

オンライン

lookup

指定されたMBeanをルックアップします。

オンライン

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

オンラインまたはオフライン

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

オンライン

redirect

WLST出力を指定されたファイル名にリダイレクトします。

オンライン

removeListener

以前に定義したリスナーを削除します。

オンライン

showListeners

現在定義されているすべてのリスナーを表示します。

オンライン

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

オンラインまたはオフライン

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。

オンライン

stopRecording

WLSTコマンドの記録を停止します。

オンラインまたはオフライン

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

オンラインまたはオフライン

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

オンライン

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

オンラインまたはオフライン

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

オンライン

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

オンラインまたはオフライン

addListener

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

指定されたMBeanにJMXリスナーを追加します。MBeanで変更が行われると、その内容が標準出力に報告されて、指定された構成ファイルに保存されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

addListener(mbean, [attributeNames], [logFile], [listenerName])

引数

定義

mbean

リスンするMBeanまたはMBeanオブジェクトの名前。

attributeNames

オプション。JMXリスナーを追加するすべての属性名のカンマ区切りのリスト。この引数のデフォルトはnullで、すべての属性にJMXリスナーが追加されます。

logFile

オプション。リスナー情報を書き込むログ・ファイルの名前と場所です。この引数のデフォルトは標準出力です。

listenerName

オプション。JMXリスナーの名前。この引数のデフォルトは、WLSTで生成される名前です。

例

以下の例では、cmo MBeanで、NotesおよびArchiveConfigurationCount属性に対してJMXリスナーを定義します。リスナーの名前はdomain-listenerで、./listeners/domain.logに保存されます。

wls:/mydomain/serverConfig> addListener(cmo, "Notes,ArchiveConfigurationCount",
"./listeners/domain.log","domain-listener")

configToScript

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。その結果得られたスクリプトは、他のサーバー上のリソースの再作成に使用できます。

configToScriptコマンドでは次のファイルが作成されます。

- 構成の再作成に必要なコマンドが格納されているWLSTスクリプト。

- ドメイン固有の値が格納されているプロパティ・ファイル。このファイルの値を更新すると、元の構成に似た新しいドメインを作成することができます。

- 暗号化された属性を格納するユーザー構成ファイルおよび関連キー・ファイル。ユーザー構成ファイルには暗号化された情報が格納されます。キー・ファイルには、情報の暗号化と復号化に使用される秘密鍵が格納されます。

生成されたスクリプトを実行すると、次の処理が行われます。

- サーバーが現在実行中であれば、WLSTはプロパティ・ファイル内の値を使用して接続を確立し、次にスクリプト・コマンドを実行して、サーバー・リソースを作成しようとします。

- 現在実行されているサーバーがなければ、WLSTはプロパティ・ファイル内の値でサーバーを起動し、スクリプト・コマンドを実行してサーバー・リソースを作成し、サーバーを停止します。これにより、WLSTがコマンド・シェルを終了させることがあります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

configToScript([configPath], [pyPath], [overwrite], [propertiesFile], [createDeploymentScript])

引数

定義

configPath

オプション。変換する構成が格納されたdomainディレクトリのパス。この引数のデフォルトは、WLSTの起動元ディレクトリ(./)です。

pyPath

オプション。変換後のWLSTスクリプトを書き込むパスとファイル名。この引数のデフォルトは/config/config.pyです。

overwrite

オプション。スクリプト・ファイルが既に存在する場合、そのファイルを上書きするかどうかを指定するブール値。この引数のデフォルトはtrueで、スクリプト・ファイルは上書きされます。

propertiesFile

オプション。WLSTがプロパティ・ファイルを書き込むパスとディレクトリ。この引数のデフォルトは、scriptPath引数で指定されたパス名です。

createDeploymentScript

オプション。WLSTがデプロイメントのみを実行するスクリプトを作成するかどうかを指定するブール値。この引数のデフォルトはfalseで、デプロイメント・スクリプトが作成されないことを表します。

例

以下の例では、構成をWLSTスクリプトconfig.pyに変換します。デフォルトで、構成ファイルは./configからロードされて、スクリプト・ファイルは.config/config.pyに、プロパティ・ファイルは.config/config.py.propertiesに保存されます。

wls:/offline> configToScript()
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\wls\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware
\user_projects\domains\wls\config\config.py
and the properties file associated with this script is written to c:\Oracle\
Middleware\user_projects\domains\wls\config\config.py.properties
wls:/offline>

以下の例では、ファイルc:\Oracle\Middleware\user_projects\domains\mydomain\configディレクトリで構成されたサーバー・リソースをWLSTスクリプトc:\Oracle\Middleware\myscripts\config.pyに変換します。

wls:/offline> configToScript('c:/Oracle/Middleware/user_projects/domains
/mydomain','c:/Oracle/Middleware/myscripts')
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\mydomain\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware\myscripts\config.py
and the properties file associated with this script is written to
c:\Oracle\Middlware\mydomain\config.py.properties
wls:/offline>

dumpStack

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

成功した場合、dumpstackコマンドはThrowableオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpStack()

例

この例ではスタック・トレースを表示します。

wls:/myserver/serverConfig> dumpStack()
com.bea.plateng.domain.script.jython.WLSTException: java.lang.reflect.Invocation TargetException
...

dumpVariables

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpVariables()

例

この例では、現在のすべての変数とその値を表示します。

wls:/mydomain/serverConfig> dumpVariables()
adminHome   weblogic.rmi.internal.BasicRemoteRef - hostID:
'-1 108080150904263937S:localhost:[7001,8001,-1,-1,-1,-1,-1]:
mydomain:AdminServer', oid: '259', channel: 'null'
cmgr   [MBeanServerInvocationHandler]com.bea:Name=ConfigurationManager,
Type=weblogic.management.mbeanservers.edit.ConfigurationManagerMBean
cmo   [MBeanServerInvocationHandler]com.bea:Name=mydomain,Type=Domain
connected true
domainName mydomain
...
wls:/mydomain/serverConfig>

find

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

現在の階層内でMBeanと属性を検索します。

WLSTは、属性または属性タイプとその値を格納するMBeanのパス名を返します。searchInstancesOnlyをfalseに設定した場合は、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypeパスの検索も行います。エラーが発生した場合は、WLSTExceptionが返されます。

構文

find([name], [type], [searchInstancesOnly])

引数

定義

name

オプション。検索する属性の名前。

type

オプション。検索する属性のタイプ。

searchInstancesOnly

オプション。登録されたインスタンスのみを検索するか、または、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypesパスも検索するかどうかを指定するブール値。この引数のデフォルトはtrueで、登録されたインスタンスのみが検索されます。

例

以下の例では、現在の構成階層でjavaCompilerという属性を検索します。

wls:/mydomain/serverConfig> find(name = 'JavaCompiler')
Finding 'JavaCompiler' in all registered MBean instances ...
/Servers/AdminServer                         JavaCompilerPreClassPath      null
/Servers/AdminServer                       JavaCompiler                  java
/Servers/AdminServer                      JavaCompilerPostClassPath   null
wls:/mydomain/serverConfig>

以下の例では、現在の構成階層でJMSRuntimeタイプの属性を検索します。

wls:/mydomain/serverRuntime> find(type='JMSRuntime')
Finding MBean of type 'JMSRuntime' in all the instances ...
/JMSRuntime/AdminServer.jms
wls:/mydomain/serverRuntime>

以下の例では、現在の構成階層でexecuteという属性を検索します。searchInstancesOnly引数はfalseに設定されており、サーバーでインスタンス化されていないMBeanTypeも検索することを示しています。

wls:/mydomain/serverConfig> find(name='execute', searchInstancesOnly='false')
Finding 'execute' in all registered MBean instances ...
/Servers/AdminServer      ExecuteQueues [Ljavax.management.ObjectName;@1aa7dbc
/Servers/AdminSever       Use81StyleExecuteQueues                            false
Now finding 'execute' in all MBean Types that can be instantiated ...
/Servers                                      ExecuteQueues
/Servers                                      Use81StyleExecuteQueues
wls:/mydomain/serverConfig>

getConfigManager

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

変更プロセスを管理している最新のConfigurationManager MBeanを返します。そのメソッドを呼び出して、WebLogicドメイン内の構成の変更を管理できます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getConfigManager()

例

以下の例では、最新のConfigurationManagerBean MBeanを返して、cm変数に格納します。

wls:/mydomain/serverConfig> cm=getConfigManager()
wls:/mydomain/serverConfig> cm.getType()
'weblogic.management.mbeanservers.edit.ConfigurationManagerMBean'

getMBean

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

指定されたパスを参照してMBeanを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

MBeanが見つからない場合に例外はスローされません。

構文

getMBean(mbeanPath)

引数

定義

mbeanPath

現在の階層内のMBeanのパス名。

例

以下の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> com=getMBean('Servers/myserver/COM/myserver')
wls:/mydomain/edit !> com.getType()
'Server'

getMBI

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getMBI([mbeanType])

引数

定義

mbeanType

オプション。MBeanInfoを表示するMBeanType。

例

以下の例では、指定されたMBeanTypeのMBeanInfoを取得して、svrMbi変数に格納します。

wls:/mydomain/serverConfig> svrMbi=getMBI('weblogic.management.configuration.ServerMBean')

getPath

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

現在のツリーで、指定されたMBeanインスタンスのMBeanパスまたはMBeanのObjectNameを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getPath(mbean)

引数

定義

mbean

MBeanパスを返す、現在のツリー内のMBeanのMBeanインスタンスまたはObjectName。

例

以下の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> path=getPath('com.bea:Name=myserver,Type=Server')
wls:/mydomain/edit !> print path
'Servers/myserver'

listChildTypes

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

cmoで作成または削除できるすべての子MBeanを表示します。cmo変数は、WLSTを使用して最後に移動した構成Beanインスタンスを表します。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

listChildTypes([parent])

引数

定義

parent

オプション。子タイプを表示する親タイプ。

例

以下の例では、cmoタイプで作成または削除できる子MBeanを表示します。

wls:/mydomain/serverConfig> listChildTypes()
AppDeployments
BridgeDestinations
CachingRealms
Clusters
...
wls:/mydomain/serverConfig>

lookup

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

指定されたMBeanをルック・アップします。MBeanは現在のMBeanの子でなければなりません。エラーが発生した場合は、WLSTExceptionが返されます。

構文

lookup(name, [childMBeanType])

引数

定義

name

ルック・アップするMBeanの名前。

childMBeanType

オプション。ルック・アップするMBeanのタイプ。

例

以下の例では、指定されたサーバーmyserverをルック・アップして、返されたスタブをsbean変数に格納します。

wls:/mydomain/serverConfig> sbean=lookup('myserver','Server')
wls:/mydomain/serverConfig> sbean.getType()
'Server'
wls:/mydomain/serverConfig>

ls

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

指定した管理オブジェクトの属性、操作、および子の管理オブジェクトをリストします。

エラーが発生した場合は、WLSTExceptionが返されます。

デフォルトでは、出力は文字列として返され、3つの列に配列されます。

- 1列目には、リストされた項目を説明する一連のコードが表示されます。表3-9を参照してください。

- 2列目には、項目の名前が表示されます。

- 項目が属性である場合、3列目には、その属性値が表示されます。属性が暗号化されている場合、3列目には、値の代わりにアスタリスクが表示されます。(『Oracle WebLogic Scripting Tool』の暗号化された構成値の読み書きに関する項を参照してください。)

- 項目が操作である場合、3列目には、次の形式でその操作の戻り値の型と入力パラメータが表示されます。returnType: parameterType(parameterName)

表3-9 lsコマンド出力情報

コード

説明

d

項目が子の管理オブジェクトであることを示します。

UNIXまたはWindowsのファイル・システムにおけるディレクトリと同様に、cdコマンドを使用して子オブジェクトを現在の管理オブジェクトにすることができます。

r

項目が子の管理オブジェクト、または読取り可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに読取りパーミッションが付与されていることが前提)。(Oracle Fusion Middleware Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルトのセキュリティ・ポリシーに関する項を参照してください。)

w

項目が書込み可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに書込みパーミッションが付与されていることが前提)。(Oracle Fusion Middleware Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルトのセキュリティ・ポリシーに関する項を参照してください。)

x

項目が実行可能な操作であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに実行パーミッションが付与されていることが前提)。(Oracle Fusion Middleware Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルトのセキュリティ・ポリシーに関する項を参照してください。)

デフォルトの出力では、現在の管理オブジェクトのすべての属性、操作、および子の管理オブジェクトがリストされます。出力をフィルタリングする、または異なる管理オブジェクトのリストを表示するには、コマンドの引数を指定します。

注意:

パフォーマンスを最適化するため、WLSTオフラインを使用する場合、WebLogic Serverのデフォルト値のほとんどは、WebLogicドメインの構成ファイルには格納されません。この最適化が原因で、WLSTオフラインでは管理オブジェクト全体を表示できない場合があります(WebLogic Serverでは対応するXML要素をドメインの構成ファイルに書き込んでいないため)。たとえば、ドメインがアクティブであるときにWebLogicドメインのロギングのデフォルト重大度を変更しなかった場合、WLSTオフラインではドメインのLog管理オブジェクトは表示されません。
WLSTオフラインで表示されない管理オブジェクトの属性のデフォルト値を変更する場合、最初にcreateコマンドを使用して管理オブジェクトを作成する必要があります。次に、cdを使用して管理オブジェクトに移動し、属性値を変更します。「create」を参照してください。

構文

ls( [ a | c | o ] [ moPath ])

ls( [ moPath ] returnMap [ returnType ] )

引数

定義

a

オプション。指定した管理オブジェクトの属性のみ表示します(他の項目の表示は抑制されます)。

c

オプション。指定した管理オブジェクトの子の管理オブジェクトのみ表示します(他の項目の表示は抑制されます)。

o

オプション。指定した管理オブジェクトで呼出し可能な操作のみ表示します(他の項目の表示は抑制されます)。
この引数は、WLSTオンラインにのみ適用できます。

moPath

オプション。リストする属性、操作、および子の管理オブジェクトの管理オブジェクトへのパス名。
階層の現在の場所に対して相対的なパス名を指定することも、絶対パス名を指定することも可能です。

WLSTオフラインでは、フォワード・スラッシュ(/)を使用して構成ドキュメントのルートを指定します。

WLSTオンラインでは、任意の管理階層のMBeanの内容をリストできます(「ツリー・コマンド」を参照)。次の構文を使用して、階層のルートを指定してください。

root-name:/

たとえば、サーバーの実行時階層のルートを示す例を次に示します。

ls('serverRuntime:/')

この引数を指定しない場合、現在の管理オブジェクトの項目がリストされます。

returnMap

オプション。コマンドで値をマップとして返すかどうかを指定するブール値。この引数のデフォルトはfalseです(コマンドでは文字列が返されます)です。

returnType

オプション。マップで返される出力を制御します。この表の冒頭で説明した、出力をフィルタリングするa、c、またはoを指定します。
この引数は、returnMapがtrueに設定されている場合にのみ有効です。この引数のデフォルトはcです。

例

以下の例では、examplesドメインの、すべての子構成Beanと属性名および値を表示します。このドメインはWLSTオフライン・モードでメモリーにロードされています。

wls:/offline/mydomain > ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   CustomResources
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
dr--   ErrorHandlings
dr--   FileStores
dr--   InternalAppDeployments
dr--   InternalLibraries
dr--   JDBCDataSourceFactories
dr--   JDBCStores
dr--   JDBCSystemResources
dr--   JMSBridgeDestinations
dr--   JMSInteropModules
dr--   JMSServers
dr--   JMSSystemResources
dr--   JMX
...
wls:/offline/examples>

以下の例では、DomainMBeanドメインのすべての属性名と値を表示します。

wls:/mydomain/serverConfig> ls('a')
-r--   AdminServerName                              AdminServer
-r--   AdministrationMBeanAuditingEnabled           false
-r--   AdministrationPort                           9002
-r--   AdministrationPortEnabled                    false
-r--   AdministrationProtocol                       t3s
-r--   ArchiveConfigurationCount                    0
-r--   ClusterConstraintsEnabled                    false
-r--   ConfigBackupEnabled                          false
-r--   ConfigurationAuditType                       none
-r--   ConfigurationVersion                         9.0.0.0
-r--   ConsoleContextPath                           console
-r--   ConsoleEnabled                               true
-r--   ConsoleExtensionDirectory                    console-ext
-r--   DomainVersion                                9.0.0.0
-r--   LastModificationTime                         0
-r--   Name                                         basicWLSDomain
-r--   Notes                                        null
-r--   Parent                                       null
-r--   ProductionModeEnabled                        false
-r--   RootDirectory                                .
-r--   Type                                         Domain
wls:/mydomain/serverConfig>

以下の例では、Servers MBeanのすべての子Beanと属性名および値を表示します。

wls:/mydomain/serverConfig> ls('Servers')
dr--   AdminServer

以下の例では、指定されたMBeanパスの属性名と値を表示し、その情報をマップで返します。

wls:/mydomain/serverConfig> svrAttrList = ls('edit:/Servers/myserver', 'true', 'a')
-rw-   AcceptBacklog                                50
-rw-   AdminReconnectIntervalSeconds                10
-rw-   AdministrationPort                           9002
-rw-   AdministrationProtocol                       t3s
-rw-   AutoKillIfFailed                             false
-rw-   AutoMigrationEnabled                         false
-rw-   AutoRestart                                  true
-rw-   COMEnabled                                   false
-rw-   ClasspathServletDisabled                     false
-rw-   ClientCertProxyEnabled                       false
-rw-   Cluster                                      null
-rw-   ClusterRuntime                               null
-rw-   ClusterWeight                                100
wls:/mydomain/serverConfig>

man

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

man([attrName])

引数

定義

attrName

オプション。ヘルプを表示するMBean属性名。指定しない場合は、現在のMBeanのヘルプが表示されます。

例

以下の例では、ServerMBean Beanに関するMBeanInfoのヘルプを表示します。

wls:/mydomain/serverConfig> man('Servers')
dynamic : true
creator : createServer
destroyer : destroyServer
description : <p>Returns the ServerMBeans representing the servers that have been
configured to be part of this domain.</p>
descriptorType : Attribute
Name : Servers
interfaceClassName : [Lweblogic.management.configuration.ServerMBean;
displayName : Servers
relationship : containment

redirect

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

WLSTの情報、エラー、およびデバッグに関する各メッセージを指定したファイル名にリダイレクトします。また、dumpStack()およびdumpVariables()コマンドの出力を、指定したファイル名にリダイレクトします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

redirect(outputFile, [toStdOut])

引数

定義

outputFile

WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを起動したディレクトリを基準とする相対パスでもかまいません。

toStdOut

オプション。出力をstdoutに送信するかどうかを指定するブール値。この引数のデフォルトはtrueで、出力がstdoutに送信されることを表します。

例

以下の例では、logs/wlst.logファイルへ、WLST出力のリダイレクトを開始します。

wls:/mydomain/serverConfig> redirect('./logs/wlst.log')

removeListener

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

以前に定義したリスナーを削除します。引数を指定しない場合は、すべてのMBeanで定義されたすべてのリスナーが削除されます。リスナーの設定の詳細については、「addListener」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

removeListener([mbean], [listenerName])

引数

定義

mbean

オプション。以前に定義されたリスナーを削除するMBeanまたはMBeanオブジェクトの名前。

listenerName

オプション。削除するリスナーの名前。

例

以下の例では、mylistenerというリスナーを削除します。

wls:/mydomain/serverConfig> removeListener(listenerName="mylistener")

showListeners

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

現在定義されているすべてのリスナーを表示します。リスナーの設定の詳細については、「addListener」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

showListeners()

例

以下の例では、現在定義されているすべてのリスナーを表示します。

wls:/mydomain/serverConfig> showListeners()

startRecording

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTとユーザーのすべての対話を記録します。このコマンドは、再試行するコマンドの捕捉に役立ちます。

エラーが発生した場合は、WLSTExceptionが返されます。

『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

構文

startRecording(recordFile, [recordAll])

引数

定義

recordFile

WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを呼び出したディレクトリを基準とする相対パスでもかまいません。

recordAll

オプション。すべてのユーザー対話をファイルに捕捉するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合はWLSTコマンドのみが捕捉され、WLST以外のコマンド出力は捕捉されませんです。

例

以下の例では、record.pyファイルにWLSTコマンドの記録を開始します。

wls:/mydomain/serverConfig> startRecording('c:/myScripts/record.py')
Starting recording to c:/myScripts/record.py
wls:/mydomain/serverConfig>

state

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。ノード・マネージャが動作している必要があります。

サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』の「サーバーのライフサイクルについて」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

state(name, [type])

引数

定義

name

現在の状態を取得するサーバーまたはクラスタの名前。

type

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタの状態を返す場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

例

以下の例では、管理対象サーバーmanaged1の状態を返します。

wls:/mydomain/serverConfig> state('managed1','Server')
Current state of "managed1": SUSPENDED
wls:/mydomain/serverConfig>

以下の例では、クラスタmyclusterの状態を返します。

wls:/mydomain/serverConfig> state('mycluster','Cluster')
There are 3 server(s) in cluster: mycluster

States of the servers are
MServer1---SHUTDOWN
MServer2---SHUTDOWN
MServer3---SHUTDOWN
wls:/mydomain/serverConfig>

stopRecording

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTコマンドの記録を停止します。記録の開始の詳細については、「startRecording」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopRecording()

例

以下の例では、WLSTコマンドの記録を停止します。

wls:/mydomain/serverConfig> stopRecording()
Stopping recording to c:\myScripts\record.py
wls:/mydomain/serverConfig>

stopRedirect

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLST出力のファイルへのリダイレクトが行われている場合は、リダイレクトを停止します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopRedirect()

例

以下の例では、WLST出力のファイルへのリダイレクトを停止します。

wls:/mydomain/serverConfig> stopRedirect()
WLST output will not be redirected to myfile.txt any more

storeUserConfig

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。ユーザー構成ファイルには、暗号化されたユーザー名とパスワードが格納されます。キー・ファイルには、ユーザー名とパスワードの暗号化と復号化に使用される秘密鍵が格納されます。

最初にユーザー名とパスワードを暗号化したキー・ファイルのみが、その値の復号化に使用されます。キー・ファイルを失った場合には、新しいユーザー構成ファイルとキー・ファイルのペアを作成しなければなりません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

storeUserConfig([userConfigFile], [userKeyFile], [nm])

引数

定義

userConfigFile

オプション。ユーザー構成を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。
この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのSDKおよびタイプによって異なります。デフォルトのファイル名は次の形式に基づいています。

username-WebLogicConfig.properties

usernameは、オペレーティング・システムのログインに使用したユーザー名を表します。

また、ファイルを作成した場所が標準出力に出力されます。

userKeyFile

オプション。指定するユーザー構成ファイルに関連付けられているキー情報を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。
この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのタイプおよびSDKによって異なります。デフォルトのファイル名は次の形式に基づいています。

username-WebLogicKey.properties

usernameは、オペレーティング・システムのログインに使用したユーザー名を表します。

また、ファイルを作成した場所が標準出力に出力されます。

nm

オプション。ノード・マネージャまたはWebLogic Serverのどちらのユーザー名とパスワードを格納するかを指定するブール値。trueに設定した場合は、ノード・マネージャのユーザー名とパスワードが格納されます。この引数のデフォルトはfalseです。

例

以下の例では、デフォルトの場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig()
Creating the key file can reduce the security of your system if it is not kept in
a secured location after it is created. Do you want to create the key file? y or n
y
The username and password that were used for this current WLS connection are
stored in C:\Documents and Settings\pat\pat-WebLogicConfig.properties
and C:\Documents and Settings\pat\pat-WebLogicKey.properties.

以下の例では、指定された場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig('c:/myFiles/myuserconfigfile.secure', 'c:/myFiles/myuserkeyfile.secure')
Creating the key file can reduce the security of your system if it is not kept in
a secured location after it is created. Do you want to create the key file? y or n
y
The username and password that were used for this current WLS connection are
stored in c:/myFiles/mysuserconfigfile.secure and c:/myFiles/myuserkeyfile.secure
wls:/mydomain/serverConfig>

threadDump

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

指定されたサーバーのスレッド・ダンプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

threadDump([writeToFile], [fileName], [serverName])

引数

定義

writeToFile

オプション。出力をファイルに保存するかどうかを指定するブール値。この引数のデフォルトはtrueで、出力はファイルに保存されます。

fileName

オプション。出力が書き込まれるファイルの名前。ファイル名は絶対パスでも、WLSTを実行しているディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトはThread_Dump_serverNameファイルです。serverNameはサーバーの名前を表します。この引数は、writeToFileがtrueに設定されている場合にのみ有効です。

serverName

オプション。スレッド・ダンプをリクエストするサーバーの名前。この引数のデフォルトは、WLSTが接続しているサーバーになります。
管理サーバーに接続している場合は、管理サーバーと、WebLogicドメインで動作している任意の管理対象サーバーのスレッド・ダンプを表示できます。管理対象サーバーに接続している場合は、その管理対象サーバーのスレッド・ダンプのみを表示できます。

例

以下の例では、現在のサーバーのスレッド・ダンプを表示して、出力をThread_Dump_serverNameファイルに保存します。

wls:/mydomain/serverConfig> threadDump()

以下の例では、サーバーmanagedServerのスレッド・ダンプを表示します。情報はファイルに保存されません。

wls:/mydomain/serverConfig> threadDump(writeToFile='false', serverName='managedServer')

viewMBean

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

属性名と属性値、操作など、MBeanに関する情報を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

viewMBean(mbean)

引数

定義

mbean

情報を表示するMBean。

例

以下の例では、現在のMBean cmoに関する情報を表示します。

wls:/mydomain/serverConfig> cmo.getType()
'Domain'
wls:/mydomain/serverConfig> viewMBean(cmo)
Attribute Names and Values
--------------------------
XMLEntityCaches   null
Targets   javax.management.ObjectName[com.bea
:Name=MedRecJMSServer,Type=JMSServer,
com.bea:Name=WSStoreForwardInternalJMSServerMedRecServer,Type=JMSServer,
com.bea:Name=MedRecWseeJMSServer,Type=JMSServer,
com.bea:Name=PhysWSEEJMSServer,Type=JMSServer,
com.bea:Name=MedRecSAFAgent,Type=SAFAgent,
com.bea:Name=AdminServer,Type=Server]
RootDirectory                                .
EmbeddedLDAP                          com.bea:Name=OOTB_medrec,Type=EmbeddedLDAP
RemoteSAFContexts  null
Libraries   javax.management.ObjectName[com.bea
...
wls:/mydomain/serverConfig>

writeIniFile

コマンド・カテゴリ: 情報コマンド

WLSTの使用状況:オンライン

説明

上級ユーザーがJythonモジュールとしてインポートできるように、WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。インポートすると、その定義とメソッド宣言は他のJythonモジュールから使用できるようになり、Jython構文を使用して直接アクセスできます。詳細は、『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

writeIniFile(filePath)

引数

定義

filePath

変換された情報を保存するファイルのフル・パス名。

例

以下の例では、WLSTをwl.pyというPythonファイルに変換します。

wls:/offline> writeIniFile("wl.py")
The Ini file is successfully written to wl.py
wls:/offline>

ライフサイクル・コマンド

表3-10に示すWLSTライフサイクル・コマンドを使用して、サーバー・インスタンスのライフサイクルを管理します。

サーバー・インスタンスのライフサイクルの詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』の「サーバーのライフサイクルについて」を参照してください。

表3-10 WLST構成のライフサイクル・コマンド

コマンド

説明

WLSTの使用状況

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

オンライン

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

オンライン

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

オンライン

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

オンライン

startServer

管理サーバーを起動します。

オンラインまたはオフライン

suspend

実行中のサーバーを一時停止します。

オンライン

migrate

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンライン

説明

指定されたサービス(JTA、JMS、またはサーバー)を、クラスタ内のターゲット・サーバーに移行します。エラーが発生した場合は、WLSTExceptionが返されます。

サービスの移行の詳細は、『Oracle WebLogic Serverクラスタの使い方』の「サービスの移行」を参照してください。

構文

migrate(sname, destinationName, [sourceDown], [destinationDown], [migrationType])

引数

定義

sname

サービスの移行元のサーバーの名前。

destinationName

サービスの移行先のマシンまたはサーバーの名前。

sourceDown

オプション。元のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはtrueで、元のサーバーが実行されていないことを示します。
JTAサービスを移行する場合、sourceDown引数が無視され、指定された場合、デフォルトはtrueです。JTAサービスを正常に移行するには、元のサーバーを停止する必要がある。

destinationDown

オプション。移行先のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはfalseで、移行先のサーバーが実行されていることを示します。
移行先が実行されておらず、この引数をtrueに設定しない場合、WLSTはMigrationExceptionを返します。

JMS関連サービスを実行されていないサーバー・インスタンスに移行する場合、サーバー・インスタンスは次の起動時にJMSサービスをアクティブ化します。JTAトランザクション回復サービスを実行されていないサーバー・インスタンスに移行する場合、ターゲット・サーバー・インスタンスは起動時に回復サービスを前提とします。

migrationType

オプション。移行するサービスのタイプ。有効な値は以下のとおり。

- jms-JMS関連サービス(JMSサーバー、SAFエージェント、パス・サービス、WebLogic永続ストアなど)のみを移行します。

- jta-JTAサービスのみを移行します。

- server-サーバー・サービスのみを移行します。

- all-すべてのJTAおよびJMSサービスを移行します。

この引数のデフォルトはallです。

例

以下の例では、server1にあるすべてのJMSおよびJTAサービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'all')
Migrating all JMS and JTA services from 'server1' to destination 'server2' ...
wls:/mydomain/edit !>

以下の例では、server1にあるすべてのサーバー・サービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'Server')
Migrating singleton server services from 'server1' to machine 'server2'...
wls:/mydomain/edit !>

resume

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンライン

説明

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。このコマンドはサーバーをRUNNING状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』の「サーバーのライフサイクルについて」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

resume([sname], [block])

引数

定義

sname

再開するサーバーの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

block

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

例

以下の例では、管理対象サーバー・インスタンスを再開します。

wls:/mydomain/serverConfig> resume('managed1', block='true')
Server 'managed1' resumed successfully.
wls:/mydomain/serverConfig>

shutdown

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンライン

説明

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。shutdownコマンドは、進行中のすべての作業が完了するのを待機してから、サーバーまたはクラスタを停止します。

引数を指定しないでshutdownコマンドを入力すると、WLSTが接続しているサーバーが停止されます。

管理対象サーバー・インスタンスに接続している場合は、WLSTが接続している管理対象サーバー・インスタンスを停止するためにのみshutdownコマンドを使用できます。管理対象サーバー・インスタンスに接続しているときに、別のサーバーを停止することはできません。

WLSTはノード・マネージャを使用して管理対象サーバーを停止します。管理対象サーバーを停止するときは、ノード・マネージャが動作している必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

shutdown([name], [entityType], [ignoreSessions], [timeOut], [force], [block])

引数

定義

name

オプション。定義するサーバーまたはクラスタの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

entityType

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタを停止する場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

ignoreSessions

オプション。停止時に、WLSTがすべてのHTTPセッションを直ちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのHTTPセッションが完了(またはタイムアウト)する必要があります。

timeOut

オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。

force

オプション。WLSTが、アクティブなセッションの完了を待たずに、サーバー・インスタンスまたはクラスタを停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してから停止します。

block

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

例

以下の例では、接続しているサーバーを停止するようにWLSTに指示します。

wls:/mydomain/serverConfig> shutdown()
Shutting down the admin server that you are currently connected to .......
Disconnected from weblogic server: AdminServer

以下の例では、HTTPセッションが完了または(1000ミリ秒で)タイムアウトするのを1000秒待機してからmyserverを停止するように、WLSTに指示します。

wls:/mydomain/serverConfig> shutdown('myserver','Server','false',1000, block='false')

以下の例では、管理対象サーバー・インスタンスに接続しているときに、すべてのHTTPセッションを直ちに中止するように、WLSTに指示します。

wls:/mydomain/serverConfig> shutdown('MServer1','Server','true',1200)
Shutting down a managed server that you are connected to ...
Disconnected from weblogic server: MServer1

以下の例では、クラスタmyclusterを停止するようにWLSTに指示します。

wls:/mydomain/serverConfig> shutdown('mycluster','Cluster')
Shutting down the cluster with name mycluster
Shutdown of cluster mycluster has been issued, please
refer to the logs to check if the cluster shutdown is successful.
Use the state(<server-name>) or state(<cluster-name>,"Cluster")
to check the status of the server or cluster
wls:/mydomain/serverConfig> state('mycluster','Cluster')
There are 3 server(s) in cluster: mycluster

States of the servers are
MServer1---SHUTDOWN
MServer2---SHUTDOWN
MServer3---SHUTDOWN
wls:/mydomain/serverConfig>

start

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンライン

説明

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。WLSTが管理サーバーに接続していて、ノード・マネージャが動作している必要があります。

ノード・マネージャに接続して使用するためのWLSTコマンドの詳細については、「ノード・マネージャ・コマンド」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

start(name, [type], [url], [block])

引数

定義

name

起動する管理対象サーバーまたはクラスタの名前。

type

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタを起動する場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

url

オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。[protocol://]listen-address:listen-portという形式で指定します。指定しない場合、この引数はデフォルトでt3://localhost:7001になります。

block

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

例

以下の例では、ノード・マネージャに管理対象サーバー・インスタンスを起動するように指示します。リスン・アドレスはlocalhost、リスン・ポートは8801です。blockがfalseに設定されているので、WLSTはこのコマンドを発行した後で制御をユーザーに返します。

wls:/mydomain/serverConfig> start('myserver', 'Server', block='false')
Starting server myserver ...
Server with name myserver started successfully.
wls:/mydomain/serverConfig>

以下の例では、ノード・マネージャにクラスタを起動するように指示します。blockはtrueに設定されているので、WLSTはクラスタが起動されるまでユーザーの対話をブロックします。

wls:/mydomain/serverConfig> start('mycluster', 'Cluster')
Starting the following servers in Cluster, mycluster: MS1, MS2, MS3...
......................................................................
All servers in the cluster mycluster are started successfully.
wls:/mydomain/serverConfig>

startServer

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

管理サーバーを起動します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

WL_HOME/common/binディレクトリからWLSTを実行し、startServerのみを使用してWebLogic管理サーバーを起動できます。startServerを使用して統合型のWebLogic管理サーバー(ORACLE_HOMEディレクトリにインストールされるFusion Middleware Suite製品の管理サーバー)を起動できません。
WebLogic Server以外のFusion Middleware Suite製品の管理サーバーを起動するには、次のいずれかの方法を使用します。

- 関連するWebLogicドメインのサーバー起動スクリプトを実行します。

- ノード・マネージャを使用して、サーバーを起動します。この方法を使用する場合、startScriptEnabledプロパティがノード・マネージャでtrueに設定されていることを確認します。

構文

startServer([adminServerName], [domainName], [url], [username], [password],
[domainDir], [block], [timeout], [serverLog], [systemProperties], [jvmArgs] [spaceAsJvmArgsDelimiter])

引数

定義

adminServerName

オプション。起動する管理サーバーの名前。この引数のデフォルトはmyserverです。

domainName

オプション。管理サーバーが属しているWebLogicドメインの名前。この引数のデフォルトはmydomainです。

url

オプション。管理サーバーのURL。startServerコマンドに指定したURLによって、config.xmlファイルに指定されたリスン・アドレスとリスン・ポートがオーバーライドされます。この引数がコマンド・ラインまたはconfig.xmlファイルに指定されていない場合は、デフォルトのt3://localhost:7001が使用されます。

username

オプション。WLSTをサーバーに接続するときのユーザー名。この引数のデフォルトはweblogicです。

password

オプション。WLSTをサーバーに接続するときのパスワード。この引数のデフォルトはwelcome1です。

domainDir

オプション。管理サーバーが起動されるドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。

block

オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。blockがfalseに設定されると、WLSTはコマンドを発行した後でユーザーに制御を返します。この引数のデフォルトはtrueで、ユーザー対話がブロックされることを示します。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

timeout

オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(ミリ秒単位)。デフォルト値は60000ミリ秒です。この引数は、blockがtrueに設定されている場合にのみ適用可能です。

serverLog

オプション。サーバー・ログ・ファイルの場所。この引数のデフォルトはstdoutです。

systemProperties

オプション。サーバー・プロセスに渡すシステム・プロパティ。システム・プロパティは、名前と値のペアをカンマで区切って指定します。名前と値は等号(=)で区切ります。

jvmArgs

オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。

spaceAsJvmArgsDelimiter

オプション。JVM引数がスペース区切りであるかどうかを示すブール値。デフォルト値はFALSEです。

例

以下の例では、demoDomainのdemoServerという管理サーバーを起動します。

wls:/offline> startServer('demoServer','demoDomain','t3://localhost:8001',
'myweblogic','wlstdomain','c:/mydomains/wlst','false', 60000,
jvmArgs='-XX:MaxPermSize=75m, -Xmx512m, -XX:+UseParallelGC')
wls:/offline>

suspend

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTの使用状況:オンライン

説明

実行中のサーバーを一時停止します。このコマンドでは、サーバーをRUNNING状態からADMIN状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』の「サーバーのライフサイクルについて」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

suspend([sname], [ignoreSessions], [timeOut], [force], [block])

引数

定義

sname

オプション。一時停止するサーバーの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

ignoreSessions

オプション。一時停止するときに、WLSTがすべてのHTTPセッションを直ちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、HTTPセッションが完了(またはタイムアウト)する必要があります。

timeOut

オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。

force

オプション。アクティブなセッションの完了を待たずにサーバーを一時停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してからサーバーを一時停止します。

block

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

例

以下の例では、管理対象サーバー・インスタンスを一時停止します。

wls:/mydomain/serverConfig> suspend('managed1')
Server 'managed1' suspended successfully.
wls:/mydomain/serverConfig>

ノード・マネージャ・コマンド

表3-11に示すWLSTノード・マネージャ・コマンドを使用して、WebLogic Serverインスタンスを起動、停止、再起動、およびモニターします。

注意:

このカテゴリのコマンドを実行する前に、ノード・マネージャを実行する必要があります。

ノード・マネージャの詳細は、Oracle WebLogic Serverのノード・マネージャ管理者ガイドのノード・マネージャの使用に関する項を参照してください。

表3-11 WLST構成のノード・マネージャ・コマンド

コマンド

説明

WLSTの使用状況

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

オンライン

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

オンラインまたはオフライン

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

オンラインまたはオフライン

nmEnroll

現在のコンピュータのノード・マネージャを有効にして、指定されたWebLogicドメインのサーバーを管理します。

オンライン

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

オンライン

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

オンラインまたはオフライン

nmLog

ノード・マネージャ・ログを返します。

オンラインまたはオフライン

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

オンラインまたはオフライン

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

オンラインまたはオフライン

nmStart

ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。

オンラインまたはオフライン

nmVersion

ノード・マネージャのバージョンを返します。

オンラインまたはオフライン

startNodeManager

WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。

オンラインまたはオフライン

stopNodeManager

ノード・マネージャを停止します。

オンラインまたはオフライン

nm

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTがノード・マネージャに接続しているかどうかを判断します。trueまたはfalseを返し、説明のメッセージを出力します。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nm()

例

以下の例では、WLSTは現在、mydomainをモニターするノード・マネージャに接続しています。

wls:/mydomain/serverConfig> nm()
Currently connected to Node Manager that is monitoring the domain "mydomain"
wls:/mydomain/serverConfig>

以下の例では、WLSTは現在ノード・マネージャに接続していません。

wls:/mydomain/serverConfig> nm()
Not connected to any Node Manager
wls:/mydomain/serverConfig>

nmConnect

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTをノード・マネージャに接続してセッションを確立します。ノード・マネージャに接続したら、WLSTからノード・マネージャ・コマンドを呼び出すことができます。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

注意:

現在のWLSTセッションでconnectコマンドを以前に使用している場合、nmconnectは、特に指定しないかぎり、connectコマンドに使用されたユーザー資格証明を使用します。

接続すると、WLSTプロンプトにはwls:/nm/domainName>と表示されます。domainNameは管理するWebLogicドメインの名前を表します。その後でWLSTをWebLogic Serverに接続すると、プロンプトにはWebLogic Serverインスタンスが示されます。nmコマンドを使用すると、WLSTがノード・マネージャに接続しているかどうかを判断できます(「nm」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmConnect([username, password], [host], [port], [domainName], [domainDir] [nmType], [verbose])

nmConnect([userConfigFile, userKeyFile], [host], [port], [domainName], [domainDir] [nmType], [verbose])

引数

定義

username

WLSTをノード・マネージャに接続するオペレータのユーザー名。ユーザー名のデフォルトはweblogicです。
注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド・ラインでユーザー名とパスワードを明示的に指定する必要があります。

password

WLSTをノード・マネージャに接続するオペレータのパスワード。パスワードのデフォルトはwelcome1です。
注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド・ラインでユーザー名とパスワードを明示的に指定する必要があります。

host

オプション。ノード・マネージャのホスト名。この引数のデフォルトはlocalhostです。

port

オプション。ノード・マネージャのポート番号。この引数のデフォルトは、ノード・マネージャ・タイプに基づいた、以下の値になります。

- plainタイプの場合、デフォルトは5556

- rshタイプの場合、デフォルトは514

- sshタイプの場合、デフォルトは22

- sslタイプの場合、デフォルトは5556

domainName

オプション。管理するWebLogicドメインの名前。この引数のデフォルトはmydomainです。

domainDir

オプション。ノード・マネージャ秘密ファイル(nm_password.properties)とSerializedSystemIni.datファイルを保存するドメイン・ディレクトリのパス。この引数のデフォルトはWLSTを起動したディレクトリです。

nmType

ノード・マネージャ・タイプ。有効な値は以下のとおりです。

- plain - プレーンなソケットのJavaベースの実装
注意: nmTypeにplainを指定する場合、WL_HOME/common/nodemanager/nodemanager.propertiesのSecureListenerパラメータをfalseに手動で設定する必要があります。指定しないと、nmConnectコマンドは失敗します。

- rsh - RSH実装

- ssh - スクリプト・ベースのSSH実装

- ssl - JavaベースのSSL実装

この引数のデフォルトはsslです。

verbose

オプション。WLSTがノード・マネージャに冗長モードで接続するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。

userConfigFile

オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。
ユーザー構成ファイルの作成時に、storeUserConfigコマンドはキー・ファイルを使用してユーザー名とパスワードを暗号化します。ユーザー構成ファイルを暗号化するキー・ファイルのみが、そのユーザー名とパスワードを復号化できる(「storeUserConfig」を参照。)

userKeyFile

オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。(「storeUserConfig」を参照。)

例

以下の例では、デフォルトのホストおよびポート番号とplainノード・マネージャ・タイプを使用して、oamdomainをモニターするノード・マネージャにWLSTを接続します。

wls:/myserver/serverConfig> nmConnect('weblogic', 'welcome1', 'localhost',
'5555', 'oamdomain', 'c:/Oracle/Middleware/user_projects/domains/oamdomain','ssl')
Connecting to Node Manager Server ...
Successfully connected to Node Manager.
wls:/nm/oamdomain>

以下の例では、ユーザー資格証明を提供するユーザー構成ファイルとキー・ファイルを使用して、WLSTをノード・マネージャ・サーバー・インスタンスに接続します。

wls:/myserver/serverConfig> nmConnect(userConfigFile='
c:/myfiles/myuserconfigfile.secure',
userKeyFile='c:/myfiles/myuserkeyfile.secure',
host='172.18.137.82', port=26106, domainName='mydomain',
domainDir='c:/myfiles/mydomain', mType='ssl')
Connecting to Node Manager Server ...
Successfully connected to Node Manager.
wls:/nm/mydomain>

nmDisconnect

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

WLSTをノード・マネージャ・セッションから接続解除します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmDisconnect()

例

以下の例では、WLSTをノード・マネージャ・セッションから接続解除します。

wls:/nm/oamdomain> nmDisconnect()
Successfully disconnected from Node Manager
wls:/myserver/serverConfig>

nmEnroll

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンライン

説明

WLSTが現在動作しているマシンを登録します。このコマンドを実行するにはWLSTが管理サーバーに接続している必要がありますが、ノード・マネージャに接続している必要はありません。

このコマンドでは、以下のファイルを管理サーバーからダウンロードします。

- ノード・マネージャ秘密ファイル(nm_password.properties)。サーバー認証に使用される暗号化されたユーザー名とパスワードが含まれます。

- SerializedSystemIni.datファイル

また、このコマンドでは、WL_HOME/common/nodemanagerディレクトリにあるnodemanager.domainsファイルをドメイン情報で更新します。WL_HOMEはWebLogic Serverの最上位のインストール・ディレクトリです。

WebLogicドメインが管理サーバーとルート・ディレクトリを共有している場合を除いて、このコマンドは1つのWebLogicドメイン、1つのマシンごとに実行する必要があります。

このコマンドを実行するときにそのマシンが既に登録されている場合は、ノード・マネージャ秘密ファイル(nm_password.properties)が管理サーバーの最新の情報で更新されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmEnroll([domainDir], [nmHome])

引数

定義

domainDir

オプション。ノード・マネージャ秘密ファイル(nm_password.properties)とSerializedSystemIni.datファイルを保存するドメイン・ディレクトリのパス。この引数のデフォルトはWLSTを起動したディレクトリです。

nmHome

オプション。ノード・マネージャ・ホームのパス。ドメイン情報を含むnodemanager.domainsファイルはこのディレクトリに書き込まれます。この引数のデフォルトはWL_HOME/common/nodemanagerです。WL_HOMEはWebLogic Serverの最上位のインストール・ディレクトリです。

例

以下の例では、現在のマシンをノード・マネージャに登録して、ノード・マネージャ秘密ファイル(nm_password properties)とSerializedSystemIni.datファイルをc:/bea/mydomain/common/nodemanager/nm_password.propertiesに保存します。nodemanager.domainsファイルはデフォルトではWL_HOME/common/nodemanagerに書き込まれます。

wls:/mydomain/serverConfig> nmEnroll('c:/Oracle/Middleware/mydomain/common/nodemanager')
Enrolling this machine with the domain directory at c:\Oracle\Middleware\mydomain\common\nodemanager....
Successfully enrolled this machine with the domain directory at C:\Oracle\Middleware\mydomain\common\nodemanager
wls:/mydomain/serverConfig>

nmGenBootStartupProps

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンライン

説明

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。ノード・マネージャ・プロパティ・ファイルは、指定されたサーバーのルート・ディレクトリを基準とする相対的な場所に格納されます。対象となるルート・ディレクトリは、コマンドを実行しているマシンと同じマシン上にある必要があります。

サーバーの名前を指定する必要があります。指定しないと、コマンドは失敗します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmGenBootStartupProps(serverName)

引数

定義

serverName

ノード・マネージャ・プロパティ・ファイルを生成するサーバーの名前。

例

次の例では、指定されたサーバーms1のルート・ディレクトリ内にboot.propertiesおよびstartup.propertiesを生成します。

wls:/mydomain/serverConfig> nmGenBootStartupProps('ms1')
Successfully generated boot.properties at
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\boot.properties
Successfully generated startup.properties at
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\startup.properties
wls:/mydomain/serverConfig>

nmKill

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

serverName引数を使用してサーバー名を指定しない場合、引数はデフォルトでmyServerに設定されます。この引数は使用しているサーバー名と一致している必要があり、一致していない場合はコマンドが失敗します。

起動する際にノード・マネージャを使用しなかったサーバー・インスタンスを強制停止しようとすると、エラーが表示されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmKill([serverName], [serverType])

引数

定義

serverName

オプション。強制停止するサーバーの名前。この引数のデフォルトはmyserverです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

以下の例では、oamserverというサーバーを強制停止します。

wls:/nm/oamdomain> nmKill('oamserver')
Killing server 'oamserver' ...
Server oamServer killed successfully.
wls:/nm/oamdomain>

nmLog

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャ・ログを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmLog([writer])

引数

定義

writer

省略可能。ログ出力を書き込むjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライター・ストリームです。

例

以下の例では、ノード・マネージャ・ログを表示します。

wls:/nm/oamdomain> nmLog()
Successfully retrieved the Node Manager log and written.
wls:/nm/oamdomain>

nmServerLog

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmServerLog([serverName], [writer], [serverType])

引数

定義

serverName

オプション。サーバーの出力ログを表示するサーバーの名前。この引数のデフォルトはmyserverです。

writer

省略可能。ログ出力を書き込むjava.io.Writerオブジェクト。指定しない場合、この引数のデフォルトはWLSTInterpreter標準出力になります。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

以下の例では、oamserverサーバーのサーバー出力ログを表示して、ログ出力をmyWriterに書き込みます。

wls:/nm/oamdomain> nmServerLog('oamserver',myWriter)
Successfully retrieved the server log and written.
wls:/nm/oamdomain>

nmServerStatus

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動されたサーバーのステータスを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmServerStatus([serverName], [serverType])

引数

定義

serverName

オプション。ステータスを表示するサーバーの名前。この引数のデフォルトはmyserverです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

次の例では、ノード・マネージャで起動されたoamserverというサーバーのステータスを表示します。

wls:/nm/oamdomain> nmServerStatus('oamserver')
RUNNING
wls:/nm/oamdomain>

nmStart

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

nmStartを使用してサーバーを起動するには、boot.propertiesが必要です。最初にサーバーを起動する場合、手動で作成してnmStartを使用する必要があります。
または、nmStartprops引数を使用して、ユーザー資格証明を提供できます(ノード・マネージャの接続後)。

prps = makePropertiesObject("username=weblogic, password=welcome1")
nmStart("AdminServer",props=prps)

構文

nmStart([serverName], [domainDir], [props], [writer], [serverType])

引数

定義

serverName

オプション。起動するサーバーの名前。

domainDir

オプション。起動するサーバーのドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。

props

オプション。新しいサーバーに適用するシステム・プロパティ。

writer

省略可能。サーバー出力が書き込まれるjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライターです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

以下の例では、ノード・マネージャを使用して、現在のWebLogicドメインでmanaged1サーバーを起動します。

wls:/nm/mydomain> nmStart("managed1")
Starting server managed1 ...
Server managed1 started successfully
wls:/nm/mydomain>

以下の例では、ノード・マネージャを使用して、指定されたWebLogicドメインで管理サーバーを起動します。この例では、prps変数にシステム・プロパティ設定を格納し、props引数を使用してコマンドに渡されます。

wls:/nm/mydomain> prps = makePropertiesObject("weblogic.ListenPort=8001")
wls:/nm/mydomain> nmStart("AdminServer",props=prps)
Starting server AdminServer...
Server AdminServer started successfully
wls:/nm/mydomain>

nmVersion

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャのバージョンを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmVersion()

例

以下の例では、ノード・マネージャのバージョンを表示します。

wls:/nm/oamdomain> nmVersion()
The Node Manager version that you are currently connected to is 9.0.0.0
wls:/nm/oamdomain>

startNodeManager

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。

注意:

WebLogic Serverのカスタム・インストール・プロセスでは、必要に応じてノード・マネージャをWindowsシステム上のWindowsサービスとしてインストールおよび起動できます。詳細は、Oracle WebLogic Serverのインストレーション・ガイドのWindowsサービスとしてのノード・マネージャのインストールに関する項を参照してください。この場合、ノード・マネージャを手動で起動する必要はありません。
本番環境では、ノード・マネージャの起動にstartNodeManagerコマンドを使用しないことをお薦めします。推奨方法は、サービスまたはデーモンとしてノード・マネージャをインストールするか、startNodeManagerスクリプト(startNodeManager.shまたはstartNodeManger.cmd)を使用します。

startNodeManagerコマンドを呼び出すときに、ノード・マネージャを既に実行している場合は、次のメッセージが表示されます。

A Node Manager has already been started.
Cannot start another Node Manager process via WLST

エラーが発生した場合は、WLSTExceptionが返されます。

構文

startNodeManager([verbose], [nmProperties])

引数

定義

verbose

オプション。WLSTがノード・マネージャを冗長モードで起動するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。

nmProperties

オプション。ノード・マネージャ・プロパティのカンマ区切りのリスト。名前と値のペアで指定します。ノード・マネージャ・プロパティの例としては、NodeManagerHome、ListenAddress、ListenPort、PropertiesFileなどが挙げられます。

例

以下の例では、ノード・マネージャのサーバーのバージョンを表示します。

wls:/mydomain/serverConfig> startNodeManager(verbose='true',
NodeManagerHome='c:/Oracle/Middleware/wlserver_12.1/common/nodemanager', ListenPort='6666', ListenAddress='myhost'))
Launching Node Manager ...
Successfully launched the Node Manager.
The Node Manager process is running independent of the WLST process
Exiting WLST will not stop the Node Manager process. Please refer
to the Node Manager logs for more information.
The Node Manager logs will be under c:\Oracle\Middleware\wlserver_12.1\common\nodemanager.
wls:/mydomain/serverConfig>

stopNodeManager

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTの使用状況:オンラインまたはオフライン

説明

ノード・マネージャ・プロセスを停止します。

注意:

ノード・マネージャ・プロセスを停止するには、startNodeManagerを使用してノード・マネージャを起動するか、ノード・マネージャをプロパティQuitEnabled=trueを使用して起動する必要があります。$WLS_HOME/common/nodemanager.propertiesでこのプロパティを構成できます。これにより、ノード・マネージャに接続して停止できます。

startNodeManagerコマンドを呼び出すときに、ノード・マネージャを実行していない場合は、次のメッセージが表示されます。

Cannot stop the Node Manager unless you are connected to it.

構文

stopNodeManager()

例

以下の例では、base_domainドメインのノード・マネージャ・プロセスを停止します。

wls:/nm/base_domain> stopNodeManager()
Stopped Node Manager Process successfully
wls:/offline>

ツリー・コマンド

表3-12に示すWLSTツリー・コマンドを使用して、MBean階層内を移動します。

表3-12 WLST構成のツリー・コマンド

コマンド

説明

WLSTの使用状況

custom

サーバーに登録されているカスタムMBeanのルートに移動します。

オンライン

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。

オンライン

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

オンライン

edit

編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

オンライン

serverConfig

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

オンライン

custom

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。WLSTはドメインMBeanと同じようにカスタムMBeanへの移動、照会、編集を行いますが、カスタムMBeanではスタブを利用できないためcmo変数は使用できません。

注意:

customツリーに移動する場合、WLSTは互換性MBeanサーバー、実行時MBeanサーバー、あるいはJVMプラットフォームMBeanサーバーにあるすべてのMBeanに問い合わせて、カスタムMBeanを検索します。現在のWebLogicドメインにあるMBeanの数によっては、このプロセスに数分かかり、WLSTがすぐにプロンプトを返さない場合があります。

customコマンドは、WLSTが管理サーバー・インスタンスまたは管理対象サーバー・インスタンスに接続しているときに使用できます。WebLogic IntegrationまたはWebLogic Portalサーバーに接続している場合、WLSTはすべてのWebLogic IntegrationまたはWebLogic PortalサーバーMBeanと対話できます。

カスタムMBeanの詳細は、『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

domainCustom()コマンドを使用して、ドメイン実行時MBeanサーバー上のカスタムMBeanに移動することもできます。詳細は、「domainCustom」を参照してください。

構文

custom()

例

以下の例では、管理サーバー・インスタンス上で、構成MBean階層からカスタムMBean階層に移動します。

wls:/mydomain/serverConfig> custom()
Location changed to custom tree. This is a writeable tree with No root. For more help, use help('custom')
wls:/mydomain/custom>

domainConfig

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す構成MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainConfig()

例

以下の例では、管理サーバー・インスタンス上で、構成MBean階層からWebLogicドメインの構成階層に移動します。

wls:/mydomain/serverConfig> domainConfig()
Location changed to domainConfig tree. This is a read-only tree with DomainMBean as the root.
For more help, use help('domainConfig')
wls:/mydomain/domainConfig> ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   CustomResources
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
dr--   ErrorHandlings
dr--   FileStores
dr--   InternalAppDeployments
dr--   InternalLibraries
dr--   JDBCDataSourceFactories
dr--   JDBCStores
dr--   JDBCSystemResources
dr--   JMSBridgeDestinations
dr--   JMSInteropModules
dr--   JMSServers
dr--   JMSSystemResources
...
wls:/mydomain/domainConfig>

domainCustom

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのドメイン・カスタム・ツリーに移動します。WLSTはドメインMBeanと同じようにドメイン・カスタムMBeanへの移動、照会、編集を行いますが、ドメイン・カスタムMBeanではスタブを利用できないためcmo変数は使用できません。

注意:

domainCustomツリーに移動する場合、WLSTはドメイン実行時MBeanサーバー、各サーバーの実行時MBeanサーバー、およびJVMプラットフォームMBeanサーバーにあるすべてのMBeanに問い合わせて、カスタムMBeanを検索します。現在のWebLogicドメインにあるMBeanの数によっては、このプロセスに数分かかり、WLSTがすぐにプロンプトを返さない場合があります。JMX問合せのオブジェクト名パターンを指定して実行される検索量を制限することをお薦めします。

WLSTが管理サーバー・インスタンスに接続されている場合のみ、domainCustomコマンドを使用できます。

ドメイン実行時MBeanサーバーの詳細は、『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』のWebLogic Server MBeansの理解に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainCustom(ObjectNamePattern)

引数

定義

ObjectNamePattern

sip:*などのJMX問合せパターン。デフォルト値はnullまたは*:*です。

例

以下の例では、管理サーバー・インスタンス上で、構成MBean階層からドメイン・カスタムMBean階層に移動します。

wls:/mydomain/serverConfig> domainCustom()
Location changed to domain custom tree. This is a writeable tree with No root. For more help, use help('domainCustom').

wls:/mydomain/domainCustom

domainRuntime

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す実行時MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainRuntime()

例

以下の例では、管理サーバー・インスタンス上で、構成MBean階層からドメインの実行時階層に移動します。

wls:/mydomain/serverConfig> domainRuntime()
wls:/mydomain/domainRuntime> ls()
dr--   AppRuntimeStateRuntime
dr--   DeployerRuntime
dr--   DomainServices
dr--   LogRuntime
dr--   MessageDrivenControlEJBRuntime
dr--   MigratableServiceCoordinatorRuntime
dr--   MigrationDataRuntimes
dr--   SNMPAgentRuntime
dr--   ServerLifeCycleRuntimes
dr--   ServerRuntimes
dr--   ServerServices

-r--   ActivationTime                               Mon Aug 01 11:41:25 EDT 2005
-r--   Clusters                                     null
-r--   MigrationDataRuntimes                        null
-r--   Name                                         sampleMedRecDomain
-rw-   Parent                                       null
-r--   SNMPAgentRuntime                             null
-r--   Type                                         DomainRuntime
-r-x   restartSystemResource                        Void :
WebLogicMBean(weblogic.management.configuration.SystemResourceMBean)
wls:/mydomain/domainRuntime>

edit

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この書込み可能な階層には、現在のWebLogicドメインを表すすべての構成MBeanが格納されています。

注意:

構成Beanを編集するには、管理サーバーに接続する必要があります。管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお勧めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。
構成Beanの編集の詳細は、『Oracle WebLogic Scripting Tool』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

edit()

例

以下の例では、管理サーバー・インスタンス上で、サーバー構成MBean階層から、ドメイン構成MBean階層の編集可能なコピーに移動する方法を示しています。

wls:/myserver/serverConfig> edit()
Location changed to edit tree. This is a writeable tree with DomainMBean as the root.
For more help, use help('edit')
wls:/myserver/edit !> ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
...
wls:/myserver/edit !>

jndi

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

WLSTが現在接続しているサーバーのJNDIツリーに移動します。この読込み専用のツリーには、現在JNDIにバインドされているすべての要素が保持されています。

エラーが発生した場合は、WLSTExceptionを返します。

構文

jndi()

例

以下の例では、管理サーバー・インスタンス上で、実行時MBean階層からドメインのJNDIツリーに移動します。

wls:/myserver/runtime> jndi()
Location changed to jndi tree. This is a read-only tree with No root. For more help, use help('jndi')
wls:/myserver/jndi> ls()
dr--   ejb
dr--   javax
dr--   jms
dr--   weblogic
...

serverConfig

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

この読込み専用の階層には、WLSTが現在接続しているサーバーを表す構成MBeanが格納されています。MBean属性値には、サーバーの起動時にユーザーが指定したコマンド・ラインのオーバーライドが含まれています。

エラーが発生した場合は、WLSTExceptionが返されます。

詳細は、『Oracle WebLogic Scripting Tool』のMBean階層間の移動に関する項を参照してください。

構文

serverConfig()

例

以下の例では、管理サーバー・インスタンス上で、ドメインの実行時MBean階層から構成階層に移動します。

wls:/mydomain/domainRuntime> serverConfig()
wls:/mydomain/serverConfig>

serverRuntime

コマンド・カテゴリ: ツリー・コマンド

WLSTの使用状況:オンライン

説明

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。この読込み専用の階層には、WLSTが現在接続しているサーバーを表す実行時MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

serverRuntime()

例

以下の例では、管理サーバー・インスタンス上で、構成MBean階層から実行時MBean階層に移動します。

wls:/mydomain/serverConfig> serverRuntime()
Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root.
For more help, use help('serverRuntime')
wls:/mydomain/serverRuntime>

WLST変数リファレンス

表3-13では、WLSTの変数とその一般的な使用方法について説明します。すべての変数はユーザー・セッションの開始時にデフォルト値に初期化されて、ユーザーとWLSTの対話に従って変更されます。

表3-13 WLST変数

変数

説明

例

cmgr

cmgr変数には、ConfigurationManagerMBeanが設定されます。この変数を使用すると、ConfigurationManagerMBean属性の現在の値を取得できます。

wls:/mydomain/edit> cmgr.getCurrentEditor()
'weblogic'

cmo

現在の管理オブジェクト。cmo変数には、WLSTを使用して移動したBeanインスタンスが設定されます。この変数を使用すると、現在のBeanインスタンスのget、set、またはinvokeメソッドを実行できます。

WLSTでは、この変数が現在のWLSTパスに設定されます。たとえば、serverConfig階層に変更すると、cmoはDomainMBeanに設定されます。serverRuntime階層に変更すると、cmoはServerRuntimeMBeanに設定されます。

この変数は、カスタムおよびjndi以外のすべてのWLST階層で利用できます。

wls:/mydomain/edit> cmo.setAdministrationPort(9092)

connected

WLSTが実行中のサーバーに接続しているかどうかを示すブール値。WLSTは、実行中のサーバーに接続する場合、この変数をtrueに設定します。それ以外の場合はfalseに設定します。

wls:/mydomain/serverConfig> print connected
false

domainName

WLSTが接続しているWebLogicドメインの名前。

wls:/mydomain/serverConfig> print domainName
mydomain

domainRuntimeService

DomainRuntimeServiceMBean MBean.この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。

wls:/mydomain/serverConfig> domainService.getServerName()
'myserver'

editService

EditServiceMBean MBean.この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。

wls:/mydomain/edit> dc = editService.getDomainConfiguration()

exitonerror

例外が発生した場合にWLSTがスクリプトの実行を終了するかどうかを指定するブール値。この変数のデフォルトはtrueで、WLSTでエラーが発生するとスクリプトの実行は終了します。この変数は、WLSTを対話モードで実行する場合には適用できません。

wls:/mydomain/serverConfig> print exitonerror
true

home

ローカルMBeanHomeを表します。

wls:/mydomain/serverConfig> print home
weblogic.rmi.internal.BasicRemoteRef - hostID: '-hostID:[7001,7001,-1,-1,-1,-1,-1]:mydomain:AdminServer', oid: '260', channel: 'null'

isAdminServer

WLSTがWebLogic管理サーバー・インスタンスに接続しているかどうかを示すブール値。WLSTは、WebLogic管理サーバーに接続している場合、この変数をtrueに設定します。それ以外の場合はfalseに設定します。

wls:/mydomain/serverConfig> print isAdminServer
true

mbs

階層内の現在の場所に相当するMBeanServerConnectionオブジェクト。

wls:/mydomain/serverConfig> mbs.isRegistered(ObjectName('mydomain:
Name=mydomain,Type=Domain'))

recording

WLSTがコマンドを記録しているかどうかを示すブール値。startRecordingコマンドが入力されると、WLSTはこの変数をtrueに設定します。それ以外の場合は、この変数をfalseに設定します。

wls:/mydomain/serverConfig> print recording
true

runtimeService

RuntimeServiceMBean MBean.

wls:/mydomain/serverConfig> sr=runtimeService.getServerRuntime()

serverName

WLSTが接続しているサーバーの名前。

wls:/mydomain/serverConfig> print serverName
myserver

typeService

TypeServiceMBean MBean.

wls:/mydomain/serverConfig> mi=typeService.getMBeanInfo('weblogic.
management.configuration.ServerMBean')

username

現在WLSTに接続しているユーザーの名前。

wls:/mydomain/serverConfig> print username
weblogic

version

WLSTが接続している実行中のサーバーの現在のバージョン。

wls:/mydomain/serverConfig> print version
WebLogic Server 9.0 Thu Aug 31 12:15:50 PST 2005 778899

Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved.